/icws/{sessionId}/dialer/log-off

POST

/icws/{sessionId}/dialer/log-off

This request is used to log the agent out of Dialer or out of individual Dialer campaigns. Receiving a corresponding logoutGrantedMessage indicates that the logout has been granted.

When a campaign is specified, the agent is logged out of the specified Dialer campaign, but not completely logged out of Dialer. If no campaign is specified, then the agent is completely logged out of Dialer.

When the "Logon Campaign" security right is in use, agents may be logged out of individual campaigns by sending the campaignId parameter. Without the "Logon Campaign" security right, this should be avoided and the log-off message should be sent as a global logout without a campaignId specified.

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
        logOffParameters
        Property
        Value
        Comments
        campaignIds
        List [1,*]: String
        The list of campaign IDs to log the agent out of.

        Response

        200 - OK
        A request was made to Dialer to log the agent out of the specified campaign(s) or completely out of Dialer. Watch for a logoutGrantedMessage to indicate that the logout was granted.
        Associated Message
        This message indicates the specific campaign that the agent has been logged out of. If the campaignID value is blank, it indicates that the agent has been completely logged out of Dialer.
        logoutGrantedMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:logoutGrantedMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        Required

        When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

        When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

        name
        String
        The name of the campaign.
        id
        String

        Required

        The ID of the campaign.
        403 - Forbidden
        The agent is trying to log out of a specific campaign without the Logon Campaign security right. Starting in 2017R4, this status code will no longer be returned.
        Feature Obsolete Version
        dialer 3
        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.