post https://api-smartflo.tatateleservices.com/v1/department
This API allows you to create a new department.
Sample Request
Add a new department with the following API method:
curl --request POST \
--url https://api-smartflo.tatateleservices.com/v1/department \
--header 'accept: application/json' \
--header 'content-type: application/json'
Request Variables (Body Params)
It takes a JSON request body with the following notable parameters:
| Variable Name | Description | Data Type |
|---|---|---|
| name* | Name of the department. For example, Sales Department. | String |
| description* | Description of the department. For example, Sales Department Description. | 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, and every agent has a ringing phone on his/her desk. 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 |
| failover_dest_type* | The destination type where the call lands if no one answers the call. For example, extension. | String |
| timeout | Time in seconds for which the call tries to connect to each agent in this department. For example, 30. | Integer |
| destination | The ID of the destination where the call should land. For example, extension||05047530046. | Array of strings |
| music_on_hold* | Unique ID of music on hold to be played when caller is on hold. For example, 42240. | String |
| failover_destination* | The ID of the destination where the call should land if no one answers the call. For example, extension||05047530064. | String |
| sticky_agent* | The agent who will receive the calls in a department, if enabled. For example, 05047530211. | Integer |
Request Variables (Body Params)(Sticky Agent)
The Sticky agent connects the caller to the same agent when the user calls within the same threshold time.
| Property Name | Description | Data Type |
|---|---|---|
| enable | Indicates wether sticky agent be enabled or disabled. 1 - Enable 0 - Disable | Integer |
| time | time for which sticky agent be checked. example: 12h, 1d h - hours d - days Note: Sticky Agent can only be enabled for at max 10 days. Max enable time in hrs:240h Max enable time in days: 10d | String |
Response variables
After the execution of the API, you will get the following response variables:
| Variable Name | Description | Data Type |
|---|---|---|
| Success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| Message | The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here. | String |