phone

Number of APIs: 10

1. Batch add emergency service locations

POST {{baseUrl}}/phone/batch_locations

Use this API to batch add emergency service locations.

Prerequisites: * Pro or higher account plan with Zoom phone license * Account owner or admin permissions

Scope: phone:write:admin

Rate Limit Label: Light

---

2. List calling plans

GET {{baseUrl}}/phone/calling_plans

Use this API to return all of an account's Zoom Phone calling plans.

Scopes: phone:read:admin Rate Limit Label: Medium

Prerequisites: * A Pro or a higher account * A Zoom Phone license

---

3. List plan details

GET {{baseUrl}}/phone/plans

Use this API to return all of an account's Zoom Phone plan package, phone number usage and availability.

Prerequisites: * A Pro or a higher account * A Zoom Phone license

Scopes: phone:read:admin

Rate Limit Label: Medium

---

4. Download a phone recording transcript

GET {{baseUrl}}/phone/recording_transcript/download/:recordingId

Use this API to download the phone recording transcript.

Prerequisites:

• A Business or Enterprise account
• A Zoom Phone license

Scopes: phone:read, phone:read:admin, phone_recording:read, phone_recording:read:admin

Rate Limit Label: Light

---

5. List SIP groups

GET {{baseUrl}}/phone/sip_groups?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30

Use this API to list SIP (Session Initiation Protocol) groups.

Scopes: phone:read:admin Rate Limit Label: Light

Prerequisites: * Pro or a higher account with Zoom Phone license * Account owner or admin permissions

---

6. List BYOC SIP trunks

GET {{baseUrl}}/phone/sip_trunk/trunks?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30

Use this API to return a list of an account's assigned BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks.

Scopes: phone:write:admin or phone:master Rate Limit Label: Light

Prerequisites: * A Business or Enterprise account

---

7. List updatable firmwares

GET {{baseUrl}}/phone/firmwares?is_update=true&site_id=8f71O6rWT8KFUGQmJIFAdQ

Use this API to get updatable firmwares.

Prerequisites: * Business or Education account * Zoom Phone license

Scopes:phone:read:admin

Rate Limit Label: Light

---

8. Add BYOC phone numbers

POST {{baseUrl}}/phone/byoc_numbers

Use this API to add BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.

Scopes: phone:write:admin, phone:write, or phone:master
Rate Limit Label: Light

Prerequisites: * A Business or Enterprise plan * A Zoom Phone license

---

9. Change main company number

PUT {{baseUrl}}/phone/company_number

Use this API to change an account's main company number.

External users can use the main company number to reach your Zoom Phone users by dialing the main company number and the user's extension. It can also be used by your account's Zoom Phone users as their caller ID when making calls.

Scopes: phone:write:admin Rate Limit Label: Light

Prerequisites: * A Pro or higher account plan * Account owner or admin permissions

---

10. Get operation logs report

GET {{baseUrl}}/phone/reports/operationlogs?from=2020-11-01&to=2021-12-31&category_type=all&page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2

The Phone System operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details.

Use this API to retrieve the Phone System Operation Logs Report. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to Phone System Operation Logs.

Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy

Prerequisites:
* Account must be enrollled in Pro or a higher plan * Account must be enrolled in a Zoom Phone plan

---