Initiate an outbound call

Zoom supports various URI Schemes that allow users to launch the Zoom Phone client by clicking on a secure hyperlink or a button.

This guide will provide you with an overview of the supported URI schemes that you can use to redirect your app users to the Zoom Phone client to make outbound calls.

Prerequisites

To use these schemes, the user( caller) must meet the following prerequisites:

Supported URI schemes

Zoom supports the following URI schemes that you can choose from to launch the Zoom Phone client and place calls.

a. zoomphonecall URI scheme

The zoomphonecall scheme is developed by Zoom. You can access this scheme by using the following URL:

  • zoomphonecall://{phoneNumbertoCall}?cat=seccall&token={jwttoken}

Authentication

To utilize this scheme, you must generate a JWT with the following format:

{
  "iss": "Enter your OAuth App Client ID.",
  "iat": "Enter the current epoch timestamp in seconds in long format. Note that the value of this field should not be a string.",
  "exp": "Enter the expiration timestamp for the JWT in seconds in long format. Note that the value of this field should not be a string.",
  "oid": "Enter the phone number to call. This value should match the number provided in the URI scheme.",
  "uid": "Enter the user ID of the user on whose behalf the call is to be placed. The user with this userId must be logged into the Zoom Client app using their Zoom account."
}

b. callto and tel URI schemes

The callto and tel URI schemes are popular industry standard schemes. You can use either of these schemes to launch the Zoom Phone client.

Implement the tel scheme by using the following URL format:

  • tel:{phoneNumberToCall}
  • Example: tel:+123456789

Similarly, you can implement the callto scheme by using the following URL format:

  • tel:{phoneNumberToCall}
  • Example: callto:+123456789

After clicking on a button or a hyperlink associated with the scheme, the user will be prompted to confirm whether or not you would like to open the Zoom app.

After confirming to open the app, the Zoom Phone tab is displayed. The phone number included in the scheme will be copied and displayed when the Zoom Phone client is opened via the scheme.

The user can click the call button to place the call.

Next Steps

Learn how you can get real-time call data using Webhooks.

Need help?

The first place to look is on our Developer Forum. If you can't find the answer or your request includes sensitive information, contact Developer Support.