POST /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 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](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Servers

https://api.zoom.us/v2

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`proxy_server2`	String	No	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_server3`	String	No	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.
`voice_mail`	String	Yes	The number to dial for checking voicemail.
`domain`	String	Yes	The name or IP address of your provider’s SIP domain. (example: CDC.WEB).
`authorization_name`	String	Yes	Authorization name of the user registered for SIP Phone.
`user_name`	String	Yes	The phone number associated with the user in the SIP account.
`register_server`	String	Yes	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.
`registration_expire_time`	Integer	No	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. Default value: 60
`proxy_server`	String	Yes	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.
`transport_protocol`	String	No	Protocols supported by the SIP provider. The value must be either `UDP`, `TCP`, `TLS`, `AUTO`. Valid values: `"AUTO"` `"UDP"` `"TCP"` `"TLS"`
`user_email`	String	Yes	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.
`password`	String	Yes	The password generated for the user in the SIP account.
`transport_protocol3`	String	No	Protocols supported by the SIP provider. The value must be either `UDP`, `TCP`, `TLS`, `AUTO`. Valid values: `"AUTO"` `"UDP"` `"TCP"` `"TLS"`
`transport_protocol2`	String	No	Protocols supported by the SIP provider. The value must be either `UDP`, `TCP`, `TLS`, `AUTO`. Valid values: `"AUTO"` `"UDP"` `"TCP"` `"TLS"`
`register_server2`	String	No	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_server3`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.