更新SIP电话 - Zoom API 中文版

请求参数

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

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> 错误的请求