Get Agent Details by AgentID

get https://{domainname}/CAServices/AgentDetails/AgentDetails.php

Log in to see full request history

❗️
Deprecation Update
This API will be deprecated by 30th April 2025.
We recommend to start using the new version of the APIs:

Agent Details (Basic Authentication)

Agent Details (Token Authentication)

This API retrieves detailed information about an agent in your CloudAgent account.

To access this API the following parameters MUST be passed.

Parameter	Description
userName*	CloudAgent account name
apiKey*	Available in CloudAgent admin login
AgentId	Id of agent's required to get data

❗️
Note

Parameters with ‘*’ are considered to be mandatory parameters.

Possible responses


Success response	status: "success" message: ": { "0-0": "Success response", "0-1": "status: "success"\nmessage: uccess response", "0-1": "status: "success" \nmessage: ": { \n "0-0": "Success response", \n "0-1": "status: \"success\"\\nmessage: [{\"AgentId\": \"xxx\"\n\"AgentName\": \"xxx\"\n", "1-0": "If userName is empty", "1-1": ""status": "error"\n"message": "userName should not be empty"", "2-0": "If apiKey is empty", "2-1": ""status": "error"\n"message": apiKey should not be empty"", "3-0": "If userName or apiKey is invalid", "3-1": ""status"
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"

📘
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.

Response

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://in1-ccaas-api.ozonetel.com/CAServices/AgentDetails/AgentDetails.php \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here!