Sample Request

Use the following method to obtain a detailed list of all departments:

curl --request GET \
     --url https://api-smartflo.tatateleservices.com/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

After the execution of the API, you will get the following response:

Variable	Description	Data Type
id	The unique ID of department. For example, 24400	String
name	The name of the department. For example, Counselling.	String
description	The description of the department. For example, Department without queue.	String
ring_strategy	When a customer dials an extension, there are several strategies that can be devised to distribute the calls as per the availability and the number of agents. Simultaneously: Rings all agents simultaneously. Order by : Rings agents in sequence from the top of the list in the members tab of the queue configuration. Random : Rings agents in no particular sequence. Round Robin: Rings an agent who is next in a pre-decided order. * Longest Wait Time: Rings agent who has waited for the longest to take a call.	String
music_on_hold	The ID of music on hold applied on department. For example, 99.	String
failover_music	The ID of failover music applied on department. For example, 97.	String
agent_count	The total number of agents assigned to a department. For example, 2.	String
calls_answered	The total number of calls handled by the department. For example, 1.	String
calls_missed	The total number of missed calls by the department. For example, 2.	String
use_as_queue	Whether or not to use a department as a queue. For example, true.	Boolean
queue_timeout	For how long (in seconds) will the call be held in the queue. For example, 110.	String
sticky_agent{}	Details of sticky agent.	object
sticky_agent{}.enabled	Whether or not the sticky agent is enabled. For example, false.	Boolean
sticky_agent{}.time_period	The duration of the sticky agent's work on the department. For example, 24	String
sticky_agent{}.format	There is two-time format for sticky agent: h - hours d - days	String
transcription{}	Details of transcription.	Object
transcription{}.enabled	Whether or not the transcription is enabled. For example, True.	Boolean
transcription{}.language	The language in which the transcription is performed. For example, english.	String
transcription{}.agent_time	The time duration to transcribe the recording, once the agent answers the call. For example, 20.	String
missed_call_sms_id	The ID of missed call SMS applied on department. For example, 35654	String
failover_missed_call_sms_id	The ID of failover missed call SMS applied on department. For example, 35702	String
timeout_dest_type	The type of destination where the call should be landed if no one answers the call, for example, hangup.	String
timeout_destination	The ID of the destination where the call should be landed if no one answers the call. For example, 1.	String
timeout_dest_name	The name of the timeout destination. For example, hangup.	String
hold_playback	The ID of hold playback recording applied on department. For example, 32124.	String
agents[]	Details of the agent.	Array
agents[n].id	The ID of Agent. For example, 60800.	String
agents[n].name	The name of the agent. For example, salik.	String
agents[n].eid	The ID of agent extension. For example, 05047530323.	String
agents[n].timeout	The time duration for which the call ring to the agent. For example, 30.	String