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
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search_key |
String | No |
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_number |
Integer | No |
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. Default value: 1 |
page_size |
Integer | No |
The number of records returned within a single API call. |
next_page_token |
String | No |
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. |
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.