Agent Activity API
To get the agent status in real-time or changes stacked every 30 seconds.
| Method
|
GET
|
| Endpoints
|
https://{{host}}/agentassist/api/public/analytics/account/{{AccountID}}/agentactivity
|
| Content-Type
|
application/json
|
| Authorization
|
auth: {{JWT}}
See How to generate the JWT Token.
|
| API Scope
|
WFM Integration
|
Path Parameters
| Parameter
|
Description
|
Type
|
| host
|
Environment URL, for example, https://smartassist.kore.ai
|
string, required
|
| AccountId
|
The unique Id associated with the account.
|
string, required
|
Sample Request
curl --location 'https://{{host}}/agentassist/api/public/analytics/account/636f5b36bcf8a8c7101exxxx/agentactivity?fromTimeStamp=2023-04-02T09%3A45%3A00Z&toTimeStamp=2023-04-06T10%3A00%3A00Z' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLWYyYjdmM2Y5LWE0Y2EtNWRhYS04ODRjLThlZDQxYjM2MWRjOSJ9.lYyONpEEmSYdQo7CIOpHWqz4pQE-PgAN2lLYz3-xxxx' \
--header 'Content-Type: application/json'
Sample Response
{
"accountId":"63fb9a0f90425b644d3exxxx",
"AgentUpdates": [
{
"AgentId":"a-59bb17e-0cae-46b0-8d80-a8a8ac34xxxx",
"EventTime":"10/20/2020 2:13:12",
"Activity":"notready",
"ReasonCode":"1"
}
]
}
Body Parameters
| Parameter
|
Description
|
Type
|
| accountId
|
The unique Id associated with the account. For example, 63fb9a0f90425b644d3ec070.
|
String
|
| AgentUpdates
|
List of objects representing updates to agent statuses.
|
Array
|
| AgentUpdates.AgentId
|
The unique Id of the agent. For example, a-59bb17e-0cae-46b0-8d80-a8a8ac34e55c.
|
String
|
| AgentUpdates.EventTime
|
TTimestamp of the event in the MM/DD/YYYY HH:MM:SS format.
|
String
|
| AgentUpdates.Activity
|
Agent's activity status at the time of the event. For example, "notready".
|
String
|
| AgentUpdates.ReasonCode
|
Code representing the reason for the agent's status change. For example, “1”.
|
String
|