# MessageBird
URL: https://docs.awellhealth.com/docs/marketplace/messagebird

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



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

MessageBird is a cloud-based communication platform with support for a variety of channels including WhatsApp, voice, live chat and more.

Category: Communication. Adds 3 actions 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                                                               |
| ---------- | -------- | ------------------------------------------------------------------- |
| API Key    | Yes      | Your MessageBird API key. Stored as a secret.                       |
| Report URL | No       | The URL for delivery of status reports for messages. Must be HTTPS. |

## Actions [#actions]

MessageBird adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.

### Send SMS [#send-sms]

Send an SMS to a recipient of your choice.

This action can be previewed in Studio before you publish.

| Input      | Type     | Required | Description                                                                                                   |
| ---------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Originator | `string` | Yes      | The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. |
| Recipient  | `string` | Yes      | The mobile number of the recipient.                                                                           |
| Body       | `text`   | Yes      | The content of your message.                                                                                  |

MessageBird's Programmable SMS API enables you to programmatically send SMS messages from within a care flow.

[Read the official documentation](https://developers.messagebird.com/api/sms-messaging/#send-outbound-sms)

### Send voice message [#send-voice-message]

Send a voice message to a recipient of your choice.

This action can be previewed in Studio before you publish.

| Input      | Type     | Required | Description                                                                                                                 |
| ---------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| Originator | `string` | No       | The sender of the message. This can be a telephone number (including country code) or an alphanumeric string.               |
| Recipient  | `string` | Yes      | The mobile number of the recipient.                                                                                         |
| Body       | `text`   | Yes      | The content of your message.                                                                                                |
| Language   | `string` | No       | The language in which the message needs to be read to the recipient. Default: en-gb.                                        |
| Voice      | `string` | No       | The voice in which the messages needs to be read to the recipient. Possible values are: `male`, `female`. Default: `female` |

### Send WhatsApp message [#send-whatsapp-message]

Send a WhatsApp message to a recipient of your choice.

This action can be previewed in Studio before you publish.

| Input   | Type     | Required | Description                                                                                                                           |
| ------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| From    | `string` | Yes      | The channel ID from which the message should be sent.                                                                                 |
| To      | `string` | Yes      | Either a channel-specific identifier for the receiver (e.g. MSISDN for SMS or WhatsApp channels), or the ID of a MessageBird Contact. |
| Content | `text`   | Yes      | The content of your message.                                                                                                          |

Send a message to a recipient via WhatsApp. If an active conversation already exists for the recipient, the conversation will be resumed. In case there's no active conversation a new one is created.

[Learn how to get started with MessageBird and WhatsApp](https://messagebird.com/omnichannel/whatsapp)

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

MessageBird is a cloud-based SMS marketing platform designed to help businesses engage with customers across a variety of channels including WhatsApp, voice, live chat and more.

### Extension settings [#extension-settings]

In order to set up this extension, you will need to provide a MessageBird [API key](https://developers.messagebird.com/quickstarts/voice-calling/test-credits-api-keys/#get-your-api-keys) and  [report URL](https://support.messagebird.com/hc/en-us/articles/360001854898-Receiving-Delivery-Reports-DLRs-#:~:text=To%20configure%20the%20status%20report,need%20to%20be%20sent%20to.) (only required if you want to use WhatsApp messaging).

#### Send voice (text-to-speech) message [#send-voice-text-to-speech-message]

MessageBird's Voice Messaging API enables you to transform text messages into voice messages to any country.

[Read the official documentation](https://developers.messagebird.com/api/voice-messaging/#send-a-voice-message)

## Changelog [#changelog]

## MessageBird changelog [#messagebird-changelog]

## 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).
