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
type: object
properties:
parameters:
type: object
properties:
page_number:
default: 1
type: integer
example: 1
description: >-
**Deprecated.** We will no longer support this field in a future
release. Instead, use the `next_page_token` for pagination.
search_key:
type: string
example:
[email protected]
description: >-
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:
type: integer
example: 30
description: The number of records returned within a single API call.
next_page_token:
type: string
example: Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3
description: >-
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.
title: Parameters
type: object
properties:
next_page_token:
type: string
example: Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3
page_count:
description: The number of pages returned for the request made.
type: integer
example: 1
page_number:
description: The page number of the current results.
type: integer
example: 1
page_size:
description: The number of records returned within a single API call.
type: integer
example: 30
phones:
description: SIP phones object.
type: array
items:
type: object
properties:
authorization_name:
description: The authorization name of the user that is registered for SIP phone.
type: string
example: testname
domain:
description: The name or IP address of your provider's SIP domain.
type: string
example: example.com
id:
description: The SIP phone ID.
type: string
example: '123456'
password:
description: |
The password generated for the user in the SIP account.
type: string
example: apassword1
proxy_server:
description: >-
The 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.
type: string
example: 192.0.2.2
proxy_server2:
description: >-
The 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.
type: string
example: 192.0.2.4
proxy_server3:
description: >-
The 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.
type: string
example: 192.0.2.6
register_server:
description: >-
The 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.
type: string
example: 192.0.2.1
register_server2:
description: >-
The 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.
type: string
example: 192.0.2.3
register_server3:
description: >-
The 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.
type: string
example: 192.0.2.5
registration_expire_time:
description: >-
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.
type: integer
example: 60
transport_protocol:
description: >-
Protocols supported by the SIP provider.<br> The value must be
either `UDP`, `TCP`, `TLS`, `AUTO`.
enum:
- UDP
- TCP
- TLS
- AUTO
type: string
example: UDP
transport_protocol2:
description: >-
Protocols supported by the SIP provider.<br> The value must be
either `UDP`, `TCP`, `TLS`, `AUTO`.
enum:
- UDP
- TCP
- TLS
- AUTO
type: string
example: UDP
transport_protocol3:
description: >-
Protocols supported by the SIP provider.<br> The value must be
either `UDP`, `TCP`, `TLS`, `AUTO`.
enum:
- UDP
- TCP
- TLS
- AUTO
type: string
example: UDP
user_email:
description: >-
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 (for example,
`
[email protected]`) to add accounts for different platforms for
the same user.
format: email
type: string
example:
[email protected]
user_name:
description: 'The phone number associated with the user in the SIP account. '
type: string
example: Jill Chill
voice_mail:
description: The number to dial for checking voicemail.
type: string
example: '4000'
total_records:
description: The total number of all the records available across pages.
type: integer
example: 20