/icws/{sessionId}/dialer/allocate-agents

Feature Version
dialer 7

POST

/icws/{sessionId}/dialer/allocate-agents

Moves agents in and out of campaigns.
Feature Version
dialer 7

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
        allocateAgentsParameters
        Property
        Value
        Comments
        agentIds
        List [1,*]: String

        Required

        The list of agents.
        campaignIdsOut
        List [Unbounded]: String
        The list of campaign IDs to log the agent out of. This property is required if campaignIdsIn is ommitted.
        campaignIdsIn
        List [Unbounded]: String
        The list of campaign IDs to log the agent in to. This property is required if campaignIdsOut is omitted.

        Response

        202 - Accepted
        The request to move agents in or out of the specified campaigns succeeded.
        400 - Bad Request
        An error occurred while trying to send the allocate agents 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.
        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.
        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.