Fetch details of all departments

This API allows you to fetch details of all departments.

Sample Request

curl --request GET \
     --url https://api.servetel.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 NameDescriptionData Type
idUnique ID of the departmentString
nameName for department.String
descriptionDescription for departmentString
ring_strategyWay in which calls will be received by agents.String
music_on_holdID of the music on hold.String
failover_musicID of the failover musicString
agent_countNumber of agents corresponding to a departmentString
calls_answeredTotal number of calls answered by departmentString
calls_missedTotal number of calls missed by departmentString
use_as_queueWhether the queue is enabled on department or not.Boolean
queue_timeoutTimeout seconds of agent in queue.String
sticky_agent.enabledWhether the sticky agent is enabled in the department or not.Boolean
sticky_agent.time_periodTime period of the sticky agent.String
sticky_agent.formatFormat of time stamp in sticky agent. For example: h(hours), d(days).String
transcription.enabledWhether transcription is enabled in the department or not.Boolean
transcription.languageLanguage of the transcription.String
transcription.agent_timeTranscription agent answered time (in seconds).Integer
missed_call_sms_idID of the missed call sms.Integer
failover_missed_call_sms_idID of the failover missed call sms.Integer
timeout_dest_typeAfter call has ringed on all agents and still no one answers then call is forwarded to this destination typeString
timeout_destinationUnique ID of the destination where call should be transferred when no agent from the department answers the callString
timeout_dest_nameDestination where call should be transferred when no agent from the department answers the call.String
agents.idId of the agent.String
agents.nameName of the agent.String
agents.eidEID of the agent.String
agents.timeoutTimeout time of the agent in seconds.String
Click Try It! to start a request and see the response here!