Skip to main content

Zoom Phone

Zoom Phone connector for SMS/MMS messaging, SMS campaigns, phone users, phone numbers, call logs, call history, recordings, voicemails, external contacts, sites, and call queues.

Categories: Telephony, Communication

📝 Beta: This connector is in beta. It follows the service's documented API but has not yet been fully tested against the live service, so some tools may behave differently than described.

What you can ask​

  • List missed calls for user jane.doe@example.com from the last 24 hours
  • Send an SMS from the main line to +1 415 555 0134
  • List yesterday's call recordings for user jane.doe@example.com

Set up​

Zoom Phone needs an OAuth application from your organization before anyone can connect. An organization admin completes these steps once.

  1. Go to Organization > Connectors and find Zoom Phone. Click Enable, and choose which tools to allow.
  2. Create an OAuth application in the Zoom Phone developer portal.
  3. Add the Redirect URI shown in the connector settings to the application.
  4. Copy the application's Client ID and Client Secret into the connector, then save it.
  5. Each member connects their own account the first time they use it.

⚠️ Warning: Do not enter your Devs.ai or Zoom Phone login email or password in the OAuth application fields.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

OAuth scopes used by these tools (42)

Grant the scopes for the tools you plan to allow.

  • phone:delete:external_contact:admin
  • phone:delete:recording:admin
  • phone:delete:sms_campaign_phone_number:admin
  • phone:delete:user_phone_number:admin
  • phone:delete:voicemail:admin
  • phone:read:account_setting:admin
  • phone:read:call_history:admin
  • phone:read:call_log:admin
  • phone:read:call_queue:admin
  • phone:read:external_contact:admin
  • phone:read:list_call_history:admin
  • phone:read:list_call_logs:admin
  • phone:read:list_call_queues:admin
  • phone:read:list_external_contacts:admin
  • phone:read:list_phone_numbers:admin
  • phone:read:list_recordings:admin
  • phone:read:list_sites:admin
  • phone:read:list_sms_campaign_opt_status:admin
  • phone:read:list_sms_campaigns:admin
  • phone:read:list_sms_sessions:admin
  • phone:read:list_users:admin
  • phone:read:list_voicemails:admin
  • phone:read:phone_number:admin
  • phone:read:recording:admin
  • phone:read:setting:admin
  • phone:read:site:admin
  • phone:read:sms_campaign:admin
  • phone:read:sms_message:admin
  • phone:read:sms_session:admin
  • phone:read:user:admin
  • phone:read:user_setting:admin
  • phone:read:voicemail:admin
  • phone:update:external_contact:admin
  • phone:update:phone_number:admin
  • phone:update:recording:admin
  • phone:update:sms_campaign_opt_status:admin
  • phone:update:user:admin
  • phone:update:voicemail:admin
  • phone:write:external_contact:admin
  • phone:write:sms_campaign_phone_number:admin
  • phone:write:sms_message:admin
  • phone:write:user_phone_number:admin

Tools​

Zoom Phone offers 54 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (39)​

View and search information without changing it.

