List setting templates

This API lets you retrieve a list of all the phone template settings previously created.

Scope:

phone:read:admin or phone:read

Prerequisites:

Business or enterprise Account

A Zoom Phone license

Rate Limit Label: Light

{ "next_page_token": "3", "page_size": "30", "templates": [ { "description": "string", "id": "12345", "name": "namename", "type": "2" } ], "total_records": "200" }

请求参数

Query 参数

page_size

integer

可选

Number of records returns within a single API call.

<= 300

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

site_id

string

可选

Unique identifier of the site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See Managing multiple sites for details. If this is not provided, the response lists the account level setting templates.

返回响应

🟢200**HTTP Status Code:** `200` OK

application/json

Body

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call. The default is 30 and the maximum is 300.

templates

array [object {4}]

可选

description

string

可选

Template description.

string

可选

Unique identifier of the template.

name

string

可选

Template name.

type

enum<string>

可选

Template type.

The value of this field can be one of the following:

user

group

autReceptionist

commonArea

zr

interop

枚举值:

usergroupautReceptionistcommonAreazrinterop

total_records

integer

可选

The total number of records returned.

🟠400**HTTP Response Code:** `400` **Error Code:** `300` Multiple Sites option has been disabled. Enable it and try again.

🟠401**HTTP Status Code:** `401` **Error Code:** `124` Account does not exist: {accountId}.

🟠404**HTTP Status Code:** `404` Site does not exist.