分配SIP中继配置

PATCH

/accounts/{accountId}/sip_trunk/settings

使用此API复制主帐户上应用的会话初始协议 (SIP) 连接的音频配置，并在子帐户上启用或禁用这些配置。

使用SIP连接的音频，Zoom建立 SIP trunk (专门用于拨打和拨打电话的网络连接) 通过客户网络和Zoom云之间的直接私有连接。拨入会议或让会议呼叫他们的会议参与者，并且从客户的IP电话网络的角度来看是在网上的，将通过此中继而不是通过PSTN连接。

** 先决条件: **

Pro或更高的帐户与SIP连接的音频计划启用。

主帐户所有者

** 范围: ** 'sip_trunk:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Light'

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Body 参数application/json

enable

boolean

可选

分配或删除SIP配置:

'true'-将主帐户的SIP配置信息分配给子帐户。

'false'-删除子帐户的分配的SIP配置。

如果您 * * 不 * * 查询该参数，API * * 不会 * * 修改子账号的配置。

示例值:

true

enable_all_settings_from_master_account

boolean

可选

是否将主账号的SIP trunk配置复制到子账号:

'true'-复制并 ** 覆盖 ** 子账户的当前配置与主账户的配置。

'false'-如果子帐户的SIP trunk配置存在，请勿 ** 覆盖它。

如果不传递此参数，API将不会克隆主帐户的SIP中继配置。

示例值:

true

show_callout_internal_number

boolean

可选

如果此选项的值设置为 “true”，zoom运营商合作伙伴提供的呼叫号码将显示在Zoom Web门户和Zoom客户端中帐户的可用呼叫号码列表中。

示例值:

false

show_zoom_provided_numbers

enum<integer>

可选

如果此选项的值设置为 “0”，zoom提供的号码将显示在Zoom Web门户和Zoom客户端中帐户的可用呼叫和呼入号码列表中。

如果此选项的值设置为 “1”，则Zoom提供的数字将显示在Zoom Web门户中，但除非用户指定，否则不会使用。

如果此选项的值设置为 “2”，则将删除所有缩放提供的编号，并且仅使用内部编号 (由运营商合作伙伴提供)。

枚举值:

012

示例值:

show_zoom_provided_callout_countries

integer

可选

如果此选项的值设置为 “0”，将显示Zoom提供的呼叫国家列表 (https://support.zoom.us/hc/en-us/articles/200942859-使用-电话-呼叫) 在帐户的可用调出国家/地区列表中。

如果此选项的值设置为 “1”，则将从用户帐户中隐藏缩放提供的呼叫国家/地区。

如果此选项的值设置为 “2”，则将删除所有提供缩放的国家/地区，并且仅使用内部国家/地区 (由运营商合作伙伴提供)。

示例值:

示例

{
    "enable": true,
    "enable_all_settings_from_master_account": true,
    "show_callout_internal_number": false,
    "show_zoom_provided_numbers": 0,
    "show_zoom_provided_callout_countries": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'http://prod-cn.your-api-server.com/accounts//sip_trunk/settings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enable": true,
    "enable_all_settings_from_master_account": true,
    "show_callout_internal_number": false,
    "show_zoom_provided_numbers": 0,
    "show_zoom_provided_callout_countries": 0
}'

返回响应

🟢204** HTTP状态代码: ** '204' ** 无内容 ** 已成功分配配置。

application/json

Body

object {0}

示例

{}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '2100' 此子帐户没有sip中继计划。 ** 错误代码: ** '2' 克隆SIP中继设置的请求失败。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '2001' 此帐户不存在或不属于此主帐户。 此帐户不存在或不属于您。

修改于 2023-10-31 06:13:33

删除内部号码

获取SIP中继配置