get https://{domainname}/cloudAgentRestAPI/index.php/CloudAgent/CloudAgentAPI/AgentManage
This API is used to create or delete an agent in CloudAgent. The user has to update the ‘action’ parameter with the desired function.
To access this API we need to pass the following parameters.
| Parameter | Desciption |
|---|---|
| apiKey* | Available in CloudAgent admin login |
| userName* | CloudAgent user name |
| agentName* | Name of the agent |
| agentId* | Unique agentId to be assigned to agent |
| agentPassword* | Password for the agent to login |
| action* | Create: If to create a new agent Delete: Delete an agent profile |
| skill | Skill names with comma separation, that are to be assigned to agent while creating |
Note
Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
| Response | Output |
|---|---|
| Success Create response | "status": "success" "message": "Agent Created Successfully" |
| Invalid api_key | "status": "error" "message": "Authentication Failed" |
| Invalid action | "status": "error" "message": "Agent Option is Invalid" |
| Invalid username | "status": "error" "message": "Authentication Failed" |
| Empty fields | "status": "error" "message": "All parameters are mandatory" |
| Name exists | "status": "error" "message": "Agent Already Exists" |
| Success Delete response | "status": "success" "message": "Agent Deleted Successfully" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.