Expand All Collapse All

/icws/{sessionId}/phone-numbers/query-details

POST

/icws/{sessionId}/phone-numbers/query-details

Gets the details for a phone number.
Feature Version
phone-numbers 2

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
        phoneNumberDetailsQuery
        Expand AllCollapse All
        Property
        Value
        Comments
        phoneNumber
        String

        Required

        Valid phone numbers can be ones without any formatting, not fully specified phone numbers, etc. If the phone number string requires matching, pattern matching engine is invoked in an attempt to try to resolve (recognize) it. Part of the resolving process is to generate a new input number, which is the result of the Input Conversion mapping step. Whether or not a match is found, the input number will be prepared by having white space and formatting characters removed and alphas mapped to digits; the exceptions to this are SIP numbers, which only have white space characters removed.

        Response

        200 - OK
        The query for phone number details was successful.
        phoneNumberDetails
        A request made with the phone number '8004562354' would yeild: RawText: 8004562354 - NormalizedText: +18004562354 - DisplayText: (Tool Free) 1 (800) 456-2354 - EditBase: 1 (800) 456-2354 - Extension: - DefaultClassification: Tool Free - Classifications: Tool Free - Internal: false - QueueType: None - QueueName: - VoicemailCapable: false - DialCapable: true - AutoDialExtension: false - A request made with the phone number '6929' (representing an extension) would yield: RawText: 6929 - NormalizedText: /6929 - DisplayText: 6929 - EditBase: - Extension: 6929 - DefaultClassification: Intercom - Classifications: Intercom - Internal: true - QueueType: User - QueueName: User Queue: [userId] - VoicemailCapable: true - DialCapable: true - AutoDialExtension: true - The phone number information is determined by the Interaction Center server by applying the dial plan information to a given phone number string to determine the normalized phone number for the Interaction Center system to make a call. Also, the IC system can determine if the phone number is local, long-distance, international, etc.
        Expand AllCollapse All
        Property
        Value
        Comments
        autoDialExtension
        Boolean

        Required

        Indicates whether Extension (if exists) will to be included while Interaction Centers dials this number.

        classifications
        List [1,*]: String
        Gets the classifications for this PhoneNumber.
        defaultClassification
        String

        Required

        The default classification for this PhoneNumber. There can be multiple Classifications.

        dialCapable
        Boolean

        Required

        Indicates whether this PhoneNumber can be dialed.

        displayText
        String

        Required

        The text used to display this PhoneNumber in a client application.

        editBase
        String

        The editable format of this PhoneNumber.

        extension
        String

        The Extension of this PhoneNumber.

        internal
        Boolean

        Required

        Indicates whether this PhoneNumber in an internal number.

        normalizedText
        String

        Required

        The system normalized phone number text used for this PhoneNumber.

        queueName
        String

        The name of the queue for this PhoneNumber.

        None
        0
        The Queue type cannot be identified.
        MyInteractions
        1
        A special Queue that represents a interactions on a user's user or station queue.
        User
        2
        Represents a user's interactions.
        Station
        3
        Represents a station's interactions.
        Workgroup
        4
        Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.
        Orbit
        5
        Represents an orbit queue's interactions. An orbit queue is a list of all calls parked to specific locations (numbered orbits). This feature is especially helpful for Public Announcement system operators who can park a call in Orbit, then page the recipient and relay that he or she has a call on a specific Orbit (i.e. "John Doe, you have a call on Orbit 12", thus enabling John Doe to move to any station and pick up the call).
        Line
        6
        Represents a line's interactions. This can be an expensive queue to watch.
        rawText
        String

        Required

        The phone number for which this PhoneNumber was created. This is the phone number used to initiate the query.

        voicemailCapable
        Boolean

        Required

        Indicates whether this PhoneNumber is configured to receive voice mail.

        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
        error
        Provides additional detail for an error.
        Expand AllCollapse All
        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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.