列出SIP电话

GET

/accounts/{accountId}/sip_phones

Zoom的电话系统集成 (PSI)，也称为SIP电话，使组织能够利用Zoom客户端来完成对基于PBX系统的支持的前提的软电话注册。最终用户将能够在单个客户端中具有软电话功能，同时保持与Zoom Phone相当的界面。使用此API列出帐户上的SIP电话。

** 先决条件 **:

目前仅支持Cisco和Avaya PBX系统。

用户必须通过联系销售团队启用SIP电话集成。

** 范围: ** 'sip_phone:master'

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

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

page_number

integer

可选

** 已弃用。** 在将来的版本中，我们将不再支持此字段。相反，使用 'next_page_token' 进行分页。

search_key

string

可选

用户的用户名或电子邮件地址。如果提供此参数，则仅返回为该特定用户启用的SIP电话系统集成。否则，将返回帐户上的所有SIP电话。

page_size

integer

可选

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

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200** HTTP状态代码: ** '200' SIP电话已成功列出。 ** 错误代码: ** '200' 权限缺失: 通过首先联系Zoom管理员来启用SIP电话集成。

application/json

Body

page_number

integer

当前结果的页码。

可选

示例值:

next_page_token

string

可选

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

phones

array [object {17}]

SIP电话对象。

可选

register_server3

string

可选

接受REGISTER请求的服务器的IP地址。请注意，如果使用UDP传输协议，则默认端口为5060。如果使用具有不同端口号的UDP，则该端口号必须包含在IP地址中。

示例值:

192.0.2.5

user_email

string <email>

可选

要与SIP电话关联的用户的电子邮件地址。可以添加 '。赢 “，”。mac'，'。android'，'。ipad'，'。iphone'，'。linux'，'。pc'，'。手机 “，”。pad' 在电子邮件的末尾 (例如，' user@example.com.mac ') 为同一用户添加不同平台的帐户。

示例值:

jchill@example.com

transport_protocol3

enum<string>

可选

SIP提供商支持的协议。
该值必须是 “udp” 、 “tcp” 、 “tls” 、 “auto”。

枚举值:

UDPTCPTLSAUTO

示例值:

UDP

user_name

string

可选

与SIP帐户中的用户关联的电话号码。

示例值:

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

可选

示例值:

192.0.2.4

proxy_server3

string

可选

示例值:

192.0.2.6

registration_expire_time

integer

可选

Zoom客户端用户的SIP注册将过期且客户端将自动注册到SIP服务器的分钟数。

示例值:

password

string

可选

为SIP帐户中的用户生成的密码。

示例值:

apassword1

voice_mail

string

可选

检查语音信箱要拨的号码。

示例值:

4000

domain

string

可选

您的提供商的SIP域的名称或IP地址。

示例值:

example.com

register_server

string

可选

接受REGISTER请求的服务器的IP地址。请注意，如果使用UDP传输协议，则默认端口为5060。如果使用具有不同端口号的UDP，则该端口号必须包含在IP地址中。

示例值:

192.0.2.1

authorization_name

string

可选

为SIP电话注册的用户的授权名称。

示例值:

testname

string

SIP电话ID。

可选

示例值:

123456

transport_protocol

enum<string>

可选

SIP提供商支持的协议。
该值必须是 “udp” 、 “tcp” 、 “tls” 、 “auto”。

枚举值:

UDPTCPTLSAUTO

示例值:

UDP

page_count

integer

可选

为发出的请求返回的页数。

示例值:

page_size

integer

可选

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

示例值:

示例

{
    "page_number": 1,
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 20,
    "phones": [
        {
            "register_server3": "192.0.2.5",
            "user_email": "jchill@example.com",
            "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": "apassword1",
            "voice_mail": "4000",
            "domain": "example.com",
            "register_server": "192.0.2.1",
            "authorization_name": "testname",
            "id": "123456",
            "transport_protocol": "UDP"
        }
    ],
    "page_count": 1,
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' <br> 错误的请求

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

启用SIP电话

更新SIP电话