Skip to main content
Server path: /dialpad-organization | Type: Application | PCID required: Yes

Tools

ToolDescription
dialpad_organization_callcenters_listCall Centers — List
dialpad_organization_coaching_team_listCoaching Team — List
dialpad_organization_company_getCompany — Get
dialpad_organization_company_sms_opt_outCompany — Get SMS Opt-out List
dialpad_organization_company_update_settingsCompany — Update Settings
dialpad_organization_departments_createDepartments — Create
dialpad_organization_departments_deleteDepartments — Delete
dialpad_organization_departments_getDepartment — Get
dialpad_organization_departments_listDepartment — List
dialpad_organization_departments_listallDepartment — List
dialpad_organization_departments_operators_deleteOperator — Remove
dialpad_organization_departments_operators_getOperator — List
dialpad_organization_departments_operators_postOperator — Add
dialpad_organization_departments_updateDepartments — Update
dialpad_organization_deskphones_rooms_create_international_pinRoom Phone — Assign PIN
dialpad_organization_deskphones_rooms_deleteRoom Phone — Delete
dialpad_organization_deskphones_rooms_getRoom Phone — Get
dialpad_organization_deskphones_rooms_listRoom Phone — List
dialpad_organization_numbers_assign_office_number_postDialpad Number — Assign
dialpad_organization_numbers_assign_room_number_postDialpad Number — Assign
dialpad_organization_numbers_office_unassign_number_postDialpad Number — Unassign
dialpad_organization_numbers_room_unassign_number_postDialpad Number — Unassign
dialpad_organization_offices_createOffice — Create
dialpad_organization_offices_e911_getE911 Address — Get
dialpad_organization_offices_e911_updateE911 Address — Update
dialpad_organization_offices_getOffice — Get
dialpad_organization_offices_listOffice — List
dialpad_organization_offices_offdutystatuses_getOff-Duty Status — List
dialpad_organization_offices_operators_deleteOperator — Remove
dialpad_organization_offices_operators_getOperator — List
dialpad_organization_offices_operators_postOperator — Add
dialpad_organization_offices_primary_getOffice — Get Primary
dialpad_organization_offices_updateOffice — Update
dialpad_organization_plan_available_licenses_getLicenses — List Available
dialpad_organization_plan_getBilling Plan — Get
dialpad_organization_rooms_deleteRoom — Delete
dialpad_organization_rooms_getRoom — Get
dialpad_organization_rooms_listRoom — List
dialpad_organization_rooms_patchRoom — Update
dialpad_organization_rooms_postRoom — Create

dialpad_organization_callcenters_list

Call Centers — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
office_idintegerYesThe office’s id.

dialpad_organization_coaching_team_list

Coaching Team — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
office_idintegerYesThe office’s id.

dialpad_organization_company_get

Company — Get

dialpad_organization_company_sms_opt_out

Company — Get SMS Opt-out List Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID 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_idintegerNoOptional 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’.
cursorstringNoOptional token used to return the next page of a previous request. Use the cursor provided in the previous response.
opt_out_statestringYesRequired opt-out state to filter results by. Only results matching this state will be returned.

dialpad_organization_company_update_settings

Company — Update Settings Parameters:
ParameterTypeRequiredDefaultDescription
has_callaibooleanNoIf Call AI setting should be enabled/disabled

dialpad_organization_departments_create

Departments — Create Parameters:
ParameterTypeRequiredDefaultDescription
auto_call_recordingbooleanNoWhether or not automatically record all calls of this department. Default is False.
friday_hoursstring[]NoThe Friday hours of operation. Default value is [“08:00”, “18:00”].
group_descriptionstringNoThe description of the department. Max 256 characters.
hold_queueobjectNoHold Queue
hours_onbooleanNoThe 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_hoursstring[]NoThe 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”].
namestringYes[single-line only] The name of the department. Max 100 characters.
office_idintegerYesThe id of the office to which the department belongs..
ring_secondsintegerNoThe 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_optionsobjectNoRouting Options
saturday_hoursstring[]NoThe Saturday hours of operation. Default is empty array.
sunday_hoursstring[]NoThe Sunday hours of operation. Default is empty array.
thursday_hoursstring[]NoThe Thursday hours of operation. Default value is [“08:00”, “18:00”].
tuesday_hoursstring[]NoThe Tuesday hours of operation. Default value is [“08:00”, “18:00”].
voice_intelligenceobjectNoVoice Intelligence
wednesday_hoursstring[]NoThe Wednesday hours of operation. Default value is [“08:00”, “18:00”].

