Zoom API 中文版
  1. SIP Connected Audio
Zoom API 中文版
  • 说明
  • Meetings
    • 获取会议投票
      GET
    • 删除会议投票
      DELETE
    • 更新会议投票
      PUT
    • 更新livestream
      PATCH
    • 获取livestream详细信息
      GET
    • 创建会议
      POST
    • 列出会议
      GET
    • 获取会议注册人
      GET
    • 删除会议注册人
      DELETE
    • 执行批量注册
      POST
    • 更新注册问题
      PATCH
    • 列出登记问题
      GET
    • 获取会议的令牌
      GET
    • 更新会议调查
      PATCH
    • 获取会议调查
      GET
    • 删除会议调查
      DELETE
    • 使用会议中控件
      PATCH
    • 列出过去的会议实例
      GET
    • 更新会议状态
      PUT
    • 获取会议邀请
      GET
    • 从现有会议创建会议模板
      POST
    • 列出会议模板
      GET
    • 更新注册人的状态
      PUT
    • 创建会议的邀请链接
      POST
    • 执行批量轮询创建
      POST
    • 更新会议
      PATCH
    • 得到一个会议
      GET
    • 删除会议
      DELETE
    • 更新实时流状态
      PATCH
    • 添加会议注册人
      POST
    • 列出会议注册人
      GET
    • 创建会议投票
      POST
    • 列出会议投票
      GET
  • Billing
    • 列出开票发票
    • 列出即将续订的帐户
    • 生成子帐户的开单发票报告
    • 列出子帐户的开单发票报表
    • 订阅计划的帐户
    • 获取客户计划信息
    • 获取发票详细信息
    • 取消基本计划
    • 订阅额外计划的帐户
    • 更新帐户的附加计划
    • 更新帐单信息
    • 获取账单信息
    • 下载子帐户的帐单发票报告
    • 删除子帐户的开单发票报表
    • 更新基本计划
    • 获取计划使用情况
    • 下载发票文件
    • 取消其他计划
  • SIP Phone
    • 启用SIP电话
    • 列出SIP电话
    • 更新SIP电话
    • 删除SIP电话
  • Users
    • 获取协作设备详细信息
    • 添加助理
    • 列出用户助理
    • 删除用户助理
    • 获取用户的令牌
    • 撤销用户的SSO令牌
    • 切换用户的帐户
    • 删除用户助理
    • 列出用户的协作设备
    • 更新用户的密码
    • 上传用户的个人资料图片
    • 删除用户的个人资料图片
    • 更新用户状态
    • 批量更新功能
    • 创建用户
    • 列出用户
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 列出用户调度程序
    • 删除用户计划程序
    • 获取用户权限
    • 删除计划程序
    • 获取用户摘要
    • 更新用户设置
    • 获取用户设置
    • 更新用户的电子邮件
    • 更新用户
    • 获取用户
    • 删除用户
  • Reports
    • 获取网络研讨会详细信息报告
    • 获取网络研讨会问答报告
    • 获取登录/注销活动报告
    • 获取会议参与者报告
    • 获取会议报告
    • 获取会议详细信息报告
    • 获取会议问答报告
    • 获取会议投票报告
    • 获取每日使用情况报告
    • 获取操作日志报告
    • 获取活动/非活动主机报告
    • 获取账单报告
    • 获取即将发生的事件报告
    • 获取云记录使用情况报告
    • 获取帐单发票报告
    • 获取电话报告
    • 获取网络研讨会参与者报告
    • 获取网络研讨会投票报告
  • Groups
    • 更新群组的设置
    • 获取组的设置
    • 创建组
    • 列表组
    • 添加组管理员
    • 列表组管理员
    • 添加组成员
    • 列出组成员
    • 更新小组的网络研讨会注册设置
    • 获取小组的网络研讨会注册设置
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 删除组管理员
    • 更新锁定设置
    • 获取锁定设置
    • 更新组成员
    • 删除组成员
    • 更新群组
    • 获取一个组
    • 删除群组
  • H323 Devices
    • 创建H.323/SIP设备
    • 列出H.323/SIP设备
    • 更新H.323/SIP设备
    • 删除H.323/SIP设备
  • Webinars
    • 创建网络研讨会模板
    • 列出网络研讨会模板
    • 更新实时流状态
    • 设置网络研讨会的默认品牌虚拟背景
    • 上传网络研讨会的品牌虚拟背景
    • 删除网络研讨会的品牌虚拟背景
    • 创建网络研讨会
    • 列出网络研讨会
    • 执行批量注册
    • 更新网络研讨会
    • 获取网络研讨会
    • 删除网络研讨会
    • 创建网络研讨会的邀请链接
    • 更新网络研讨会的品牌名称标签
    • 更新注册人的状态
    • 获取缺席的网络研讨会
    • 获取网络研讨会的会议品牌推广
    • 获取网络研讨会注册人
    • 删除网络研讨会注册人
    • 获取网络研讨会的令牌
    • 更新实时流
    • 获取实时流详细信息
    • 创建网络研讨会的投票
    • 列出网络研讨会的民意调查
    • 获取网络研讨会跟踪源
    • 更新注册问题
    • 列出登记问题
    • 更新网络研讨会状态
    • 添加小组成员
    • 小组成员名单
    • 删除网络研讨会小组成员
    • 更新网络研讨会调查
    • 获取网络研讨会调查
    • 删除网络研讨会调查
    • 添加网络研讨会注册人
    • 列出网络研讨会注册人
    • 删除小组成员
    • 获取网络研讨会投票
    • 删除网络研讨会投票
    • 更新网络研讨会投票
    • 创建网络研讨会的品牌名称标签
    • 删除网络研讨会的品牌名称标签
    • 上传网络研讨会的品牌壁纸
    • 删除网络研讨会的品牌壁纸
    • 列出过去的网络研讨会实例
  • Tracking Field
    • 创建跟踪字段
    • 列表跟踪字段
    • 更新跟踪字段
    • 获取跟踪字段
    • 删除跟踪字段
  • Dashboards
    • 获取聊天指标
    • 列表缩放会议客户反馈
    • 获取post网络研讨会反馈
    • 获取CRC端口使用情况
    • 列出会议参与者
    • 获取会议共享/录制详细信息
    • 列出网络研讨会参与者QoS
    • 列出客户会议满意度
    • 获取缩放房间的问题
    • 获取会议参与者QoS
    • 获得有问题的前25个缩放房间
    • 列出客户端版本
    • 获取网络研讨会详细信息
    • 获取缩放房间详细信息
    • 获取网络研讨会参与者QoS
    • 获取zoom会议客户反馈
    • 获取网络研讨会参与者
    • 获取网络研讨会共享/录制详细信息
    • 获取缩放房间的前25个问题
    • 获取会议质量分数
    • 列出会议
    • 列表缩放房间
    • 获取会议后反馈
    • 列出网络研讨会
    • 获取会议详细信息
    • 列出会议参与者QoS
  • Dashboards Copy
    • 获取聊天指标
    • 列表缩放会议客户反馈
    • 获取post网络研讨会反馈
    • 获取CRC端口使用情况
    • 列出会议参与者
    • 获取会议共享/录制详细信息
    • 列出网络研讨会参与者QoS
    • 列出客户会议满意度
    • 获取缩放房间的问题
    • 获取会议参与者QoS
    • 获得有问题的前25个缩放房间
    • 列出客户端版本
    • 获取网络研讨会详细信息
    • 获取缩放房间详细信息
    • 获取网络研讨会参与者QoS
    • 获取zoom会议客户反馈
    • 获取网络研讨会参与者
    • 获取网络研讨会共享/录制详细信息
    • 获取缩放房间的前25个问题
    • 获取会议质量分数
    • 列出会议
    • 列表缩放房间
    • 获取会议后反馈
    • 列出网络研讨会
    • 获取会议详细信息
    • 列出会议参与者QoS
  • Cloud Recording
    • 列出帐户的记录
    • 获取会议录音
    • 删除会议录制
    • 创建录音注册人
    • 列表记录注册人
    • 获取会议记录的分析详细信息
    • 恢复会议录制
    • 恢复单个录制
    • 更新注册问题
    • 获取注册问题
    • 获取会议记录的分析摘要
    • 更新注册人的状态
    • 更新会议录制设置
    • 获取会议录制设置
    • 列出所有录音
    • 删除会议录制文件
  • TSP
    • 更新帐户的TSP信息
    • 获取帐户的TSP信息
    • 更新TSP帐户
    • 获取用户的TSP帐户
    • 删除用户的TSP帐户
    • 设置TSP用户的全局拨入URL
    • 添加用户的TSP帐户
    • 列出用户的TSP帐户
  • SIP Connected Audio
    • 更新内部号码
      PATCH
    • 删除内部号码
      DELETE
    • 分配SIP中继配置
      PATCH
    • 获取SIP中继配置
      GET
    • 分配SIP中继
      POST
    • 列出SIP中继
      GET
    • 列出SIP中继号码
      GET
    • 删除内部呼叫国家/地区
      DELETE
    • 添加内部调出国家/地区
      POST
    • 列出内部调出国家/地区
      GET
    • 分配编号
      POST
    • 删除所有号码
      DELETE
    • 添加内部编号
      POST
    • 列出内部号码
      GET
    • 删除SIP中继
      DELETE
  • Accounts
    • 获取帐户的受信任域
    • 创建子账户
    • 列出子帐户
    • 获取子帐户详细信息
    • 取消子帐户的关联
    • 更新选项
    • 更新锁定设置
    • 获取锁定设置
    • 更新帐户所有者
    • 更新帐户设置
    • 获取帐户设置
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 更新帐户的网络研讨会注册设置
    • 获取帐户的网络研讨会注册设置
    • 获取帐户的托管域
  • PAC
    • 列出用户的PAC帐户
  • Information Barriers
    • 更新信息壁垒政策
    • 通过ID获取信息屏障策略
    • 消除信息屏障策略
    • 创建信息屏障策略
    • 列出信息屏障政策
  • IM Groups
    • 创建IM目录组
    • 列出IM目录组
    • 添加IM目录组成员
    • 列出IM目录组成员
    • 更新IM目录组
    • 检索IM目录组
    • 删除IM目录组
    • 删除IM目录组成员
  • Roles
    • 创建角色
    • 列出角色
    • 更新角色信息
    • 获取角色信息
    • 删除角色
    • 分配角色
    • 列出角色中的成员
    • 取消分配角色
  • Archiving
    • 列出已存档的文件
  1. SIP Connected Audio

