Expand All Collapse All

/icws/{sessionId}/dialer/recycle-campaign

Feature Version
dialer 7

POST

/icws/{sessionId}/dialer/recycle-campaign

Campaign ID to pass to the recycleCampaign call.
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
        recycleCampaignParameters
        Expand AllCollapse All
        Property
        Value
        Comments
        campaignid
        String
        The Campaign ID to be passed in order to recycle the campaign.

        Response

        202 - Accepted
        The recycleCampaign request was received.
        400 - Bad Request
        An error occurred while attempting to process the CampaignID passed to the server.
        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.
        403 - Forbidden
        Neither the agent nor the station the agent is logged in to has a Dialer Add-on License available, or the agent is trying to log in to a specific campaign without the "Logon Campaign" security right.
        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.