FlowmageDocs
MessageBird

Send WhatsApp or channel message

BetaChanges data

Sends a message on WhatsApp or another MessageBird channel.

Settings

SettingWhat it is
ConnectionRequiredThe MessageBird connection the step signs in with.
ToRequiredThe person's address on that channel — for WhatsApp, their phone number.
Channel idRequiredThe MessageBird channel to send from, from Channels in the dashboard. It decides which product the message goes out on.
Message typeOutside the 24 hours after the person last wrote to you, WhatsApp only delivers an approved template.
Messagetext
Address of the image or fileA public https address MessageBird can fetch the file from.
TemplateThe approved WhatsApp template, as JSON: its namespace, its name, the language and the values that fill its placeholders.
Status report addressMessageBird calls this address when the status changes.
Your referenceA label of at most 36 characters that MessageBird carries with the message.
Fall back to channelSend over this channel instead when the first one does not deliver in time.
afterHow long to wait first, e.g. 5m or 1h.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `messagebird`)
totextits `{{ }}` must give a string
channelIdtextits `{{ }}` must give a string
type"text" or "image" or "file" or "hsm", by default "text"
texttextused when `type` is "text"
mediaUrltextits `{{ }}` must give a string; used when `type` is one of "image", "file"
hsmany JSONused when `type` is "hsm"
reportUrltext
trackIdtextits `{{ }}` must give a string
fallbackChannelIdtextits `{{ }}` must give a string
fallbackAftertext

Output

FieldType
messageIdstring
statusaccepted, pending, sent, delivered or failedstring
Sample output, and the expression for each field
  • messageId"cm-1"
  • status"accepted"

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

MessageBird errors

17 codes

Common errors

93 codes

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "channelId": "<channel id>",
    "connection": "<connection id>",
    "fallbackAfter": "",
    "fallbackChannelId": "",
    "mediaUrl": "",
    "reportUrl": "",
    "text": "",
    "to": "<to>",
    "trackId": "",
    "type": "text"
  },
  "label": "Send WhatsApp or channel message",
  "type": "messagebird.sendConversationMessage",
  "version": 1
}