Zoom Public API Documentation
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: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:setting_template:adminLight
Body
PARAM
| 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": "<string>",
"id": "<string>",
"name": "<string>",
"policy": {
"ad_hoc_call_recording": {
"enable": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>"
},
"auto_call_recording": {
"enable": "<boolean>",
"recording_calls": "<string>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>"
},
"sms": {
"enable": "<boolean>",
"international_sms": "<boolean>"
},
"voicemail": {
"allow_transcription": "<boolean>",
"enable": "<boolean>"
},
"call_forwarding": {
"enable": "<boolean>",
"call_forwarding_type": 3
},
"call_overflow": {
"enable": "<boolean>",
"call_overflow_type": 2
}
},
"profile": {
"area_code": "<string>",
"country": "<string>"
},
"type": "commonArea",
"user_settings": {
"audio_prompt_language": "<string>",
"block_calls_without_caller_id": "<boolean>",
"call_handling": {
"business_hours": {
"business_hour_action": 1,
"connect_to_operator": {
"enable": "<boolean>",
"id": "<string>",
"type": "zoomRoom",
"external_number": {
"number": "<string>",
"description": "<string>"
},
"play_callee_voicemail_greeting": "<boolean>",
"require_press_1_before_connecting": "<boolean>",
"allow_caller_check_voicemail": "<boolean>"
},
"busy_action": 0,
"busy_connect_operator": {
"enable": "<boolean>",
"id": "<string>",
"type": "autoReceptionist",
"external_number": {
"number": "<string>",
"description": "<string>"
},
"play_callee_voicemail_greeting": "<boolean>",
"require_press_1_before_connecting": "<boolean>",
"allow_caller_check_voicemail": "<boolean>"
},
"custom_hours": [
{
"from": "<time>",
"to": "<time>",
"type": 2,
"weekday": 4
},
{
"from": "<time>",
"to": "<time>",
"type": 2,
"weekday": 7
}
],
"ring_type": "<string>",
"ringing_duration": "45",
"type": 2
},
"close_hours": {
"close_hour_action": 1,
"connect_to_operator": {
"enable": "<boolean>",
"id": "<string>",
"type": "callQueue",
"external_number": {
"number": "<string>",
"description": "<string>"
},
"play_callee_voicemail_greeting": "<boolean>",
"require_press_1_before_connecting": "<boolean>",
"allow_caller_check_voicemail": "<boolean>"
},
"busy_action": 12,
"busy_connect_operator": {
"enable": "<boolean>",
"id": "<string>",
"type": "autoReceptionist",
"external_number": {
"number": "<string>",
"description": "<string>"
},
"play_callee_voicemail_greeting": "<boolean>",
"require_press_1_before_connecting": "<boolean>",
"allow_caller_check_voicemail": "<boolean>"
},
"max_wait_time": "35"
}
},
"desk_phone": {
"pin_code": "<string>"
},
"hold_music": "disable"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/setting_templates/:templateId?custom_query_fields=<string>?custom_query_fields=<string>' -H 'Accept: application/json'
ENDPOINTS