Get setting template details

GET

/phone/setting_templates/{templateId}

This API lets you retrieve a specific account phone template previously created.

Scope:

phone:write:admin or phone:write

Prerequisites:

Business or Enterprise Account

A Zoom Phone license

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/setting_templates/'

响应示例

200 - response

{
    "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"
        }
    },
    "profile": {
        "area_code": "string",
        "country": "string"
    },
    "type": "string",
    "user_settings": {
        "audio_prompt_language": "string",
        "block_calls_without_caller_id": "boolean",
        "call_handling": {
            "business_hours": {
                "business_hour_action": "integer",
                "connect_to_operator": {
                    "enable": "boolean",
                    "id": "string",
                    "type": "string"
                },
                "custom_hours": [
                    {
                        "from": "string",
                        "to": "string",
                        "type": "integer",
                        "weekday": "integer"
                    }
                ],
                "ring_type": "string",
                "ringing_duration": "string",
                "type": "integer"
            },
            "close_hours": {
                "close_hour_action": "integer",
                "connect_to_operator": {
                    "enable": "boolean",
                    "id": "string",
                    "type": "string"
                },
                "max_wait_time": "string"
            }
        },
        "desk_phone": {
            "pin_code": "string"
        },
        "hold_music": "string"
    }
}

请求参数

Path 参数

templateId

string

必需

Unique identifier of the template.

Query 参数

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”}.

返回响应

🟢200**HTTP Status Code:** `200`<br> OK

application/json

Body

description

string

可选

The description of the template.

string

可选

Specify the template ID.

name

string

可选

Specify the name of the template.

policy

object

可选

ad_hoc_call_recording

object

可选

auto_call_recording

object

可选

sms

object

可选

voicemail

object

可选

profile

object

可选

area_code

string

可选

The area code from which the phone account was created.

country

string

可选

Name of the country where the template was created.

type

enum<string>

可选

The type of template being queried. Values: user, group, auto receptionist common area,zr, interop.

枚举值:

usergroupautoReceptionistcommonAreazrinterop

user_settings

object

可选

audio_prompt_language

string

可选

Audio prompt language code.
American English: en-US

British English: en-GB

Español americano: es-US

Français canadien: fr-CA

Dansk: da-DK

Deutsch: de-DE

Español: es-ES

Français: fr-FR

Italiano: it-IT

Nederlands: nl-NL

Portugues portugal: pt-PT

Japanese: ja-JP

Korean: ko-KO

Portugues brasil: pt-BR

Chinese: zh-CN

Taiwanese: zh-TW

block_calls_without_caller_id

boolean

可选

Block Calls without Caller ID.

call_handling

object

可选

desk_phone

object

可选

hold_music

enum<string>