dialpad_organization_departments_delete

Departments — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.

dialpad_organization_departments_get

Department — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.

dialpad_organization_departments_list

Department — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
office_idintegerYesThe office’s id.

dialpad_organization_departments_listall

Department — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
office_idintegerNofilter departments by office.
name_searchstringNosearch 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.
operator_idintegerYesID of the operator to remove.
operator_typestringYesType of the operator to remove (user or room).

dialpad_organization_departments_operators_get

Operator — List Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.

dialpad_organization_departments_operators_post

Operator — Add Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.
operator_idintegerYesID of the operator to add.
operator_typestringYesType of the operator to add. (user or room)
rolestringNoThe role of the new operator. (operator or admin)

dialpad_organization_departments_update

Departments — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe department’s id.
auto_call_recordingbooleanNoWhether or not automatically record all calls of this department. Default is False.
friday_hoursstring[]NoThe Friday hours of operation. Default value is [“08:00”, “18:00”].
group_descriptionstringNoThe description of the department. Max 256 characters.
hold_queueobjectNoHold Queue
hours_onbooleanNoThe 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_hoursstring[]NoThe 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”].
namestringNo[single-line only] The name of the department. Max 100 characters.
ring_secondsintegerNoThe 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_optionsobjectNoRouting Options
saturday_hoursstring[]NoThe Saturday hours of operation. Default is empty array.
sunday_hoursstring[]NoThe Sunday hours of operation. Default is empty array.
thursday_hoursstring[]NoThe Thursday hours of operation. Default value is [“08:00”, “18:00”].
tuesday_hoursstring[]NoThe Tuesday hours of operation. Default value is [“08:00”, “18:00”].
voice_intelligenceobjectNoVoice Intelligence
wednesday_hoursstring[]NoThe Wednesday hours of operation. Default value is [“08:00”, “18:00”].

dialpad_organization_deskphones_rooms_create_international_pin

Room Phone — Assign PIN Parameters:
ParameterTypeRequiredDefaultDescription
customer_refstringNo[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:
ParameterTypeRequiredDefaultDescription
idstringYesThe desk phone’s id.
parent_idintegerYesThe room’s id.

dialpad_organization_deskphones_rooms_get

Room Phone — Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe desk phone’s id.
parent_idintegerYesThe room’s id.

dialpad_organization_deskphones_rooms_list

Room Phone — List Parameters:
ParameterTypeRequiredDefaultDescription
parent_idintegerYesThe room’s id.

dialpad_organization_numbers_assign_office_number_post

Dialpad Number — Assign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.
area_codestringNoAn area code in which to find an available phone number for assignment.
numberstringNoA phone number to assign. (e164-formatted)
primarybooleanNoA boolean indicating whether this should become the primary phone number.

dialpad_organization_numbers_assign_room_number_post

Dialpad Number — Assign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe room’s id.
area_codestringNoAn area code in which to find an available phone number for assignment.
numberstringNoA phone number to assign. (e164-formatted)
primarybooleanNoA boolean indicating whether this should become the primary phone number.

dialpad_organization_numbers_office_unassign_number_post

Dialpad Number — Unassign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.
numberstringYesA phone number to unassign. (e164-formatted)

dialpad_organization_numbers_room_unassign_number_post

Dialpad Number — Unassign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe room’s id.
numberstringYesA phone number to unassign. (e164-formatted)

dialpad_organization_offices_create

Office — Create Parameters:
ParameterTypeRequiredDefaultDescription
annual_commit_monthly_billingbooleanYesA flag indicating if the primary office’s plan is categorized as annual commit monthly billing.
auto_call_recordingbooleanNoWhether or not automatically record all calls of this office. Default is False.
billing_addressobjectYesBilling Address
billing_contactobjectNoBilling Contact
countrystringYesThe office country.
currencystringYesThe office’s billing currency.
e911_addressobjectNoE911 Address
first_actionstringNoThe desired action when the office receives a call.
friday_hoursstring[]NoThe Friday hours of operation. Default value is [“08:00”, “18:00”].
group_descriptionstringNoThe description of the office. Max 256 characters.
hours_onbooleanNoThe time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7).
international_enabledbooleanNoA flag indicating if the primary office is able to make international phone calls.
invoicedbooleanYesA flag indicating if the payment will be paid by invoice.
mainline_numberstringNoThe mainline of the office.
monday_hoursstring[]NoThe 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”].
namestringYes[single-line only] The office name.
no_operators_actionstringNoThe action to take if there is no one available to answer calls.
plan_periodstringYesThe frequency at which the company will be billed.
ring_secondsintegerNoThe number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds.
routing_optionsobjectNoRouting Options
saturday_hoursstring[]NoThe Saturday hours of operation. Default is empty array.
sunday_hoursstring[]NoThe Sunday hours of operation. Default is empty array.
thursday_hoursstring[]NoThe Thursday hours of operation. Default value is [“08:00”, “18:00”].
timezonestringNoTimezone using a tz database name.
tuesday_hoursstring[]NoThe Tuesday hours of operation. Default value is [“08:00”, “18:00”].
unified_billingbooleanYesA flag indicating if to send a unified invoice.
use_same_addressbooleanNoA flag indicating if the billing address and the emergency address are the same.
voice_intelligenceobjectNoVoice Intelligence
wednesday_hoursstring[]NoThe Wednesday hours of operation. Default value is [“08:00”, “18:00”].

