Zoom API 中文版
  1. SIP Phone
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电话
      POST
    • 列出SIP电话
      GET
    • 更新SIP电话
      PATCH
    • 删除SIP电话
      DELETE
  • 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
    • 更新内部号码
    • 删除内部号码
    • 分配SIP中继配置
    • 获取SIP中继配置
    • 分配SIP中继
    • 列出SIP中继
    • 列出SIP中继号码
    • 删除内部呼叫国家/地区
    • 添加内部调出国家/地区
    • 列出内部调出国家/地区
    • 分配编号
    • 删除所有号码
    • 添加内部编号
    • 列出内部号码
    • 删除SIP中继
  • Accounts
    • 获取帐户的受信任域
    • 创建子账户
    • 列出子帐户
    • 获取子帐户详细信息
    • 取消子帐户的关联
    • 更新选项
    • 更新锁定设置
    • 获取锁定设置
    • 更新帐户所有者
    • 更新帐户设置
    • 获取帐户设置
    • 上传虚拟后台文件
    • 删除虚拟背景文件
    • 更新帐户的网络研讨会注册设置
    • 获取帐户的网络研讨会注册设置
    • 获取帐户的托管域
  • PAC
    • 列出用户的PAC帐户
  • Information Barriers
    • 更新信息壁垒政策
    • 通过ID获取信息屏障策略
    • 消除信息屏障策略
    • 创建信息屏障策略
    • 列出信息屏障政策
  • IM Groups
    • 创建IM目录组
    • 列出IM目录组
    • 添加IM目录组成员
    • 列出IM目录组成员
    • 更新IM目录组
    • 检索IM目录组
    • 删除IM目录组
    • 删除IM目录组成员
  • Roles
    • 创建角色
    • 列出角色
    • 更新角色信息
    • 获取角色信息
    • 删除角色
    • 分配角色
    • 列出角色中的成员
    • 取消分配角色
  • Archiving
    • 列出已存档的文件
  1. SIP Phone

更新SIP电话

PATCH
/accounts/{accountId}/sip_phones/{phoneId}
SIP Phone
Zoom的电话系统集成 (PSI),也称为SIP电话,使组织能够利用Zoom客户端来完成对基于PBX系统的支持的前提的软电话注册。最终用户将能够在单个客户端中具有软电话功能,同时保持与Zoom Phone相当的界面。使用此API更新Zoom帐户上特定SIP电话的信息。
** 先决条件 **:
目前仅支持Cisco和Avaya PBX系统。
帐户所有者或帐户管理员必须首先通过联系 销售 团队启用SIP电话集成。
** 范围: ** 'sip_phone:master'
** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Light'

请求参数

Path 参数
phoneId
string 
必需
SIP电话ID。这可以从列表SIP电话API检索。
accountId
string 
帐户的唯一标识符。
必需
Body 参数application/json
register_server3
string 
必需
接受REGISTER请求的服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。
示例值:
192.0.2.5
transport_protocol3
enum<string> 
可选
SIP提供商支持的协议。
该值必须是 “udp” 、 “tcp” 、 “tls” 、 “auto”。
枚举值:
UDPTCPTLSAUTO
示例值:
UDP
user_name
string 
必需
与SIP帐户中的用户关联的电话号码。
<= 64 字符
示例值:
Jill Chill
register_server2
string 
必需
接受REGISTER请求的服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。
示例值:
192.0.2.3
transport_protocol2
enum<string> 
可选
SIP提供商支持的协议。
该值必须是 “udp” 、 “tcp” 、 “tls” 、 “auto”。
枚举值:
UDPTCPTLSAUTO
示例值:
UDP
proxy_server
string 
必需
SIP请求的代理服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。如果您未使用代理服务器,则此值可以与注册服务器相同。
示例值:
192.0.2.2
proxy_server2
string 
必需
SIP请求的代理服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。如果您未使用代理服务器,则此值可以与注册服务器相同。
示例值:
192.0.2.4
proxy_server3
string 
必需
SIP请求的代理服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。如果您未使用代理服务器,则此值可以与注册服务器相同。
示例值:
192.0.2.6
registration_expire_time
integer 
可选
Zoom客户端用户的SIP注册将过期且客户端将自动注册到SIP服务器的分钟数。
>= 1<= 127
默认值:
60
示例值:
60
password
string 
必需
为SIP帐户中的用户生成的密码。
示例值:
123456
voice_mail
string 
必需
检查语音信箱要拨的号码。
<= 255 字符
示例值:
4000
domain
string 
必需
您的提供商的SIP域的名称或IP地址 (例如: CDC.WEB)。
<= 64 字符
示例值:
example.com
register_server
string 
必需
接受REGISTER请求的服务器的IP地址。请注意,如果使用UDP传输协议,则默认端口为5060。如果使用具有不同端口号的UDP,则该端口号必须包含在IP地址中。
示例值:
192.0.2.1
authorization_name
string 
必需
为SIP电话注册的用户的授权名称。
<= 64 字符
示例值:
testname
transport_protocol
enum<string> 
可选
SIP提供商支持的协议。
该值必须是 “udp” 、 “tcp” 、 “tls” 、 “auto”。
枚举值:
UDPTCPTLSAUTO
示例值:
UDP
示例
{
    "register_server3": "192.0.2.5",
    "transport_protocol3": "UDP",
    "user_name": "Jill Chill",
    "register_server2": "192.0.2.3",
    "transport_protocol2": "UDP",
    "proxy_server": "192.0.2.2",
    "proxy_server2": "192.0.2.4",
    "proxy_server3": "192.0.2.6",
    "registration_expire_time": 60,
    "password": "123456",
    "voice_mail": "4000",
    "domain": "example.com",
    "register_server": "192.0.2.1",
    "authorization_name": "testname",
    "transport_protocol": "UDP"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'http://prod-cn.your-api-server.com/accounts//sip_phones/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "register_server3": "192.0.2.5",
    "transport_protocol3": "UDP",
    "user_name": "Jill Chill",
    "register_server2": "192.0.2.3",
    "transport_protocol2": "UDP",
    "proxy_server": "192.0.2.2",
    "proxy_server2": "192.0.2.4",
    "proxy_server3": "192.0.2.6",
    "registration_expire_time": 60,
    "password": "123456",
    "voice_mail": "4000",
    "domain": "example.com",
    "register_server": "192.0.2.1",
    "authorization_name": "testname",
    "transport_protocol": "UDP"
}'

返回响应

🟢200** 错误代码: ** '200' 权限缺失: 通过首先联系Zoom管理员来启用SIP电话集成。
application/json
Body
object {0}
示例
{}
🟢204** HTTP状态代码: ** '204' SIP电话信息更新成功。
🟠400** HTTP状态代码: ** '400' <br> 错误的请求

扫码加 ZOOM 开发者 微信交流

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

扫码加入交流群
上一页
列出SIP电话
下一页
删除SIP电话
Built with