Deprecation Update
This API will be deprecated by 30th April 2025.
We recommend to start using the new version of the APIs:
This API enables you to control the agent states (applicable for offline agents only) within the account directly through your CRM system.
To access this API we need to pass the following parameters.
| Parameter | Description |
|---|---|
| userName* | CloudAgent username |
| apiKey* | Available in CloudAgent admin login |
| state* | Mention the agent state change - 'Ready', 'Pause' |
| agentId* | Unique ID assigned while creating an agent |
| pauseReason | The reason provided if the state is 'Pause' |
Note
- Parameters with ‘*’ are considered to be mandatory parameters.
- This API is applicable only in case of offline agents
Possible responses
Invalid apiKey | "status": "error" |
Empty apiKey | "status": "error" |
Invalid userName | "status": "error" |
Empty userName | "status": "error" |
Invalid state | "status": "error" |
Passing Invalid pauseReason Value. When the user passes State as Pause. | "status":"error", |
Changing the agent to 'Pause' / 'Ready" state when he is not logged in. | "status":"error", |
Changing the agent to Pause state when he is in ACW state. | "status":"error", |
Changing the agent to Pause state when he is in BUSY state. | "status":"error", |
Success response | "status": "success" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.