/icws/{sessionId}/dialer/ready-for-calls

POST

/icws/{sessionId}/dialer/ready-for-calls

Notifies Dialer that the agent is ready to start receiving calls.

Once an agent has logged in to one or more campaigns, the agent does not immediately start receiving calls. Calling ready-for-calls indicates that the agent is ready to receive calls. Any time an agent is manually or automatically logged in to an additional campaign, ready-for-calls must be called again.

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
        startReceivingParameters
        Property
        Value
        Comments
        campaignIds
        List [1,*]: String
        The list of campaign IDs to start receiving calls from.
        Feature Version
        dialer 4

        Response

        200 - OK
        The request to start receiving calls succeeded.
        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.
        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.
        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.