List SIP phones

GET

/sip_phones

Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.

Prerequisites:

Currently only supported on Cisco and Avaya PBX systems.

User must enable SIP Phone Integration by contacting the Sales team.
Scope: sip_phone:read:admin
Rate Limit Label: Medium

响应示例

200 - response

{
    "page_count": 1,
    "page_number": 1,
    "page_size": 1,
    "phones": [
        {
            "authorization_name": "testname",
            "domain": "CDC.WEB",
            "id": "123456",
            "password": "apassword1",
            "proxy_server": "192.168.0.10",
            "proxy_server2": "192.168.0.10",
            "proxy_server3": "192.168.0.10",
            "register_server": "192.168.0.100",
            "register_server2": "192.168.0.100",
            "register_server3": "192.168.0.100",
            "registration_expire_time": 60,
            "transport_protocol": "UDP",
            "transport_protocol2": "UDP",
            "transport_protocol3": "UDP",
            "user_email": "CfRE2opiq3HokO@someemailtype.com",
            "user_name": "1008",
            "voice_mail": "4000"
        }
    ],
    "total_records": 1
}

请求参数

Query 参数

page_number

integer

可选

Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.

The page number of the current page in the returned records.

默认值:

search_key

string

可选

User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.

page_size

integer

可选

The number of records returned within a single API call.

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200`<br> SIP Phones listed successfully. **Error Code:** `200`<br> Permission missing: Enable SIP Phone Integration by contacting a Zoom Admin first.

application/json

Body

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

The page number of the current results.

page_size

integer

可选

The number of records returned within a single API call.

phones

array [object {17}]

可选

SIP phones object.

authorization_name

string

可选

Authorization name of the user registered for SIP Phone.

domain

string

可选

The name or IP address of your provider’s SIP domain. (example: CDC.WEB).

string

可选

Unique Identifier of the SIP Phone.

password

string

可选

The password generated for the user in the SIP account.

proxy_server

string

可选

IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty.

proxy_server2

string

可选

proxy_server3

string

可选

register_server

string

可选

IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

register_server2

string

可选

register_server3

string

可选

registration_expire_time

integer

可选

The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server.

transport_protocol

enum<string>

可选

Protocols supported by the SIP provider.
The value must be either UDP, TCP, TLS, AUTO.

枚举值:

UDPTCPTLSAUTO

transport_protocol2

enum<string>

可选

Protocols supported by the SIP provider.
The value must be either UDP, TCP, TLS, AUTO.

枚举值:

UDPTCPTLSAUTO

transport_protocol3

enum<string>

可选

Protocols supported by the SIP provider.
The value must be either UDP, TCP, TLS, AUTO.

枚举值:

UDPTCPTLSAUTO

user_email

string <email>

可选

The email address of the user to associate with the SIP Phone. Can add [.win, .mac, .android, .ipad, .iphone, .linux, .pc, .mobile, .pad] at the end of the email (ex. user@test.com.mac) to add accounts for different platforms for the same user.

user_name

string

可选

The phone number associated with the user in the SIP account.

voice_mail

string

可选

The number to dial for checking voicemail.

total_records

integer

可选

The total number of all the records available across pages.

🟠400**HTTP Status Code:** `400`<br> Bad Request

修改于 2024-04-24 09:06:48

Change Zoom Rooms' app version

Enable SIP phone