action zoom_get_setting_template {
label: "Get setting template details"
description: "This API lets you retrieve a specific account phone template previously created.
\n\n**Scope**:
\n* `phone:write:admin` or `phone:write`\n\n**Prerequisites**:
\n1. Business or Enterprise Account\n2. A Zoom Phone license\n
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
\n\n"
provider: zoom
method: GET
path: "/phone/setting_templates/{templateId}"
encoding: json
input: {
type: "object"
properties: {
custom_query_fields: {
type: "string"
}
templateId: {
type: "string"
}
}
required: ["templateId"]
additionalProperties: false
}
output: {
type: "object"
properties: {
description: {
type: "string"
description: "The description of the template."
}
id: {
type: "string"
description: "Specify the template ID."
}
name: {
type: "string"
description: "Specify the name of the template."
}
policy: {
type: "object"
properties: {
ad_hoc_call_recording: {
type: "object"
properties: {
enable: {
type: "boolean"
description: "Allow current extension to record and save calls in the cloud."
}
recording_start_prompt: {
type: "boolean"
description: "Play a prompt to call participants when the recording has started."
}
recording_transcription: {
type: "boolean"
description: "Allow call recording transcription."
}
}
}
auto_call_recording: {
type: "object"
properties: {
enable: {
type: "boolean"
description: "Enable automatic call recording."
}
recording_calls: {
type: "string"
description: "Values: inbound, outbound, both."
}
recording_start_prompt: {
type: "boolean"
description: "Play a prompt to call participants when the recording has started."
}
recording_transcription: {
type: "boolean"
description: "Allow call recording transcription."
}
}
}
sms: {
type: "object"
properties: {
enable: {
type: "boolean"
description: "Allow user to send and receive messages."
}
international_sms: {
type: "boolean"
}
}
}
voicemail: {
type: "object"
properties: {
allow_transcription: {
type: "boolean"
description: "Allow voicemail transcription."
}
enable: {
type: "boolean"
description: "Allow current extension to access, receive, or share voicemail."
}
}
}
}
}
profile: {
type: "object"
properties: {
area_code: {
type: "string"
description: "The area code from which the phone account was created."
}
country: {
type: "string"
description: "Name of the country where the template was created."
}
}
}
type: {
type: "string"
description: "The type of template being queried. Values: `user`, `group`, `auto receptionist` `common area`,`zr`, `interop`."
enum: ["user", "group", "autoReceptionist", "commonArea", "zr", "interop"]
}
user_settings: {
type: "object"
properties: {
audio_prompt_language: {
type: "string"
description: "Audio prompt language code.
American English: `en-US`
\nBritish English: `en-GB`
\nEspañol americano: `es-US`
\nFrançais canadien: `fr-CA`
\nDansk: `da-DK`
\nDeutsch: `de-DE`
\nEspañol: `es-ES`
\nFrançais: `fr-FR`
\nItaliano: `it-IT`
\nNederlands: `nl-NL`
\nPortugues portugal: `pt-PT`
\nJapanese: `ja-JP`
\nKorean: `ko-KO`
\nPortugues brasil: `pt-BR`
\nChinese: `zh-CN`
\nTaiwanese: `zh-TW`
"
}
block_calls_without_caller_id: {
type: "boolean"
description: "Block Calls without Caller ID."
}
call_handling: {
type: "object"
properties: {
business_hours: {
type: "object"
properties: {
business_hour_action: {
type: "integer"
description: "When a call is not answered:
\n0-Forward to voicemail;
\n1-Play a message, then disconnect;
\n9-Disconnect;
\n26-Forward to External Contacts;
\n50-Forward to another extension"
enum: [0, 1, 9, 26, 50]
}
connect_to_operator: {
type: "object"
description: "Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options."
properties: {
enable: {
type: "boolean"
description: "Enable connect to operator."
}
id: {
type: "string"
description: "Phone extension ID of the user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup."
}
type: {
type: "string"
description: "Values:
\n1-user,
\n2-callQueue,
\n3-autoReceptionist,
\n4-commonAreaPhone,
\n5-zoomRoom,
\n7-sharedLineGroup"
enum: ["user", "zoomRoom", "commonAreaPhone", "autoReceptionist", "callQueue", "sharedLineGroup"]
}
}
}
custom_hours: {
type: "array"
items: {
type: "object"
properties: {
from: {
type: "string"
format: "time"
description: "Values:
\nhh:mm"
}
to: {
type: "string"
format: "time"
description: "Values:
\nhh:mm"
}
type: {
type: "integer"
description: "Values:
\n1-24 Hours,
\n2-customized hours"
enum: [1, 2]
}
weekday: {
type: "integer"
description: "Values: 1-7 sun-sat"
enum: [1, 2, 3, 4, 5, 6, 7]
}
}
}
}
ring_type: {
type: "string"
description: "Call Handling Ring Mode:
\n0-Simultaneous,
\n1-Sequential"
enum: [0, 1]
}
ringing_duration: {
type: "string"
description: "Ringing Duration for Each Device in seconds. Values:
\n15,20,25,30,35,40,45,50,55,60"
enum: [15, 20, 25, 30, 35, 40, 45, 50, 55, 60]
}
type: {
type: "integer"
description: "Values:
\n1-24 Hours, 7 Days a Week;
\n2-Custom Hours"
enum: [1, 2]
}
}
}
close_hours: {
type: "object"
properties: {
close_hour_action: {
type: "integer"
description: "Action to take when a call is not answered:
\n0-Forward to voicemail;
\n1-Play a message, then disconnect;
\n9-Disconnect;
\n26-Forward to External Contacts;
\n50-Forward to another extension\n"
enum: [0, 1, 9, 26, 50]
}
connect_to_operator: {
type: "object"
description: "Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options."
properties: {
enable: {
type: "boolean"
}
id: {
type: "string"
description: "Phone extension ID of the user, zoomRoom, commonAreaPhone, autoReceptionist, callQueue or sharedLineGroup."
}
type: {
type: "string"
description: "Values:
\n1-user,
\n2-callQueue,
\n3-autoReceptionist,
\n4-commonAreaPhone,
\n5-zoomRoom,
\n7-sharedLineGroup"
enum: ["user", "zoomRoom", "commonAreaPhone", "autoReceptionist", "callQueue", "sharedLineGroup"]
}
}
}
max_wait_time: {
type: "string"
description: "Max Wait Time in seconds. Values:
\n15,20,25,30,35,40,45,50,55,60"
enum: [15, 20, 25, 30, 35, 40, 45, 50, 55, 60]
}
}
}
}
}
desk_phone: {
type: "object"
properties: {
pin_code: {
type: "string"
description: "Pin code."
}
}
}
hold_music: {
type: "string"
description: "The value of this field can be either `default` or `disable`.\n\n* `default`: This means that the hold music can be set using the [audio library](https://support.zoom.us/hc/en-us/articles/360028212652-Using-the-audio-library-to-customize-greetings-and-hold-music).\n\n* `disable`: This means that the hold music is disabled."
enum: ["default", "disable"]
}
}
}
}
}
}