The ACD API allows to integrate ACD functionality to your project. It has following URLs:
Querying an agent’s ready status:
A Method to query the current status of an agent. Uses the HTTP-POST method.
POST | https://api.tenios.com/acd/agent-state/retrieve |
Request Parameter:
access_key String |
The api access key. It can be found in the menu item General Settings, section API in the customer portal. |
email String |
The Agent email (Cloud PBX->USER DETAILS). |
Response Parameter:
state String |
The current ready status of the agent. Can be READY or NOT_READY haben. |
Example of a successful request:
Request:
{ "access_key" : "XXXXX-XXXX-XXXXXX", "email": "test@test.com" }
API Response:
HTTP Status Code: 200 (OK)
{ "email": "test@test.com", "state": "NOT_READY" }
Change the status of an agent:
A method to change the status of an agent. Uses the HTTP-POST method.
POST | https://api.tenios.com/acd/agent-state/change |
Request Parameter:
access_key String |
The api access key. It can be found in the menu item General Settings, section API in the customer portal. |
email String |
The Agent email (Cloud PBX->USER DETAILS). |
state String |
The current ready status of the agent. Can be READY or NOT_READY haben. |
access_key String |
The api access key. It can be found in the menu item General Settings, section API in the customer portal. |
email String |
The Agent email (Cloud PBX->USER DETAILS). |
state String |
The current ready status of the agent. Can be READY or NOT_READY haben. |
nrr String Optional |
Acronym of a pre-configured Not-Ready Reason (NRR). |
Response Parameter:
success boolean |
Is true if the ready state was successfully set, otherwise false. |
Example of a successful request:
Request:
{ "access_key" : "XXXXX-XXXX-XXXXXX", "email" : "agent@test.com", "state": "READY", "nrr" : "COF" (optional) }
API Response:
HTTP Status Code: 200 (OK)
{ "success": true }
Examples of invalid requests: