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:
phone:write:adminorphone:write
Prerequisites:
- Business or Enterprise Account
- A Zoom Phone license
Rate Limit Label:Light
Servers
- https://api.zoom.us/v2
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:
|
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. |
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
Valid values:
|
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: Valid values:
|
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 |
user_settings.call_handling.close_hours.connect_to_operator.type |
String | No |
Values: Valid values:
|
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: Valid values:
|
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 |
user_settings.call_handling.business_hours.connect_to_operator.type |
String | No |
Values: Valid values:
|
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: Valid values:
|
user_settings.call_handling.business_hours.ringing_duration |
String | No |
Ringing Duration for Each Device, in seconds. Values: Valid values:
|
user_settings.call_handling.business_hours.type |
Integer | No |
Values: Valid values:
|
user_settings.call_handling.business_hours.custom_hours[] |
Array | No | |
user_settings.call_handling.business_hours.custom_hours[].to |
String | No |
Values: |
user_settings.call_handling.business_hours.custom_hours[].type |
Integer | No |
Values: Valid values:
|
user_settings.call_handling.business_hours.custom_hours[].weekday |
Integer | No |
Values: 1-7 sun-sat Valid values:
|
user_settings.call_handling.business_hours.custom_hours[].from |
String | No |
Values: |
user_settings.call_handling.business_hours.business_hour_action |
Integer | No |
When a call is not answered: Valid values:
|
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.