Get setting template details
GET {{baseUrl}}/phone/setting_templates/:templateId?custom_query_fields=<string>
Returns information about an account's phone template.
Prerequisites:
- A Business or Enterprise account
- A Zoom Phone license
Scopes:
phone:read:admin
Granular Scopes:
phone:read:setting_template:admin
Rate Limit Label
:
Light
Request Params
| Key | Datatype | Required | Description |
| custom_query_fields
| string | | This field provides the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {“description”: “template description”}. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"description":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","policy":{"ad_hoc_call_recording":{"enable":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e"},"auto_call_recording":{"enable":"\u003cboolean\u003e","recording_calls":"\u003cstring\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e"},"sms":{"enable":"\u003cboolean\u003e","international_sms":"\u003cboolean\u003e"},"voicemail":{"allow_transcription":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"call_forwarding":{"enable":"\u003cboolean\u003e","call_forwarding_type":3},"call_overflow":{"enable":"\u003cboolean\u003e","call_overflow_type":2}},"profile":{"area_code":"\u003cstring\u003e","country":"\u003cstring\u003e"},"type":"commonArea","user_settings":{"audio_prompt_language":"\u003cstring\u003e","block_calls_without_caller_id":"\u003cboolean\u003e","call_handling":{"business_hours":{"business_hour_action":1,"connect_to_operator":{"enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","type":"zoomRoom","external_number":{"number":"\u003cstring\u003e","description":"\u003cstring\u003e"},"play_callee_voicemail_greeting":"\u003cboolean\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","allow_caller_check_voicemail":"\u003cboolean\u003e"},"busy_action":0,"busy_connect_operator":{"enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","type":"autoReceptionist","external_number":{"number":"\u003cstring\u003e","description":"\u003cstring\u003e"},"play_callee_voicemail_greeting":"\u003cboolean\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","allow_caller_check_voicemail":"\u003cboolean\u003e"},"custom_hours":[{"from":"\u003ctime\u003e","to":"\u003ctime\u003e","type":2,"weekday":4},{"from":"\u003ctime\u003e","to":"\u003ctime\u003e","type":2,"weekday":7}],"ring_type":"\u003cstring\u003e","ringing_duration":"45","type":2},"close_hours":{"close_hour_action":1,"connect_to_operator":{"enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","type":"callQueue","external_number":{"number":"\u003cstring\u003e","description":"\u003cstring\u003e"},"play_callee_voicemail_greeting":"\u003cboolean\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","allow_caller_check_voicemail":"\u003cboolean\u003e"},"busy_action":12,"busy_connect_operator":{"enable":"\u003cboolean\u003e","id":"\u003cstring\u003e","type":"autoReceptionist","external_number":{"number":"\u003cstring\u003e","description":"\u003cstring\u003e"},"play_callee_voicemail_greeting":"\u003cboolean\u003e","require_press_1_before_connecting":"\u003cboolean\u003e","allow_caller_check_voicemail":"\u003cboolean\u003e"},"max_wait_time":"35"}},"desk_phone":{"pin_code":"\u003cstring\u003e"},"hold_music":"disable"}}