post https://{domainname}/ca_apis/AgentDetails
This API retrieves detailed information about an agent in your CloudAgent account.
Rate Limit:
A maximum of 10 requests per minute is allowed.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
| Parameter | Description |
|---|---|
| Content-Type | application/json |
Body Params
{
"userName": "xxxxxx",
"agentId": "xxxxxx"
}
Possible responses
| Success response | { "message": [ { "State": "NOT READY", "Since": "00:06:54", "Skill": "Hyderabad, offline_hyd, webChat, whatsapp", "AgentName": "xxxxx", "PhoneNumber": null, "AgentId": "xxxxx", "Mode": "Manual" } ], "status": "success" } |
| If userName is empty | "status": "error" "message": "userName should not be empty" |
| If apiKey is empty | "status": "error" "message": apiKey should not be empty" |
| If userName or apiKey is invalid | "status": "error" "message": "userName or apiKey is Invalid" |
| If campaignName is invalid | "status": "error", "message": "campaignName is Invalid" |
| If rate limit exceeds | "status": "error" "message": "only 1 hit will be allowed within a time frame of 5mins" |