listSipPhones.Rd
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 https://zoom.us/contactsales team. **Scope:** sip_phone:read:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium
listSipPhones( page_number = NULL, search_key = NULL, page_size = NULL, return_response = F )
page_number | **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. |
---|---|
search_key | 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 | The number of records returned within a single API call. |
return_response | Whether to return the response instead of the response content. Defaults to FALSE. |