List SIP phones
GET {{baseUrl}}/sip_phones?page_number=1&search_key=<string>&page_size=<integer>&next_page_token=<string>
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.
Scopes: sip_phone:read:admin
Rate Limit Label: Medium
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_number | number | Deprecated. We will no longer support this field in a future release. Instead, use the next_page_token for pagination. | |
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 | string | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_number":"\u003cinteger\u003e","page_size":"\u003cinteger\u003e","phones":[{"authorization_name":"\u003cstring\u003e","domain":"\u003cstring\u003e","id":"\u003cstring\u003e","password":"\u003cstring\u003e","proxy_server":"\u003cstring\u003e","proxy_server2":"\u003cstring\u003e","proxy_server3":"\u003cstring\u003e","register_server":"\u003cstring\u003e","register_server2":"\u003cstring\u003e","register_server3":"\u003cstring\u003e","registration_expire_time":"\u003cinteger\u003e","transport_protocol":"UDP","transport_protocol2":"UDP","transport_protocol3":"UDP","user_email":"\u003cemail\u003e","user_name":"\u003cstring\u003e","voice_mail":"\u003cstring\u003e"},{"authorization_name":"\u003cstring\u003e","domain":"\u003cstring\u003e","id":"\u003cstring\u003e","password":"\u003cstring\u003e","proxy_server":"\u003cstring\u003e","proxy_server2":"\u003cstring\u003e","proxy_server3":"\u003cstring\u003e","register_server":"\u003cstring\u003e","register_server2":"\u003cstring\u003e","register_server3":"\u003cstring\u003e","registration_expire_time":"\u003cinteger\u003e","transport_protocol":"UDP","transport_protocol2":"TLS","transport_protocol3":"UDP","user_email":"\u003cemail\u003e","user_name":"\u003cstring\u003e","voice_mail":"\u003cstring\u003e"}],"total_records":"\u003cinteger\u003e"}