Authentication

CC Campaign APIs leverage the credentials from the Integration >> API Token area in Configuration Manager.
These APIs use Basic Authentication.
The username will be the "Username" value from this screen, it is generally the tenant name

Authorization :Basic encodedValue

Where encodedValue is base64encode(username:password)

📘

If there are no token values

If the token values are empty you can generate the token by clicking on 'New Token'. Once a token is generated, if you would like to generate a new one, please be aware that once a new token is generated, the old one will not work anymore for anybody.

Get Status for all agents

Parameters

Method: GET

Headers

Path

All Agents Status Request

curl --location --request GET 'https://{ccPlatform}.8x8.com/api/v{version}/tenants/{tenantId}/agentstatus/agents' \
--header 'Authorization: Basic {encodedValue}'

All Agent Status Response

{
    "data": [
        {
            "agent-id": "ag0VYyLh0YTsymdbtYIaaaa",
            "agent-status": 1,
            "name": "Ilya Workshard"
        },
        {
            "agent-id": "ag0XgxWZr7TzqWFhxboBGj1g",
            "agent-status": 1,
            "status-code-list-id": -1,
            "status-code-item-id": 1,
            "name": "Jane Smith"
        },
        {
            "agent-id": "ag1LmqEeEYRoOti9KjIi_Dng",
            "agent-status": 0,
            "name": "Paul Neverhere"
        },
        {
            "agent-id": "ag64oyEUb_Sk6bxVB9P5ye5w",
            "agent-status": 5,
            "status-code-list-id": 801,
            "status-code-item-id": 1726,
            "status-code-item-short-code": "Train",
            "name": "Padma Othertask",
            "agent-sub-status": "none"
        }
    ]
}

Get Status for single agent

To request status for an individual agent simply append the appropriate agentId /agents/agentId

Parameters

Method: GET

Headers

Path

Single Agent Status Request

curl --location --request GET 'https://{ccPlatform}.8x8.com/api/v{version}/tenants/{tenantId}/agentstatus/agents/{agentId}' \
--header 'Authorization: Basic {encodedValue}'

Single Agent Status Response

{
  "agent-id": "ag64oyEUb_Sk6bxVB9P5yaaa",
  "agent-status": 5,
  "status-code-list-id": 801,
  "status-code-item-id": 1726,
  "status-code-item-short-code": "Train",
  "name": "Padma Othertask",
  "agent-sub-status": "none"
}

Allowed Status Transitions

• Red lines indicate single direction (not reversible via API)
• Black lines indicate bidirectional
• All other transitions are NOT supported via API

Agent status API Reference allows you to try out this API.

Set Status for a single agent

The status can only be set to and from the statuses defined in allowed status change diagram

Parameters

Method: PUT

Headers

Path

Body

Set Single Agent Status Request

curl --location --request PUT 'https://{ccPlatform}.8x8.com/api/v{version}/tenants/{tenantId}/agentstatus/agents/{agentId}' \
--header 'Authorization: Basic {encodedValue}'
--header 'Content-Type: application/json' \
--data-raw '{
    "agent-status": 5,
    "status-code-list-id": 801,
    "status-code-item-id": 1722,
    "status-code-item-short-code": "Meet"
}'

Set Single Agent Status Response

{
    "reason": "OK",
    "change-status": 200,
    "message": "Agent status change successful"
}

🚧

403 response code 403 - Forbidden.

Historically this capability has only enabled on request. If you receive response code 403 then please contact 8x8 support and request that your "Agent Status API" is enabled in OPSCON.

Set Status for Agents in bulk

To set the status of multiple agents in a single request.

• The requested status can be different for each agent.
• Each agent request is independent and some requests can succeed and others fail within a single request. The outcome is delivered via a HTTP 207 Multi-Status response.

Parameters

Method: PUT

Headers

Path

Body

The body will contain an array of agents, each entry in the array will have the following:

Set Bulk Status Request

curl --location --request PUT 'https://<<ccPlatform>>.8x8.com/api/v1/tenants/<<tenantId>>/agentstatus/agents/bulk' \
--header 'Authorization: Basic <<encodedValue>>'
--header 'Content-Type: application/json' \
--data-raw '{
    "agents": [
    {
        "agent-id": "ag64oyEUb_Sk6bxVB9P5yaaa",
        "agent-status": 3,
        "status-code-list-id": 801,
        "status-code-item-id": 1725,
        "status-code-item-short-code": "Lunch"
    },
    {
        "agent-id": "agAQDqmvKiRbG4ekigNSmbbb",
        "agent-status": 3,
        "status-code-list-id": 801,
        "status-code-item-id": 1725,
        "status-code-item-short-code": "Lunch"
    }
]
}'

Set Bulk Status Response

Response Status is 207 and the individual status of each agent status change is contained in the body of the response

{
    "data": [
        {
            "agent-id": "ag64oyEUb_Sk6bxVB9P5yaaa",
            "reason": "OK",
            "change-status": 200,
            "message": "Agent status change successful"
        },
        {
            "agent-id": "agAQDqmvKiRbG4ekigNSmbbb",
            "reason": "OK",
            "change-status": 200,
            "message": "Agent status change successful"
        }
    ]
}

References

Status Values that can be changed as explained in the diagram form the beginning of this documentation:

Status Values that can be returned by the GET operations but cannot be ammended by the SET operation:

Status Code Lists and Items

Status Code Lists are assigned to Agent Groups via CC Configuration Manager.
These lists allow for a specific reason for the status to be selected by the agent or in this case assigned via the API.

status-code-list-id this is the id of the list itself: This can be identified either by using the Get Agent Status or via the stats API.

status-code-item-id this is the id of the list itself: This can be identified either by using the Get Agent Status to return the values for an agent in a known state or via the stats API.

status-code-item-short-code This can be found in CC Configuration Manager under: Status Codes, by selecting the required Status Code List, then under "Codes" referencing the "Short Codes" column, or by using the Get Agent Status to return the values for an agent in a known state or via the stats API.