Zoom API
  1. Phone
Zoom API
  • Accounts
    • List sub accounts
    • Create a sub account
    • Disassociate a sub account
    • Get sub account details
    • Get locked settings
    • Update locked settings
    • Get managed domains
    • Update options
    • Update the account owner
    • Get settings
    • Update settings
    • Delete virtual background files
    • Upload virtual background files
    • Get trusted domains
  • Billing
    • Get billing information
    • Update billing information
    • List billing invoices
    • Get invoice details
    • Get plan Information
    • Subscribe plans
    • Subscribe additional plan
    • Update an additional plan
    • Cancel additional plans
    • Update a base plan
    • Cancel a base plan
    • Get plan usage
    • Download an invoice file
  • Phone
    • Update BYOC settings
      PATCH
    • Set up a Zoom Phone account
      POST
    • Assign SIP trunks
      POST
    • Update SIP trunk details
      PATCH
    • Add BYOC phone numbers
      POST
    • Get account's call logs
      GET
    • List calling plans
      GET
    • Change main company number
      PUT
    • List phone numbers
      GET
    • Get phone number details
      GET
    • Update phone number details
      PATCH
    • Get call recordings
      GET
    • List setting templates
      GET
    • Add a setting template
      POST
    • Get setting template details
      GET
    • Update a setting template
      PATCH
    • List BYOC SIP trunks
      GET
    • List phone users
      GET
    • Get user's profile
      GET
    • Update user's profile
      PATCH
    • Get user's call logs
      GET
    • Delete a user's call log
      DELETE
    • Assign calling plan to a user
      POST
    • Unassign user's calling plan
      DELETE
    • Assign phone number to user
      POST
    • Unassign phone number
      DELETE
    • Get user's recordings
      GET
    • Get user's settings
      GET
    • Remove shared access
      DELETE
    • Update shared access
      PATCH
    • Set up shared access
      POST
    • Get user's voicemails
      GET
    • Delete a voicemail
      DELETE
  • Cloud Recording
    • List recordings of an account
    • List archived files
    • Delete meeting recordings
    • Get meeting recordings
    • List recording registrants
    • Create a recording registrant
    • Get registration questions
    • Update registration questions
    • Update registrant's status
    • Get meeting recording settings
    • Update meeting recording settings
    • Recover meeting recordings
    • Delete a meeting recording file
    • Recover a single recording
    • List all recordings
  • SIP Connected Audio
    • List internal call-out countries
    • Add internal call-out countries
    • Delete internal call-out country
    • List internal numbers
    • Add internal numbers
    • Delete an internal number
    • Delete all numbers
    • Assign numbers
    • Assign SIP trunk configuration
    • List SIP trunks
    • Assign SIP trunks
    • Delete a SIP trunk
    • List SIP trunk numbers
  • Users
    • Switch a user's account
    • List users
    • Create users
    • Check a user email
    • Get user's ZAK
    • Check a user's PM room
    • Delete a user
    • Get a user
    • Update a user
    • Delete user assistants
    • List user assistants
    • Add assistants
    • Delete a user assistant
    • Update a user's email
    • Update a user's password
    • Get user permissions
    • Upload a user's profile picture
    • Update a user's presence status
    • Delete user schedulers
    • List user schedulers
    • Delete a scheduler
    • Get user settings
    • Update user settings
    • Delete virtual background files
    • Upload virtual background files
    • Update user status
    • Revoke a user's SSO token
    • Get a user token
  • Chat Channels
    • Delete a channel
    • Get a channel
    • Update a channel
    • Leave a channel
    • Join a channel
    • Remove a member
    • List user's channels
    • Create a channel
  • Contacts
    • List user's contacts
    • Get user's contact details
    • Search company contacts
  • Chat Channels (Account-level)
    • Delete a channel
    • Get a channel
    • Update a channel
    • List channel members
    • Invite channel members
    • Remove a member
  • Chat Messages
    • List user's chat messages
    • Send a chat message
    • Delete a message
    • Update a message
  • Groups
    • List groups
    • Create a group
    • Delete a group
    • Get a group
    • Update a group
    • Get locked settings
    • Update locked settings
    • List group members
    • Add group members
    • Delete a group member
    • Update a group member
    • Get a group's settings
    • Update a group's settings
    • Delete virtual background files
    • Upload virtual background files
  • Devices
    • List H.323/SIP devices
    • Create a H.323/SIP device
    • Delete a H.323/SIP device
    • Update a H.323/SIP device
  • Chatbot Messages
    • Send chatbot messages
    • Delete a chatbot message
    • Edit a chatbot message
  • IM Chat
    • Get IM chat sessions
    • Get IM chat messages
    • Send IM messages
    • Get user’s IM messages
  • IM Groups
    • List IM directory groups
    • Create an IM directory group
    • Delete an IM directory group
    • Retrieve an IM directory group
    • Update an IM directory group
    • List IM directory group members
    • Add IM directory group members
    • Delete an IM directory group member
  • Meetings
    • Use in-Meeting recording controls
    • Delete a meeting
    • Get a meeting
    • Update a meeting
    • Perform batch poll creation
    • Get meeting invitation
    • Get live stream details
    • Update a live stream
    • Update Live Stream Status
    • List meeting polls
    • Create a meeting poll
    • Delete a meeting poll
    • Get a meeting poll
    • Update a meeting poll
    • List meeting registrants
    • Add meeting registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a meeting registrant
    • Update meeting status
    • List ended meeting instances
    • List past meeting's poll results
    • Get past meeting details
    • Get past meeting participants
    • List meeting templates
    • List meetings
    • Create a meeting
  • Dashboards
    • List Zoom meetings client feedback
    • Get zoom meetings client feedback
    • List client meeting satisfaction
    • Get CRC port usage
    • Get IM metrics
    • Get top 25 Zoom Rooms with issues
    • Get issues of Zoom Rooms
    • List meetings
    • Get meeting details
    • List meeting participants
    • List meeting participants QoS
    • Get post meeting feedback
    • Get sharing/recording details
    • Get meeting participant QoS
    • List webinars
    • Get webinar details
    • Get webinar participants
    • List webinar participant QoS
    • Get post webinar feedback
    • Get sharing/recording details
    • Get webinar participant QoS
    • List Zoom Rooms
    • Get top 25 issues of Zoom Rooms
    • Get Zoom Rooms details
    • List call logs
    • Get call QoS
    • Get call details from call log
  • Deprecated API Endpoints
    • List past meeting's files
    • List past webinar files
  • Webinars
    • Get webinar absentees
    • List past webinar instances
    • List webinar participants
    • List past webinar poll results
    • List Q&A of past webinar
    • List webinar templates
    • List webinars
    • Create a webinar
    • Delete a webinar
    • Get a webinar
    • Update a webinar
    • Perform batch registration
    • Remove panelists
    • List panelists
    • Add panelists
    • Remove a panelist
    • List a webinar's polls
    • Create a webinar's poll
    • Delete a webinar poll
    • Get a webinar poll
    • Update a webinar poll
    • List webinar registrants
    • Add a webinar registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a webinar registrant
    • Get a webinar registrant
    • Update webinar status
    • Get webinar tracking sources
  • Phone Auto Receptionists
    • Add an auto receptionist
    • Update auto receptionist details
    • Unassign all phone numbers
    • Assign phone numbers
    • Unassign a phone number
  • Phone Blocked List
    • List blocked lists
    • Create a blocked list
    • Delete a blocked list
    • Get blocked list details
    • Update a blocked list
  • Phone Call Queues
    • List call queues
    • Create a call queue
    • Delete a call queue
    • Get call queue details
    • Update call queue details
    • Change call queue manager
    • Unassign all members
    • Add members to a call queue
    • Unassign a member
    • Unassign all phone numbers
    • Assign numbers to a call queue
    • Unassign a phone number
    • Get call queue recordings
  • Common Area Phones
    • List common area phones
    • Add a common area phone
    • Delete a common area phone
    • Get common area phone details
    • Update common area phone
  • Phone Devices
    • List devices
    • Add a device
    • Delete a device
    • Get device details
    • Update a device
  • Phone Reports
    • Get operation logs report
  • Phone Shared Line Groups
    • List shared line groups
    • Create a shared line group
    • Delete a shared line group
    • Get a shared line group
    • Update a shared line group
    • Unassign members of a shared line group
    • Add members to a shared line group
    • Unassign a member from a shared line group
    • Assign phone numbers
    • Unassign a phone number
  • Phone Site
    • List phone sites
    • Create a phone site
    • Delete a phone site
    • Get phone site details
    • Update phone site details
  • Reports
    • Get sign In / sign out activity report
    • Get cloud recording usage report
    • Get daily usage report
    • Get meeting detail reports
    • Get meeting participant reports
    • Get meeting poll reports
    • Get operation logs report
    • Get telephone reports
    • Get active/inactive host reports
    • Get meeting reports
    • Get webinar detail reports
    • Get webinar participant reports
    • Get webinar poll reports
    • Get webinar Q&A report
  • Roles
    • List roles
    • Create a role
    • Delete a role
    • Get role information
    • Update role information
    • List members in a role
    • Assign a role
    • Unassign a role
  • Rooms
    • List Zoom Rooms
    • Add a Zoom Room
    • List digital signage contents
    • Update E911 digital signage
    • Check-in or check-out of a Zoom Room
    • Delete a Zoom Room
    • Get Zoom Room profile
    • Update a Zoom Room profile
    • List Zoom Room devices
    • Change a Zoom Room's location
    • Get Zoom Room settings
    • Update Zoom Room settings
  • Rooms Account
    • Get Zoom Room account profile
    • Update Zoom Room account profile
    • Get Zoom Room account settings
    • Update Zoom Room account settings
  • Rooms Location
    • List Zoom Room locations
    • Add a location
    • Get Zoom Room location structure
    • Update Zoom Rooms location structure
    • Get Zoom Room location profile
    • Update Zoom Room location profile
    • Change the assigned parent location
    • Get location settings
    • Update location settings
  • Rooms Devices
    • Change Zoom Rooms' app version
  • SIP Phone
    • List SIP phones
    • Enable SIP phone
    • Delete SIP phone
    • Update SIP phone
  • TrackingField
    • List tracking fields
    • Create a tracking field
    • Delete a tracking field
    • Get a tracking field
    • Update a tracking field
  • TSP
    • Get account's TSP information
    • Update account's TSP information
    • List user's TSP accounts
    • Add a user's TSP account
    • Set global dial-in URL for a TSP user
    • Delete a user's TSP account
    • Get a user's TSP account
    • Update a TSP account
  • PAC
    • List a user's PAC accounts
  • Data Compliance
  • Webhooks
  • master account APIs
  1. Phone

Get setting template details

GET
/phone/setting_templates/{templateId}
Phone
This API lets you retrieve a specific account phone template previously created.
Scope:
phone:write:admin or phone:write
Prerequisites:
1.
Business or Enterprise Account
2.
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.
id
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> 
可选
The value of this field can be either default or disable.
default: This means that the hold music can be set using the audio library.
disable: This means that the hold music is disabled.
枚举值:
defaultdisable
🟠401**HTTP Status Code:** `401`<br> **Error Code:** `124`<br> Account does not exist: {accountId}.
🟠404**HTTP Status Code:** `404`<br> Site does not exist. Settings template does not exist: {templateId}.

【Zoom】API开发者 微信交流群

用微信扫右侧二维码，加入【Zoom】API开发者 交流群，互助沟通

扫码加入交流群
上一页
Add a setting template
下一页
Update a setting template
Built with