Enable SIP phone

POST

/sip_phones

SIP Phone

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 enable a user to use SIP phone.

Prerequisites:

Currently only supported on Cisco and Avaya PBX systems.

The account owner or account admin must first enable SIP Phone Integration by contacting the Sales team.
Scope: sip_phone:write:admin

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/sip_phones' \
--form 'authorization_name=""' \
--form 'domain=""' \
--form 'password=""' \
--form 'proxy_server=""' \
--form 'register_server=""' \
--form 'user_email=""' \
--form 'user_name=""' \
--form 'voice_mail=""'

响应示例

201 - 示例 1

{}

请求参数

Body 参数multipart/form-data

authorization_name

string

必需

Authorization name of the user registered for SIP Phone.

<= 64 字符

domain

string

必需

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

<= 64 字符

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.

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.

>= 1<= 127

默认值:

示例值:

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.

<= 64 字符

user_name

string

必需

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

<= 64 字符

voice_mail

string

必需

The number to dial for checking voicemail.

<= 255 字符

返回响应

🟢201**HTTP Status Code:** `201` SIP Phone Created.

application/json

Body

object {0}

🟠400**HTTP Status Code:** `400` Bad request. **Error Code:** `200` Permission missing: Enable SIP Phone Integration by contacting a Zoom Admin first. **Error Code:** `300` SIP Phone with the same email already exists.

🟠404**HTTP Status Code:** `404` **Error Code:** `1001` User {userId} not exist or not belong to this account.

List SIP phones

Delete SIP phone