Agent authentication API is used to log in or log out agents from the system. This API method helps in the virtual logging in of agents where the agent will be able to receive online calls similar to the way when the agent is logged in through UI.
Prerequisites
To access this API we need to pass the following parameters.
Authorization parameters
| Parameter | Description |
|---|---|
| Username* | Agent ID |
| Password* | Agent password |
API parameters
Parameter | Description |
|---|---|
userName* | CloudAgent account name |
apiKey* | Available in CloudAgent admin login |
phoneNumber* | Phone number to which the calls are routed |
action* | Enter "login" to log in the agent |
Note
- This API is applicable to virtually log in or log out the agents in offline scenarios. This will NOT login the agents on the toolbar UI (whether it is Ozonetel toolbar or embedded iframe)
- A phone number is required to login the agent, but not necessary while passing a logout request.
- The action parameter value is not case-sensitive.
- Parameters with ‘*’ are considered to be mandatory parameters.
Possible Responses
Success login response | "status": "success" |
Success logout response | "status": success" |
Invalid userName | "status": "error" |
Invalid apiKey | "status": "error" |
Invalid AgentID | "status": "error" |
Agent not logged in | "status": "error" |
Agent already logged in | "status": "error" |
Invalid Agent Password | "status": "error" |
Another agent logged in with same phone number | "status": "error" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.