Expand All Collapse All

/icws/{sessionId}/dialer/establish-persistent-connection

POST

/icws/{sessionId}/dialer/establish-persistent-connection

This method allows agents using a remote number station type to establish a connection to the Outbound Dialing Server before connecting a call to the agent. The connection is persistent, meaning it is not disconnected between outbound calls. This eliminates any delays when Dialer connects future calls to the agent. This method should be called after the agent has logged in to one or more campaigns but before calling ready-for-calls. In order for this call to work, the agent must have a station type of Remote Number with the persistent connection option set to true and be logged in to at least one campaign. Note that if any of these preconditions are not met, this method is incapable of reporting back an error from Dialer.
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.

        Response

        202 - Accepted
        The request has been sent. If the preconditions are met, Dialer attempts to establish the persistent connection. Note that if any of these preconditions are not met, this method is incapable of reporting back an error from Dialer.
        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.