列出内部号码

让具有SIP Connected Audio计划的主帐户列出内部电话号码-Zoom未提供但由使用API的组织拥有的号码-分配给主帐户或一个子账户。

要列出子账户的内部编号，请在 “accountid” 路径参数中提供子账户的账户ID。要列出主帐户的内部编号，请提供 “我” 作为 “accountid” 路径参数的值。

** 先决条件 **

发出此API请求的帐户必须是具有SIP连接音频计划的主帐户。

** 范围: ** 'sip_trunk:master'，' sip_trunk:read:master'，'sip_trunk:write:master'

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

page_size

integer

可选

单个API调用中返回的记录数。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

返回响应

🟢200** HTTP状态码: ** '200' ** 确定 ** 返回的内部号码列表。

application/json

Body

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

返回的记录总数。

可选

示例值:

internal_numbers

array [object {11}]

可选

country

string

必需

国家的两个字母 [ISO国家代码](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 国家)。

示例值:

number

string

必需

E164格式的电话号码。

示例值:

+1 646666111

assigned_accounts

array [object {3}]

可选

将当前内部编号分配给此帐户列表。

allow_join

boolean

可选

指定用户是否可以使用此号码加入会议。

“真”-此号码可用于加入会议。

'false'-此号码 ** 不能 ** 用于加入会议。

如果 “visible” 字段的值设置为 “true”，则该字段的值将始终为 “true”。

示例值:

true

visible

boolean

可选

指定是否希望此号码对Zoom客户端和Zoom Portal中的帐户用户可见。

“真”-使数字可见。

'false'-隐藏号码。

示例值:

true

languages

enum<string>

必需

电话号码的显示语言。

“En-gb”-英语 (英国)

“en-us”-英语 (美国)

'ar'-阿拉伯语

“Da-dk”-丹麦语 (丹麦)

“de-de”-德语

“Es-es”-西班牙语

“es-mx”-西班牙语 (墨西哥)

“Fr-ca”-法语 (加拿大)

'Fr-fr'-法语

'it-IT'-意大利语

'ja'-日语

'Ko-kr'-韩语

“nl-nl”-荷兰语 (荷兰)

'Pt-br'-葡萄牙语 (巴西)

'Pt-pt'-葡萄牙语

'ru'-俄语

'Zh-cn'-中文 (中华人民共和国)

'Zh-hk'-中文 (香港)

枚举值:

en-GBen-USarda-DKde-DEes-ESes-MXfr-CAfr-FRit-ITjako-KRnl-NLpt-BRpt-PTruzh-CNzh-HK

示例值:

en-US

display_number

string

必需

显示格式的电话号码。如果数字字段的值是 “1888888000”，则该字段的值可以是 “1 888 888 000”。

示例值:

+1 646 666 1110

string

可选

内部编号的唯一标识符。

示例值:

1bj75491Sqa1gmyN6L47ew

type

enum<integer>

必需

电话号码的类型。

'0'-收费

'1'-免费收费

枚举值:

示例值:

allow_for_external_meetings

boolean

可选

控制该号码是否可用于参加第三方会议。

示例值:

true

labels

string

必需

电话号码的简短描述。

示例值:

SIP-Internal

page_size

integer

可选

您指定要在每页响应中获取的记录数。

默认值:

示例值:

示例

{
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 20,
    "internal_numbers": [
        {
            "country": "US",
            "number": "+1 646666111",
            "assigned_accounts": [
                {
                    "name": "jchill",
                    "id": "Mt6sv4u0TAyPkwgsL2lxiA",
                    "type": 1
                }
            ],
            "allow_join": true,
            "visible": true,
            "languages": "en-GB",
            "display_number": "+1 646 666 1110",
            "id": "1bj75491Sqa1gmyN6L47ew",
            "type": 0,
            "allow_for_external_meetings": true,
            "labels": "SIP-Internal"
        }
    ],
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '300' * 您的帐户没有在此帐户上进行更新的权限。只有主账户才能对子账户执行此操作。 * 请求失败，因为此帐户未在SIP Connected Audio计划中注册。 * 此帐户不是主帐户。要访问此API，你的账户必须在API合作伙伴计划中注册，并且必须是主账户。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '2001' 帐户不存在: {0}。

请求参数

示例代码

返回响应