/dialpad-organization | Type: Application | PCID required: Yes
Tools
dialpad_organization_callcenters_list
Call Centers — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
office_id | integer | Yes | — | The office’s id. |
dialpad_organization_coaching_team_list
Coaching Team — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
office_id | integer | Yes | — | The office’s id. |
dialpad_organization_company_get
Company — Getdialpad_organization_company_sms_opt_out
Company — Get SMS Opt-out List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key. |
a2p_campaign_id | integer | No | — | Optional company A2P campaign entity id to filter results by. Note, if set, then the parameter ‘opt_out_state’ must be also set to the value ‘opted_out’. |
cursor | string | No | — | Optional token used to return the next page of a previous request. Use the cursor provided in the previous response. |
opt_out_state | string | Yes | — | Required opt-out state to filter results by. Only results matching this state will be returned. |
dialpad_organization_company_update_settings
Company — Update Settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
has_callai | boolean | No | — | If Call AI setting should be enabled/disabled |
dialpad_organization_departments_create
Departments — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
auto_call_recording | boolean | No | — | Whether or not automatically record all calls of this department. Default is False. |
friday_hours | string[] | No | — | The Friday hours of operation. Default value is [“08:00”, “18:00”]. |
group_description | string | No | — | The description of the department. Max 256 characters. |
hold_queue | object | No | — | Hold Queue |
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). |
monday_hours | string[] | 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”]. |
name | string | Yes | — | [single-line only] The name of the department. Max 100 characters. |
office_id | integer | Yes | — | The id of the office to which the department belongs.. |
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. |
routing_options | object | No | — | Routing Options |
saturday_hours | string[] | No | — | The Saturday hours of operation. Default is empty array. |
sunday_hours | string[] | No | — | The Sunday hours of operation. Default is empty array. |
thursday_hours | string[] | No | — | The Thursday hours of operation. Default value is [“08:00”, “18:00”]. |
tuesday_hours | string[] | No | — | The Tuesday hours of operation. Default value is [“08:00”, “18:00”]. |
voice_intelligence | object | No | — | Voice Intelligence |
wednesday_hours | string[] | No | — | The Wednesday hours of operation. Default value is [“08:00”, “18:00”]. |
dialpad_organization_departments_delete
Departments — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
dialpad_organization_departments_get
Department — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
dialpad_organization_departments_list
Department — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
office_id | integer | Yes | — | The office’s id. |
dialpad_organization_departments_listall
Department — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
office_id | integer | No | — | filter departments by office. |
name_search | string | No | — | search departments by name or search by the substring of the name. If input example is ‘Happy’, output example can be a list of departments whose name contains the string Happy - [‘Happy department 1’, ‘Happy department 2’] |
dialpad_organization_departments_operators_delete
Operator — Remove Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
operator_id | integer | Yes | — | ID of the operator to remove. |
operator_type | string | Yes | — | Type of the operator to remove (user or room). |
dialpad_organization_departments_operators_get
Operator — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
dialpad_organization_departments_operators_post
Operator — Add Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
operator_id | integer | Yes | — | ID of the operator to add. |
operator_type | string | Yes | — | Type of the operator to add. (user or room) |
role | string | No | — | The role of the new operator. (operator or admin) |
dialpad_organization_departments_update
Departments — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The department’s id. |
auto_call_recording | boolean | No | — | Whether or not automatically record all calls of this department. Default is False. |
friday_hours | string[] | No | — | The Friday hours of operation. Default value is [“08:00”, “18:00”]. |
group_description | string | No | — | The description of the department. Max 256 characters. |
hold_queue | object | No | — | Hold Queue |
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). |
monday_hours | string[] | 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”]. |
name | string | No | — | [single-line only] The name of the department. Max 100 characters. |
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. |
routing_options | object | No | — | Routing Options |
saturday_hours | string[] | No | — | The Saturday hours of operation. Default is empty array. |
sunday_hours | string[] | No | — | The Sunday hours of operation. Default is empty array. |
thursday_hours | string[] | No | — | The Thursday hours of operation. Default value is [“08:00”, “18:00”]. |
tuesday_hours | string[] | No | — | The Tuesday hours of operation. Default value is [“08:00”, “18:00”]. |
voice_intelligence | object | No | — | Voice Intelligence |
wednesday_hours | string[] | No | — | The Wednesday hours of operation. Default value is [“08:00”, “18:00”]. |
dialpad_organization_deskphones_rooms_create_international_pin
Room Phone — Assign PIN Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_ref | string | No | — | [single-line only] An identifier to be printed in the usage summary. Typically used for identifying the person who requested the PIN. |
dialpad_organization_deskphones_rooms_delete
Room Phone — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The desk phone’s id. |
parent_id | integer | Yes | — | The room’s id. |
dialpad_organization_deskphones_rooms_get
Room Phone — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The desk phone’s id. |
parent_id | integer | Yes | — | The room’s id. |
dialpad_organization_deskphones_rooms_list
Room Phone — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parent_id | integer | Yes | — | The room’s id. |
dialpad_organization_numbers_assign_office_number_post
Dialpad Number — Assign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
area_code | string | No | — | An area code in which to find an available phone number for assignment. |
number | string | No | — | A phone number to assign. (e164-formatted) |
primary | boolean | No | — | A boolean indicating whether this should become the primary phone number. |
dialpad_organization_numbers_assign_room_number_post
Dialpad Number — Assign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The room’s id. |
area_code | string | No | — | An area code in which to find an available phone number for assignment. |
number | string | No | — | A phone number to assign. (e164-formatted) |
primary | boolean | No | — | A boolean indicating whether this should become the primary phone number. |
dialpad_organization_numbers_office_unassign_number_post
Dialpad Number — Unassign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
number | string | Yes | — | A phone number to unassign. (e164-formatted) |
dialpad_organization_numbers_room_unassign_number_post
Dialpad Number — Unassign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The room’s id. |
number | string | Yes | — | A phone number to unassign. (e164-formatted) |
dialpad_organization_offices_create
Office — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
annual_commit_monthly_billing | boolean | Yes | — | A flag indicating if the primary office’s plan is categorized as annual commit monthly billing. |
auto_call_recording | boolean | No | — | Whether or not automatically record all calls of this office. Default is False. |
billing_address | object | Yes | — | Billing Address |
billing_contact | object | No | — | Billing Contact |
country | string | Yes | — | The office country. |
currency | string | Yes | — | The office’s billing currency. |
e911_address | object | No | — | E911 Address |
first_action | string | No | — | The desired action when the office receives a call. |
friday_hours | string[] | No | — | The Friday hours of operation. Default value is [“08:00”, “18:00”]. |
group_description | string | No | — | The description of the office. Max 256 characters. |
hours_on | boolean | No | — | The time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7). |
international_enabled | boolean | No | — | A flag indicating if the primary office is able to make international phone calls. |
invoiced | boolean | Yes | — | A flag indicating if the payment will be paid by invoice. |
mainline_number | string | No | — | The mainline of the office. |
monday_hours | string[] | 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”]. |
name | string | Yes | — | [single-line only] The office name. |
no_operators_action | string | No | — | The action to take if there is no one available to answer calls. |
plan_period | string | Yes | — | The frequency at which the company will be billed. |
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. |
routing_options | object | No | — | Routing Options |
saturday_hours | string[] | No | — | The Saturday hours of operation. Default is empty array. |
sunday_hours | string[] | No | — | The Sunday hours of operation. Default is empty array. |
thursday_hours | string[] | No | — | The Thursday hours of operation. Default value is [“08:00”, “18:00”]. |
timezone | string | No | — | Timezone using a tz database name. |
tuesday_hours | string[] | No | — | The Tuesday hours of operation. Default value is [“08:00”, “18:00”]. |
unified_billing | boolean | Yes | — | A flag indicating if to send a unified invoice. |
use_same_address | boolean | No | — | A flag indicating if the billing address and the emergency address are the same. |
voice_intelligence | object | No | — | Voice Intelligence |
wednesday_hours | string[] | No | — | The Wednesday hours of operation. Default value is [“08:00”, “18:00”]. |
dialpad_organization_offices_e911_get
E911 Address — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
dialpad_organization_offices_e911_update
E911 Address — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
address | string | Yes | — | [single-line only] Line 1 of the new E911 address. |
address2 | string | No | — | [single-line only] Line 2 of the new E911 address. |
city | string | Yes | — | [single-line only] City of the new E911 address. |
country | string | Yes | — | Country of the new E911 address. |
state | string | Yes | — | [single-line only] State or Province of the new E911 address. |
update_all | boolean | No | — | Update E911 for all users in this office. |
use_validated_option | boolean | No | — | Whether to use the validated address option from our service. |
zip | string | Yes | — | [single-line only] Zip code of the new E911 address. |
dialpad_organization_offices_get
Office — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
dialpad_organization_offices_list
Office — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
active_only | boolean | No | — | Whether we only return active offices. |
dialpad_organization_offices_offdutystatuses_get
Off-Duty Status — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
dialpad_organization_offices_operators_delete
Operator — Remove Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s ID. |
operator_id | integer | Yes | — | ID of the operator to remove. |
operator_type | string | Yes | — | Type of the operator to remove (user or room). |
dialpad_organization_offices_operators_get
Operator — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
dialpad_organization_offices_operators_post
Operator — Add Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s ID. |
operator_id | integer | Yes | — | ID of the operator to add. |
operator_type | string | Yes | — | Type of the operator to add. (user or room) |
role | string | No | — | The role of the new operator. (operator or admin) |
dialpad_organization_offices_primary_get
Office — Get Primarydialpad_organization_offices_update
Office — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The office’s id. |
friday_hours | string[] | No | — | The Friday hours of operation. Default value is [“08:00”, “18:00”]. |
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). |
monday_hours | string[] | 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”]. |
saturday_hours | string[] | No | — | The Saturday hours of operation. Default is empty array. |
sunday_hours | string[] | No | — | The Sunday hours of operation. Default is empty array. |
thursday_hours | string[] | No | — | The Thursday hours of operation. Default value is [“08:00”, “18:00”]. |
tuesday_hours | string[] | No | — | The Tuesday hours of operation. Default value is [“08:00”, “18:00”]. |
wednesday_hours | string[] | No | — | The Wednesday hours of operation. Default value is [“08:00”, “18:00”]. |
dialpad_organization_plan_available_licenses_get
Licenses — List Available Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
office_id | integer | Yes | — | The office’s id. |
dialpad_organization_plan_get
Billing Plan — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
office_id | integer | Yes | — | The office’s id. |
dialpad_organization_rooms_delete
Room — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The room’s id. |
dialpad_organization_rooms_get
Room — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The room’s id. |
dialpad_organization_rooms_list
Room — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
office_id | integer | No | — | The office’s id. |
dialpad_organization_rooms_patch
Room — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The room’s id. |
name | string | No | — | [single-line only] The name of the room. |
phone_numbers | string[] | No | — | A list of all phone numbers assigned to the room. Numbers can be re-ordered or removed from this list to unassign them. |
dialpad_organization_rooms_post
Room — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | [single-line only] The name of the room. |
office_id | integer | Yes | — | The office in which this room resides. |

