Expand All Collapse All

/icws/{sessionId}/dialer/disposition

POST

/icws/{sessionId}/dialer/disposition

Dispositions the last Dialer call for the agent and sends the result back to Dialer. When a call is dispositioned, the agent's status is set to the follow-up status set on the campaign. To be assigned additional calls, the agent or application must change the status. Also, Dialer does not actually disconnect the call. The application, agent, or caller must disconnect the call. To reschedule the call, the call must include the scheduledTime and/or scheduledAgent parameters.
Feature Version
dialer 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
        dispositionParameters
        Expand AllCollapse All
        Property
        Value
        Comments
        label
        String

        Required

        The label of the disposition choice. For a previewPop with an allowSkip value of true, pass in a label of "Skipped - Agent Skip" to skip the call.
        scheduledTime
        Int
        For scheduled callbacks, the time of the callback defined as the number of seconds that have elapsed since Epoch time. The corresponding wrap-up category for the disposition must be "Scheduled".
        scheduledAgent
        String
        For agent-owned callbacks, the agent who should receive the call. When this value is provided, the scheduledTime must also be provided. The allowAgentCallbacks value in the dataPop/previewPop indicates whether setting an agent-owned callback is allowed for this call. This option is configured on the Miscellaneous page of script configuration.
        UTC
        0
        Contact
        1
        placeAdditionalFollowUpCall
        Boolean
        Determines whether an additional follow up call will be placed for this interaction.
        Feature Version
        dialer 3
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        isAbandon
        Boolean
        Indicates whether the call should be considered an abondoned call or not.
        Feature Version
        dialer 5

        Response

        200 - OK
        The call was successfully dispositioned.
        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.
        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.
        404 - Not Found
        The call could not be found.
        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.
        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.