/icws/{sessionId}/dialer/request-phone-number-details

Feature Version
dialer 3

POST

/icws/{sessionId}/dialer/request-phone-number-details

Retrieves a Dialer contact's phone number details for placing additional follow-up calls.
Feature Version
dialer 3

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Representations
        phoneNumberDetailParameters
        Property
        Value
        Comments
        campaignId
        String
        Campaign ID for Dialer Contact.
        interactionId
        String
        Interaction ID for Dialer Contact.

        Response

        200 - OK
        Phone number details are included within entity body.
        phoneNumberDetails
        Property
        Value
        Comments
        ccid
        Int

        Required

        Contact column ID of the PND record.
        name
        String

        Required

        Contact column name of the PND record.
        phonenumbertype
        String

        Required

        Phone number type of the PND record.
        phonenumber
        String

        Required

        Phone number of the PND record.
        attempts
        Int

        Required

        Number of attempts for the PND record.
        blockingresult
        String

        Required

        Blocking result of the PND record.
        400 - Bad Request
        An error occurred while processing this request.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        403 - Forbidden
        Neither the agent nor the station the agent is logged in to has a Dialer Add-on License available.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        Required

        Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

        WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          410 - Gone
          This resource has been deprecated and removed from the API.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.