添加内部编号

POST
/accounts/{accountId}/sip_trunk/internal_numbers
SIP Connected Audio
让具有SIP连接音频计划的主帐户将内部电话号码 (Zoom未提供但由使用API的组织拥有的号码) 分配给主帐户或子帐户帐户。
要向子帐户添加内部编号,请在 “accountid” 路径参数中提供子帐户的帐户ID。要将内部号码添加到主帐户,请提供 “我” 作为 “accountid” 路径参数的值。
** 先决条件 **
发出此API请求的帐户必须是具有SIP连接音频计划的 主帐户。
** 范围: ** 'sip_trunk:master'

请求参数

Path 参数
accountId
string 
帐户的唯一标识符。
必需
Body 参数application/json
internal_numbers
array [object {9}] 
可选
>= 1 items<= 30 items
country
string 
必需
国家的两个字母 [ISO国家代码](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 国家)。
示例值:
US
number
string 
必需
E164格式的电话号码。
示例值:
+1 646666111
allow_join
boolean 
可选
指定用户是否可以使用此号码加入会议。
“真”-使用此号码加入会议。
'false'-此号码不能用于加入会议。
如果 “visible” 字段的值设置为 “true”,则该字段的值将始终为 “true”。
示例值:
true
visible
boolean 
可选
指定您是否希望此号码在 “缩放客户端” 和 “缩放门户” 中对帐户用户可见。
“真”-使数字可见。
'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
type
enum<integer> 
必需
电话号码的类型。
'0'-收费。
'1'-免费收费。
枚举值:
01
示例值:
0
allow_for_external_meetings
boolean 
可选
控制该号码是否可用于参加第三方会议。
示例值:
true
labels
string 
必需
电话号码的简短描述。
示例值:
SIP-Internal
示例
{
    "internal_numbers": [
        {
            "country": "US",
            "number": "+1 646666111",
            "allow_join": true,
            "visible": true,
            "languages": "en-GB",
            "display_number": "+1 646 666 1110",
            "type": 0,
            "allow_for_external_meetings": true,
            "labels": "SIP-Internal"
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/accounts//sip_trunk/internal_numbers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "internal_numbers": [
        {
            "country": "US",
            "number": "+1 646666111",
            "allow_join": true,
            "visible": true,
            "languages": "en-GB",
            "display_number": "+1 646 666 1110",
            "type": 0,
            "allow_for_external_meetings": true,
            "labels": "SIP-Internal"
        }
    ]
}'

返回响应

🟢201** HTTP状态码: ** '201' ** 已创建 ** 已成功添加内部号码。
application/json
Body
internal_numbers
array [object {10}] 
可选
country
string 
必需
国家的两个字母国家代码。
示例值:
US
number
string 
必需
E164格式的电话号码。
示例值:
+1 646666111
allow_join
boolean 
可选
指定用户是否可以使用此号码加入会议。
'true': 此号码可用于加入会议。
'false': 此号码不能用于加入会议。
请注意,如果 “visible” 字段的值设置为 “true”,则该字段的值将始终为 “true”。
示例值:
true
visible
boolean 
可选
指定您是否希望此号码对帐户用户可见 (在Zoom客户端和Zoom门户中)。该值可以是以下值之一:
“真”: 使数字可见。
'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 88888000 000”。
示例值:
+1 646 666 1110
id
string 
可选
内部编号的唯一标识符。
示例值:
1bj75491Sqa1gmyN6L47ew
type
enum<integer> 
必需
电话号码的类型。
该值可以是以下值之一:
'0': 收费
'1': 免费收费
枚举值:
01
示例值:
0
allow_for_external_meetings
boolean 
可选
控制该号码是否可用于参加第三方会议。
示例值:
true
labels
string 
必需
电话号码的简短说明。
示例值:
SIP-Internal
示例
{
    "internal_numbers": [
        {
            "country": "US",
            "number": "+1 646666111",
            "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"
        }
    ]
}
🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '300' <br> * 您的帐户没有在此帐户上进行更新的权限。只有主账户才能对子账户执行此操作。 * 请求失败,因为此帐户未在SIP Connected Audio计划中注册。 * 此帐户不是主帐户。要访问此API,你的账户必须在API合作伙伴计划中注册,并且必须是主账户。 * 您最多只能将 {0} 个电话号码分配给此帐户。 * 您为 “数字” 字段提供的值已被使用。请为此字段提供唯一值。 * 无效参数: int
🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '2001' <br> 帐户不存在: {0}。<br>
🟠429** HTTP状态代码: ** '429' <br> 请求太多 ** 错误代码: ** '429' <br> 并发请求太多。一次只能提交一个 “创建内部号码” 请求。请稍后再试。<br>

扫码加 ZOOM 开发者 微信交流

在这里,获得 ZOOM API 文档 使用上的任何帮助,快速上手让你的研测效率得到大幅提升

扫码加入交流群
上一页
删除所有号码
下一页
列出内部号码
Built with