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: Rate Limit Label: sip_phone:read:adminMedium
Body
PARAM
| 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": "<string>",
"page_count": "<integer>",
"page_number": "<integer>",
"page_size": "<integer>",
"phones": [
{
"authorization_name": "<string>",
"domain": "<string>",
"id": "<string>",
"password": "<string>",
"proxy_server": "<string>",
"proxy_server2": "<string>",
"proxy_server3": "<string>",
"register_server": "<string>",
"register_server2": "<string>",
"register_server3": "<string>",
"registration_expire_time": "<integer>",
"transport_protocol": "UDP",
"transport_protocol2": "UDP",
"transport_protocol3": "UDP",
"user_email": "<email>",
"user_name": "<string>",
"voice_mail": "<string>"
},
{
"authorization_name": "<string>",
"domain": "<string>",
"id": "<string>",
"password": "<string>",
"proxy_server": "<string>",
"proxy_server2": "<string>",
"proxy_server3": "<string>",
"register_server": "<string>",
"register_server2": "<string>",
"register_server3": "<string>",
"registration_expire_time": "<integer>",
"transport_protocol": "UDP",
"transport_protocol2": "TLS",
"transport_protocol3": "UDP",
"user_email": "<email>",
"user_name": "<string>",
"voice_mail": "<string>"
}
],
"total_records": "<integer>"
} |
ENDPOINTS