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 'CREDENTIALS' tab. Here, input the generated token ID.
With the token entered, pass the header and body parameters:

❗️
Rate Limit: The API allows up to 5 requests per minute.

Success Response Format

{
 "data": [
 {
 "active": true,
 "agentData": "",
 "agentGroups": null,
 "agentId": "vinay",
 "agentName": "vinay",
 "autoAnswer": "NONE",
 "blended": false,
 "blendedChat": true,
CloudAgent API documentation 4
 "blendedInbound": true,
 "blendedManual": true,
 "blendedPreview": true,
 "blendedProgressive": true,
 "callControls": {
 "hold": true,
 "mute": true,
 "answer": true,
 "decline": true,
 "endcall": true,
 "dial_pad": true,
 "manualdial": true,
 "disposition": true,
 "callrecording": true,
 "conference_agent": true,
 "conference_phone": true,
 "transfer_ivr_warm": true,
 "transfer_ivr_blind": true,
 "transfer_agent_warm": true,
 "transfer_phone_warm": true,
 "transfer_skill_warm": true,
 "transfer_agent_blind": true,
 "transfer_phone_blind": true,
 "transfer_skill_blind": true,
 "not_enforce_screen_record": true
 },
 "chat": false,
 "email": "",
 "inbound": true,
 "manual": true,
 "oncall": false,
 "preview": false,
 "progressive": false,
 "screenRecording": false,
 "sipLocation": "USA_Agent",
 "skills": [
 {
 "priority": 1,
 "skillName": "General"
 },
 {
 "priority": 1,
 "skillName": "Commercial_Solid_Waste"
 },
 {
 "priority": 1,
 "skillName": "chat"
 }
 ]
 },

Error Responses:

Invalid apiKey Key

{  

"status": "false","message": "Api Key 
Should Not be Null or Empty.", 
"data": null  

}

Missing apiKey Value

{  

"status": "false", "message": "Invalid 
User Details", "data": null  

}

Invalid userName Key

{  

"status": "false", "message": 
"Username Should Not be Null or 
Empty.", "data": null  

}

Passing only userName and without passing size and page

In response it will display only 1st
data and size is set to 10.
"page": 1,
"size": 10,
"status": "success",
"total": 2946

Passing size greater than 100

{  

"message": "size must be between 1 
and 100", "status": "error"   

}

Tried more than 5 hits per minute.

{  

 "message": "Max limit exceeded",
 "status": "error"  
}