POST /api/v2/departments
Creates a new department.
Added on March 25th, 2022 for API v2.
Requires a company admin API key.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
routing_options |
Object | No | |
routing_options.closed |
Object | Yes | |
routing_options.closed.operator_routing |
String | No |
The routing strategy that should be used when dialing operators. Possible values:
|
routing_options.closed.dtmf[] |
Array | No |
DTMF menu options. |
routing_options.closed.dtmf[].input |
String | No |
The DTMF key associated with this menu item. (0-9) |
routing_options.closed.dtmf[].options |
Object | No | |
routing_options.closed.dtmf[].options.action |
String | No |
The routing action type. Possible values:
|
routing_options.closed.dtmf[].options.action_target_type |
String | No |
The type of the target that should be dialed. Possible values:
|
routing_options.closed.dtmf[].options.action_target_id |
Integer | No |
The ID of the target that should be dialed. |
routing_options.closed.action |
String | Yes |
The action that should be taken if no operators are available. Possible values:
|
routing_options.closed.action_target_type |
String | No |
The type of the Target that inbound calls should be routed to. Possible values:
|
routing_options.closed.try_dial_operators |
Boolean | Yes |
Whether operators should be dialed on inbound calls. |
routing_options.closed.action_target_id |
Integer | No |
The ID of the Target that inbound calls should be routed to. |
routing_options.open |
Object | Yes | |
routing_options.open.operator_routing |
String | No |
The routing strategy that should be used when dialing operators. Possible values:
|
routing_options.open.dtmf[] |
Array | No |
DTMF menu options. |
routing_options.open.dtmf[].input |
String | No |
The DTMF key associated with this menu item. (0-9) |
routing_options.open.dtmf[].options |
Object | No | |
routing_options.open.dtmf[].options.action |
String | No |
The routing action type. Possible values:
|
routing_options.open.dtmf[].options.action_target_type |
String | No |
The type of the target that should be dialed. Possible values:
|
routing_options.open.dtmf[].options.action_target_id |
Integer | No |
The ID of the target that should be dialed. |
routing_options.open.action |
String | Yes |
The action that should be taken if no operators are available. Possible values:
|
routing_options.open.action_target_type |
String | No |
The type of the Target that inbound calls should be routed to. Possible values:
|
routing_options.open.try_dial_operators |
Boolean | Yes |
Whether operators should be dialed on inbound calls. |
routing_options.open.action_target_id |
Integer | No |
The ID of the Target that inbound calls should be routed to. |
tuesday_hours[] |
Array | No |
The Tuesday hours of operation. Default value is ["08:00", "18:00"]. |
auto_call_recording |
Boolean | No |
Whether or not automatically record all calls of this department. Default is False. |
voice_intelligence |
Object | No | |
voice_intelligence.auto_start |
Boolean | No |
Auto start Vi for this call center. Default is True. |
voice_intelligence.allow_pause |
Boolean | No |
Allow individual users to start and stop Vi during calls. Default is True. |
friday_hours[] |
Array | No |
The Friday hours of operation. Default value is ["08:00", "18:00"]. |
monday_hours[] |
Array | No |
The Monday hours of operation. To specify when hours_on is set to True. e.g. ["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is ["08:00", "18:00"]. |
group_description |
String | No |
The description of the department. Max 256 characters. |
name |
String | Yes |
[single-line only] The name of the department. Max 100 characters. |
hours_on |
Boolean | No |
The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7). |
thursday_hours[] |
Array | No |
The Thursday hours of operation. Default value is ["08:00", "18:00"]. |
saturday_hours[] |
Array | No |
The Saturday hours of operation. Default is empty array. |
ring_seconds |
Integer | No |
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds. |
hold_queue |
Object | No | |
hold_queue.max_hold_seconds |
Integer | No |
Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min). |
hold_queue.max_hold_count |
Integer | No |
If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-50. Default is 50. |
hold_queue.allow_queuing |
Boolean | No |
Whether or not send callers to a hold queue, if all operators are busy on other calls. Default is False. |
office_id |
Integer | Yes |
The id of the office to which the department belongs.. |
sunday_hours[] |
Array | No |
The Sunday hours of operation. Default is empty array. |
wednesday_hours[] |
Array | No |
The Wednesday hours of operation. Default value is ["08:00", "18:00"]. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.