get https://{domainname}/CAServices/AgentState/StateChange.php
Deprecation Update
This API will be deprecated by 31st Dec 2024.
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" "message": "userName or apiKey is Invalid" |
| Empty apiKey | "status": "error" "message": "apiKey should not be empty" |
| Invalid userName | "status": "error" "message": "user_name or api_Key is Invalid" |
| Empty userName | "status": "error" "message": "Please provide UserName" |
| Invalid state | "status": "error" "message": "The state should be either 'Ready' or 'Pause' state'" |
| Passing Invalid pauseReason Value. When the user passes State as Pause. | "status":"error", "message":"pauseReason is Invalid" |
| Changing the agent to 'Pause' / 'Ready" state when he is not logged in. | "status":"error", "message":"Agent is not Logged In" |
| Changing the agent to Pause state when he is in ACW state. | "status":"error", "Message":"Agent xxxx is in ACW state. You cant change to Pause state" |
| Changing the agent to Pause state when he is in BUSY state. | "status":"error", "Message":"Agent xxxx is in BUSY state. You cant change to Pause state" |
| Success response | "status": "success" "message": " {"type":"response", "utid":"22", "resp":"Success:tbAgentPause~INBOUND", "agentStatus":"PAUSED", "agentId":"XXXXX", "user":"XXXXX"}" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.