ToolWhat it does
download_sms_attachmentDownload an SMS/MMS attachment through the file service.
get_account_settingsGet the account's Zoom Phone feature settings (recording, voicemail, SMS, outbound SMS, call handling, and more).
get_call_historyGet full details of one call-history record (newer format), including the call_path legs and call_elements segments.
get_call_logGet full details of one call log (legacy format), including the per-leg log_details path and recording/voicemail flags.
get_call_log_recordingsGet the recording for a specific call by its call log ID, with caller/callee, duration, and the audio download_url.
get_call_queueGet full details of one call queue: members (users and common areas), assigned phone numbers, policy, timezone, and languages.
get_campaign_number_opt_statusList the opt-in/opt-out status of consumer numbers against Zoom Phone numbers for a 10DLC SMS campaign.
get_consent_opt_statusList the opt-in/opt-out status of consumer numbers under an SMS consent record.
get_external_contactGet full details of one external contact: name, email, description, phone numbers, and extension.
get_phone_numberGet full details of one phone number: its E.164 number, type, status, capabilities, assignee, site, carrier, and emergency address.
get_phone_settingsGet account-level Zoom Phone settings: bring-your-own-carrier (BYOC), country, multi-site enablement, and the billing account.
get_siteGet full details of one Zoom Phone site: name, site code, country, and main auto receptionist.
get_sms_campaignGet full details of one 10DLC SMS campaign: status, brand, use case, sample messages, and the phone numbers assigned to it.
get_sms_messageGet a single SMS/MMS message by its ID within a session.
get_sms_sessionGet the message history of one SMS/MMS session (conversation), newest or oldest first.
get_userGet a Zoom Phone user's full profile: assigned phone numbers, extension, site, calling plans, and the per-feature policy object.
get_user_call_handlingGet a user's call-handling settings: business, closed, and holiday hours plus the call-forwarding rules that apply in each.
get_user_campaign_opt_statusList a user's consumer-number opt-in/opt-out statuses across SMS campaigns.
get_user_settingsGet a user's phone profile settings: outbound caller IDs, devices, delegation, business hours, and more.
get_voicemailGet full details of one voicemail: caller/callee, duration, read status, audio download_url, and the transcription when available.
list_account_sms_sessionsList SMS/MMS conversation sessions across the account, newest activity first.
list_call_historyList the account's call history (newer format), each record with caller/callee, direction, duration, result, and times.
list_call_logsList the account's call logs (legacy format), each with caller/callee, direction, duration, result, and a recording_id when recorded.
list_call_queuesList call queues (ring groups that route inbound calls to members), each with its id, name, extension, assigned phone numbers, status, and site.
list_external_contactsList external contacts (non-Zoom people reachable by call or SMS), each with name, email, phone numbers, and external_contact_id.
list_phone_numbersList phone numbers on the account, each with its id, E.164 number, type, status, capabilities, and current assignee.
list_recordingsList the account's call recordings, each with caller/callee, duration, a download_url for the audio, and a transcript_download_url when available.
list_sitesList Zoom Phone sites (locations that group users and numbers), each with its id, name, site code, and country.
list_sms_campaignsList the account's 10DLC SMS campaigns (US A2P messaging registrations) with their status and brand.
list_user_call_logsList one user's call logs, each with caller/callee, direction, duration, result, forwarding, and recording/voicemail flags.
list_user_recordingsList one user's call recordings, each with caller/callee, duration, and download URLs for audio and transcript.
list_user_sms_sessionsList SMS/MMS conversation sessions owned by a specific phone user, newest activity first.
list_user_voicemailsList one user's voicemails, each with caller/callee, duration, read status, and an audio download_url.
list_usersList Zoom Phone users, each with their id, extension, assigned phone numbers, and site.
list_voicemailsList the account's voicemails, each with caller/callee, duration, read status, and an audio download_url.
read_sms_attachment_textExtract readable text from a PDF, DOCX, spreadsheet, or text attachment on an SMS/MMS message.
sync_sms_sessionSync (full, incremental, or backward) the messages of one SMS session, returning a sync_token to fetch only changes on the next call.
sync_user_sms_sessionsSync (full, incremental, or backward) a user's SMS sessions in descending order, returning a sync_token to fetch only changes next time.
validate_credentialValidate Zoom Phone credentials by listing phone users.

Write (4)​

Create or send data.

ToolWhat it does
assign_campaign_phone_numbersAssign one or more Zoom Phone numbers to a 10DLC SMS campaign, with the Letter-of-Authorization details the registration requires.
assign_user_phone_numbersAssign one or more phone numbers to a Zoom Phone user, so the user can call and text from them.
create_external_contactAdd an external contact (a non-Zoom person reachable by call or SMS).
send_smsSend an SMS or MMS from a Zoom Phone number to one or more recipients.

Delete or overwrite (11)​

Remove or replace existing data.

ToolWhat it does
delete_external_contactDelete an external contact.
delete_recordingPermanently delete a call recording.
delete_voicemailPermanently delete a voicemail.
unassign_campaign_phone_numberRemove a phone number from a 10DLC SMS campaign.
unassign_user_phone_numberRemove a phone number from a Zoom Phone user.
update_campaign_number_opt_statusSet a consumer number's opt-in or opt-out status for a 10DLC SMS campaign (honor STOP/START requests).
update_external_contactUpdate an external contact's name, email, description, phone numbers, extension, or routing.
update_phone_numberUpdate a phone number's display name, capabilities, emergency-address status, or SIP group.
update_recordingEnable or disable auto-delete for a call recording.
update_userUpdate a Zoom Phone user's profile: extension number, emergency address, site, applied template, or the per-feature policy object.
update_voicemailMark a voicemail as read or unread.
⌘J