get https://api.acefone.in/v1/departments
This API allows you to fetch details of all departments.
Sample Request
curl --request GET \
--url https://api.acefone.in/v1/departments \
--header 'accept: application/json'
š Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Sample Response
[
{
"id": "20546",
"name": "xyz Dept",
"description": "xyz Dept",
"ring_strategy": "simultaneously",
"music_on_hold": null,
"hold_playback": null,
"failover_music": null,
"agent_count": "3",
"calls_answered": "0",
"calls_missed": "0",
"use_as_queue": false,
"queue_timeout": "90",
"sticky_agent": {
"enabled": false,
"time_period": null,
"format": null
},
"transcription": {
"enabled": false,
"language": null,
"agent_time": null
},
"missed_call_sms_id": null,
"failover_missed_call_sms_id": null,
"timeout_dest_type": "extension",
"timeout_destination": "050109590001",
"timeout_dest_name": "xyz",
"agents": [
{
"id": "28131",
"name": "xyz",
"eid": "050109590002",
"timeout": "30"
},
{
"id": "28130",
"name": "xyz",
"eid": "050109590001",
"timeout": "30"
},
{
"id": "391102",
"name": "xyz",
"eid": "050109590016",
"timeout": "30"
}
]
},.....
}
]
Response Variables
The response returned is as following:
Variable Name | Description | Data Type |
---|---|---|
id | Unique ID of the department | String |
name | Name for department. | String |
description | Description for department | String |
ring_strategy | Way in which calls will be received by agents. | String |
music_on_hold | ID of the music on hold. | String |
failover_music | ID of the failover music | String |
agent_count | Number of agents corresponding to a department | String |
calls_answered | Total number of calls answered by department | String |
calls_missed | Total number of calls missed by department | String |
use_as_queue | Whether the queue is enabled on department or not. | Boolean |
queue_timeout | Timeout seconds of agent in queue. | String |
sticky_agent.enabled | Whether the sticky agent is enabled in the department or not. | Boolean |
sticky_agent.time_period | Time period of the sticky agent. | String |
sticky_agent.format | Format of time stamp in sticky agent. For example: h(hours), d(days). | String |
transcription.enabled | Whether transcription is enabled in the department or not. | Boolean |
transcription.language | Language of the transcription. | String |
transcription.agent_time | Transcription agent answered time (in seconds). | Integer |
missed_call_sms_id | ID of the missed call sms. | Integer |
failover_missed_call_sms_id | ID of the failover missed call sms. | Integer |
timeout_dest_type | After call has ringed on all agents and still no one answers then call is forwarded to this destination type | String |
timeout_destination | Unique ID of the destination where call should be transferred when no agent from the department answers the call | String |
timeout_dest_name | Destination where call should be transferred when no agent from the department answers the call. | String |
agents.id | Id of the agent. | String |
agents.name | Name of the agent. | String |
agents.eid | EID of the agent. | String |
agents.timeout | Timeout time of the agent in seconds. | String |