Broadcasts to a mobile subscriber ISDN (MSISDN) number with the Flow REST API.

Details

Send a WhatsApp templated message or SMS (text) message to a list of phone numbers (MSISDN).

TEXT and EVENT examples

POST rest/v1/broadcast/instant HTTP/1.1
Host: api.flow.ai
Content-Type: application/json
Authorization: MY_MESSAGING_API_KEY
{
  "audience": [{
    "name": "John Doe",
    "phoneNumber": "+12345678901",
    "profile": {}
  }],
  "channel": {
    "channelName": "whatsapp",
    "externalId": "+12345678902"
  },
  "payload": {
    "type": "text",
    "speech": "I'm searching for the address of your store in New York"
  }
}
POST rest/v1/broadcast/instant HTTP/1.1
Host: api.flow.ai
Content-Type: application/json
Authorization: MY_MESSAGING_API_KEY
{
  "audience": [{
    "name": "John Doe",
    "phoneNumber": "+12345678901",
    "profile": {}
  }],
  "channel": {
    "channelName": "whatsapp",
    "externalId": "+10987654321"
  },
  "payload": {
    "type": "event",
    "eventName": "Send template"
  }
}

channelName

Use the reference table below to determine the channel.channelName to copy and paste:

Channel

channelName

Google RBM

rbm

MessageMedia

messagemedia

Telekom RBM

telekom

Twilio

twilio

WhatsApp

whatsapp

Khoros

khoros

Messenger

messenger

externalId

Within the Khoros Flow dashboard, open the messaging channel you'd like to use to send a message. Use the reference table below to find the value to use within your API call.

Channel

externalId

Google RBM

Project ID

MessageMedia

Phone Number

Telekom RBM

Telekom bot ID

Twilio

Phone Number

WhatsApp

Production phone number

Khoros

Phone number

Messenger

Page ID

Language