# Zoom
URL: https://docs.awellhealth.com/docs/marketplace/zoom

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/zoom.svg" width="48" height="48" />

Zoom is a communications platform that allows users to connect with video, audio, phone, and chat.

Category: Communication. Adds 1 action to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting       | Required | Notes                                                                           |
| ------------- | -------- | ------------------------------------------------------------------------------- |
| Account ID    | Yes      | The account ID of your Zoom account.                                            |
| Client ID     | Yes      | The client ID issued by the Server-to-Server OAuth app.                         |
| Client Secret | Yes      | The client secret issued by the Server-to-Server OAuth app. Stored as a secret. |

## Actions [#actions]

Zoom adds this action to a care flow. Add one to a step, then fill in its inputs.

### Send SMS [#send-sms]

Send an SMS

This action can be previewed in Studio before you publish.

| Input                 | Type     | Required | Description                                                                                    |
| --------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------- |
| Contact center number | `string` | Yes      | This must be an SMS capable phone number allocated to Zoom Contact Center within your account. |
| To                    | `string` | Yes      | The phone number of the person receiving the SMS.                                              |
| Body                  | `text`   | Yes      | The content that needs to be sent as an SMS. Maximum length is 500 characters.                 |

Returns:

| Data point  | Type      |
| ----------- | --------- |
| `code`      | `string`  |
| `messageId` | `string`  |
| `success`   | `boolean` |

Send an SMS to a recipient.

Ensure your Server-to-Server OAuth app has the following scopes set:

* Scopes: `contact_center_sms:write:admin`
* Granular Scopes: `contact_center:write:sms:admin`

## Setup and notes [#setup-and-notes]

Zoom is a communications platform that allows users to connect with video, audio, phone, and chat.

### Extension settings [#extension-settings]

To set up this extension, you will need to provide the following:

1. \*\*Account ID: your Zoom account ID, found on the Server to Server app build page.
2. Client ID: the client ID of the OAuth app you created in Zoom
3. Client secret: the client secret of the OAuth app you created in Zoom

You'll have to set up a [Server-to-Server OAuth app](https://developers.zoom.us/docs/internal-apps/create/) in Zoom to provision a client ID and secret.

##### Result codes [#result-codes]

On completion, the action returns a `code` data point indicating the outcome:

* SUCCESS: SMS was sent successfully.
* INVALID\_CONSUMER\_NUMBER\_FORMAT: Invalid consumer number; E.164 format is required.
* CONTACT\_CENTER\_NUMBER\_USED: Zoom Contact Center numbers cannot be used as consumer numbers.
* CONSUMER\_NOT\_OPTED\_IN: The consumer number you have messaged has not opted in.
* CONSUMER\_OPTED\_OUT: The consumer number has opted out of receiving SMS from this Zoom Contact Center number.
* CONSUMER\_BLOCK\_LISTED: The consumer number is block-listed by your Zoom Contact Center administrator.
* INTERNATIONAL\_SMS\_NOT\_SUPPORTED: International messaging is not supported on this account.
* BODY\_TOO\_LONG\*\*: Validation error — body exceeds 500 characters.

## Changelog [#changelog]

## CHANGELOG [#changelog-1]

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).