PATCH /phone/setting_templates/{templateId}

Use this API to update or modify profile settings for the phone template. Template type includes User, Auto Receptionist, or Call Queue. After you've modified a template, click User Settings to set up settings for Call Handling, Desk Phone, and Others.

Scope:

Prerequisites:

  1. Business or Enterprise Account
  2. A Zoom Phone license
    Rate Limit Label: Light

Servers

Path parameters

Name Type Required Description
templateId String Yes

The Template ID.

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
profile Object No
profile.area_code String No

The area code from which the phone account was created.

profile.country String No

Name of the country where the template was created.

name String No

Specify the name of the template.

description String No

The description of the template.

policy Object No
policy.voicemail Object No
policy.voicemail.allow_transcription Boolean No

Allow voicemail transcription.

policy.voicemail.enable Boolean No

Allow current extension to access, receive, or share voicemail.

policy.auto_call_recording Object No
policy.auto_call_recording.recording_transcription Boolean No

Allow call recording transcription.

policy.auto_call_recording.recording_start_prompt Boolean No

Play a prompt to call participants when the recording has started.

policy.auto_call_recording.enable Boolean No

Automatic call recording.

policy.auto_call_recording.recording_calls String No

Values: inbound, outbound, both.

Valid values:

  • "both"
  • "inbound"
  • "outbound"
policy.ad_hoc_call_recording Object No
policy.ad_hoc_call_recording.recording_transcription Boolean No

Allow call recording transcription.

policy.ad_hoc_call_recording.recording_start_prompt Boolean No

Play a prompt to call participants when the recording has started.

policy.ad_hoc_call_recording.enable Boolean No

Allow current extension to record and save calls in the cloud.

policy.sms Object No
policy.sms.international_sms Boolean No

Whether or not SMS is international.

policy.sms.enable Boolean No

Allow user to send and receive messages.

user_settings Object No
user_settings.audio_prompt_language String No

Audio prompt language code.
American English: en-US
British English: en-GB
Español americano: es-US
Français canadien: fr-CA
Dansk: da-DK
Deutsch: de-DE
Español: es-ES
Français: fr-FR
Italiano: it-IT
Nederlands: nl-NL
Portugues portugal: pt-PT
Japanese: ja-JP
Korean: ko-KO
Portugues brasil: pt-BR
Chinese: zh-CN
Taiwanese: zh-TW

user_settings.desk_phone Object No
user_settings.desk_phone.pin_code String No

Pin code.

user_settings.hold_music String No

The value of this field can be either default or disable.

  • default: This means that the hold music can be set using the audio library.

  • disable: This means that the hold music is disabled.

Valid values:

  • "disable"
  • "default"
user_settings.block_calls_without_caller_id Boolean No

Block Calls without Caller ID.

user_settings.call_handling Object No
user_settings.call_handling.close_hours Object No
user_settings.call_handling.close_hours.max_wait_time String No

Maximum wait time, in seconds. Values:
15,20,25,30,35,40,45,50,55,60

Valid values:

  • "55"
  • "20"
  • "30"
  • "40"
  • "50"
  • "60"
  • "15"
  • "25"
  • "35"
  • "45"
user_settings.call_handling.close_hours.connect_to_operator Object No

Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.

user_settings.call_handling.close_hours.connect_to_operator.id String No

Extension ID of user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup. This ID is passed along with the type if the close_hour_action was not set with a value of 26.

user_settings.call_handling.close_hours.connect_to_operator.type String No

Values:
1-user,
2-callQueue,
3-autoReceptionist,
4-commonAreaPhone,
5-zoomRoom,
7-sharedLineGroup

Valid values:

  • "autoReceptionist"
  • "zoomRoom"
  • "callQueue"
  • "commonAreaPhone"
  • "user"
  • "sharedLineGroup"
user_settings.call_handling.close_hours.connect_to_operator.enable Boolean No

Enable connect to operator.

user_settings.call_handling.close_hours.close_hour_action Integer No

Action to take when a call is not answered:
0-Forward to voicemail;
1-Play a message, then disconnect;
9-Disconnect;
26-Forward to External Contacts;
50-Forward to another extension

Valid values:

  • 0
  • 1
  • 26
  • 9
  • 50
user_settings.call_handling.business_hours Object No
user_settings.call_handling.business_hours.connect_to_operator Object No

Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.

user_settings.call_handling.business_hours.connect_to_operator.id String No

Extension ID of user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup. This ID is passed along with the type if the close_hour_action was not set with a value of 26.

user_settings.call_handling.business_hours.connect_to_operator.type String No

Values:
1-user,
2-callQueue,
3-autoReceptionist,
4-commonAreaPhone,
5-zoomRoom,
7-sharedLineGroup

Valid values:

  • "autoReceptionist"
  • "zoomRoom"
  • "callQueue"
  • "commonAreaPhone"
  • "user"
  • "sharedLineGroup"
user_settings.call_handling.business_hours.connect_to_operator.enable Boolean No

Enable connect to operator.

user_settings.call_handling.business_hours.ring_type String No

Call Handling Ring Mode:
0-Simultaneous,
1-Sequential

Valid values:

  • "1"
  • "0"
user_settings.call_handling.business_hours.ringing_duration String No

Ringing Duration for Each Device, in seconds. Values:
15,20,25,30,35,40,45,50,55,60

Valid values:

  • "55"
  • "20"
  • "30"
  • "40"
  • "50"
  • "60"
  • "15"
  • "25"
  • "35"
  • "45"
user_settings.call_handling.business_hours.type Integer No

Values:
1-24 Hours, 7 Days a Week;
2-Custom Hours

Valid values:

  • 1
  • 2
user_settings.call_handling.business_hours.custom_hours[] Array No
user_settings.call_handling.business_hours.custom_hours[].to String No

Values:
hh:mm

user_settings.call_handling.business_hours.custom_hours[].type Integer No

Values:
1-24 Hours,
2-customized hours

Valid values:

  • 1
  • 2
user_settings.call_handling.business_hours.custom_hours[].weekday Integer No

Values: 1-7 sun-sat

Valid values:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
user_settings.call_handling.business_hours.custom_hours[].from String No

Values:
hh:mm

user_settings.call_handling.business_hours.business_hour_action Integer No

When a call is not answered:
0-Forward to voicemail;
1-Play a message, then disconnect;
9-Disconnect;
26-Forward to External Contacts;
50-Forward to another extension

Valid values:

  • 0
  • 1
  • 26
  • 9
  • 50

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.