Zoom Public API Documentation
Get setting template details
GET {{baseUrl}}/phone/setting_templates/:templateId?custom_query_fields=voicemail
Use this API to return information about an account's phone template. Scopes: Prerequisites:
* A Business or Enterprise account
* A Zoom Phone licensephone:write:admin or phone:write
Rate Limit Label: Light
Body
PARAM
| Key | Datatype | Required | Description |
custom_query_fields
|
string | Provide 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": "Main site user template",
"id": "2kFqiqSlS5udzWB5QqMiNg",
"name": "user template",
"policy": {
"ad_hoc_call_recording": {
"enable": true,
"recording_start_prompt": true,
"recording_transcription": true
},
"auto_call_recording": {
"enable": true,
"recording_calls": "inbound",
"recording_start_prompt": true,
"recording_transcription": true
},
"sms": {
"enable": true,
"international_sms": true
},
"voicemail": {
"allow_transcription": true,
"enable": true
}
},
"profile": {
"area_code": "1",
"country": "US"
},
"type": "user",
"user_settings": {
"audio_prompt_language": "en-US",
"block_calls_without_caller_id": false,
"call_handling": {
"business_hours": {
"business_hour_action": 50,
"connect_to_operator": {
"enable": true,
"id": "fWOgOALdT1ei4vjXK-QYsA",
"type": "user"
},
"custom_hours": [
{
"from": "11:51:39.547Z",
"to": "15:16:23.674Z",
"type": 2,
"weekday": 2
},
{
"from": "12:12:47.111Z",
"to": "01:51:37.844Z",
"type": 2,
"weekday": 2
}
],
"ring_type": "simultaneous",
"ringing_duration": "60",
"type": 2
},
"close_hours": {
"close_hour_action": 50,
"connect_to_operator": {
"enable": true,
"id": "fWOgOALdT1ei4vjXK-QYsA",
"type": "user"
},
"max_wait_time": "30"
}
},
"desk_phone": {
"pin_code": "0995"
},
"hold_music": "default"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/setting_templates/:templateId?custom_query_fields=voicemail?custom_query_fields=voicemail' -H 'Accept: application/json'
ENDPOINTS