dialpad_organization_offices_e911_get

E911 Address — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.

dialpad_organization_offices_e911_update

E911 Address — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.
addressstringYes[single-line only] Line 1 of the new E911 address.
address2stringNo[single-line only] Line 2 of the new E911 address.
citystringYes[single-line only] City of the new E911 address.
countrystringYesCountry of the new E911 address.
statestringYes[single-line only] State or Province of the new E911 address.
update_allbooleanNoUpdate E911 for all users in this office.
use_validated_optionbooleanNoWhether to use the validated address option from our service.
zipstringYes[single-line only] Zip code of the new E911 address.

dialpad_organization_offices_get

Office — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.

dialpad_organization_offices_list

Office — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
active_onlybooleanNoWhether we only return active offices.

dialpad_organization_offices_offdutystatuses_get

Off-Duty Status — List Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.

dialpad_organization_offices_operators_delete

Operator — Remove Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s ID.
operator_idintegerYesID of the operator to remove.
operator_typestringYesType of the operator to remove (user or room).

dialpad_organization_offices_operators_get

Operator — List Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.

dialpad_organization_offices_operators_post

Operator — Add Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s ID.
operator_idintegerYesID of the operator to add.
operator_typestringYesType of the operator to add. (user or room)
rolestringNoThe role of the new operator. (operator or admin)

dialpad_organization_offices_primary_get

Office — Get Primary

dialpad_organization_offices_update

Office — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe office’s id.
friday_hoursstring[]NoThe Friday hours of operation. Default value is [“08:00”, “18:00”].
hours_onbooleanNoThe 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_hoursstring[]NoThe 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_hoursstring[]NoThe Saturday hours of operation. Default is empty array.
sunday_hoursstring[]NoThe Sunday hours of operation. Default is empty array.
thursday_hoursstring[]NoThe Thursday hours of operation. Default value is [“08:00”, “18:00”].
tuesday_hoursstring[]NoThe Tuesday hours of operation. Default value is [“08:00”, “18:00”].
wednesday_hoursstring[]NoThe Wednesday hours of operation. Default value is [“08:00”, “18:00”].

dialpad_organization_plan_available_licenses_get

Licenses — List Available Parameters:
ParameterTypeRequiredDefaultDescription
office_idintegerYesThe office’s id.

dialpad_organization_plan_get

Billing Plan — Get Parameters:
ParameterTypeRequiredDefaultDescription
office_idintegerYesThe office’s id.

dialpad_organization_rooms_delete

Room — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe room’s id.

dialpad_organization_rooms_get

Room — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe room’s id.

dialpad_organization_rooms_list

Room — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
office_idintegerNoThe office’s id.

dialpad_organization_rooms_patch

Room — Update Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe room’s id.
namestringNo[single-line only] The name of the room.
phone_numbersstring[]NoA 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:
ParameterTypeRequiredDefaultDescription
namestringYes[single-line only] The name of the room.
office_idintegerYesThe office in which this room resides.