| Broadcast Status | Parameter | Value | Description |
|---|---|---|---|
| Now | scheduleWithoutDate | false | Broadcast is sent at the moment. |
| Scheduled | broadcastDate | UTC Zulu format date | Broadcast is scheduled to be sent later. |
| Pending | scheduleWithoutDate | true | Indicates that Broadcast does not have a set delivery Date |
Specifies the type of delivery channel which the message will be sent: ´SMS´ ,´EMAIL´, ´RCS´, ´WHATSAPP´.
In this case, we enter the ´WHATSAPP´ value to send the WhatsApp message template.
Name of the column defined when creating the contact list that contains the mobile numbers of the contacts.
- `filters` string — Set the filter you want to apply on the message. - `filterName` string — Name of the filter. The content is the name of the filter applied on the message. - `segmentId` string — Unique identifier of the segment. - `message` string —Applies only when sending a Session Message.
Content of the session message that will be sent to the contacts.
If a WhatsApp user has sent your application a message — whether it’s a reply to one of your outbound messages, or they have initiated communication themselves — your application has a 24-hour window to send the regular message, without using a message template.
- `origin` string —Source address of the broadcast.
Phone number provided during the WABA account setup will be used as the sender of the broadcast.
Only accepts numeric characters. Do not include the ´+´ sign.
- `broadcastDate` string, date-time —Applies only when the ´scheduleWithoutDate´ is true. That is, when you want to define the date and time when sending the WhatsApp message template.
Set the date and time when the WhatsApp message template will be sent in UTC format: (yyyy-mm-dd-Thh:mm:ss.ssZ).
If you do not set the date, the sending of the broadcast will be pending.
- `scheduleWithoutDate` boolean —Define the Date & Time of your broadcast
true: Define the date and time when sending the WhatsApp message template.false: Send the WhatsApp message template once the API Call is executed.By default is false
Message delivery speedometer.
By default, 250 messages are sent per second.
- `callbacks` string[] — Callbacks list. - `clientId` string — Unique user identifier that can be used for reporting purposes. - `whatsappTemplateName` string —Applies only when sending a WhatsApp Message Template.
Name of the message template created in your WhatsApp Business Account.
- `whatsappTemplateLanguage` string —Applies only when sending a WhatsApp Message Template.
Language of the message template.
Currently the API supports 3 Languages: English, Spanish and Portuguese. Required if you want to send message templates in languages other than English.English: ´en´, ´en_GB´, ´en_US´
Spanish: ´es´, ´es_AR´, ´es_ES´
Portuguese: ´pt_BR´, ´pt_PT
Applies only when sending a WhatsApp Message Template.
Unique identifier of the whatsApp message template.
- `whatsappTemplateHeader` object —Applies only when sending a WhatsApp Message Template.
Object of personalized fields (placeholders) or URL containing the header type chosen when creating the message template.
- `type` 'text' | 'image' | 'video' | 'document' —Enter the header type chosen when creating the message template in lower case: ´text´, ´image´, ´video´, ´document´.
Only applies if the message template created contains the ´text´ header type and includes a personalized field (placeholder)..
Enter the personalized field (placeholder).
- `url` string —Only applies if the message template created contains the ´image´, ´video´ or ´document´ header type.
if you set the Video, Image or Document as Header type when creating the message template, enter the URL of the chosen media.
The URL of the header (image, video and document) must be a valid URL that starts with ´http://…´ or ´https://…´ and provides a direct download. Redirects are not supported.
Only applies if the message template created contains the ´document´ header type.
if you set the Document as Header option when creating the message template, enter the name and file extension (.pdf) of the document to be sent.
- `whatsappTemplateButtons` object[] —If you set the Call To Action as Button type, it is required when the button contains a Dynamic URL.
If you set the Quick Reply as Button type, it is required when the button contains a payload or keywords.
Array that contains the URL Suffix value (placeholder) of Dynamic URL for a Call To Action Button, and payloads or keywords from Quick Reply Buttons containing the button type chosen when creating the message template.
- `type` 'cta' | 'quick-reply' —Applies only when sending a WhatsApp Message Template.
Enter the button type chosen when creating the message template:
´cta´: call to action button.´quick-reply´: quick reply button.Position index of the button of how it was defined when creating the message template.
For Call to Action and Quick Reply buttons, indicates the position index of the button of how it was defined when creating the message template (0, 1, 2, 3, ...).
- `value` string —For Call To Action buttons, if the created message template has been defined with a dynamic URL, enter the URL suffix value defined when creating the message template regarding its index position. The URL suffix is then propagated as an extension of the registered URL address.
For Quick Reply buttons, enter the payload or keyword defined when creating the message template regarding its index position.
## Response `201` Broadcast creation request accepted - BroadcastCreateResponse - `meta` MetadataDTO - `timestamp` integer, required — Transaction's date in timestamp - `transactionId` string, required — Id for the current transaction (Endpoint's call) - `explain` string — Explain string in case of failure - `data` BroadcastResponse — list of broadcasts - `id` integer — broadcast id - `beginDate` string, date-time — broadcast begin date in UTC - `endDate` string, date-time — broadcast end date in UTC - `deliveryMethod` 'SMS' | 'EMAIL' | 'RCS' | 'WHATSAPP' | 'SMS_MO' — delivery method or digital channel to broadcast messages - SMS/EMAIL/RCS/WHATSAPP - - `campaignName` string — broadcast name - `createdBy` string — broadcast creator username - `operator` string — broadcast operator username - `description` string — broadcast description - `listId` integer — list ID used in broadcast - `listSize` integer — list size used in broadcast - `listField` string — field from list used in broadcast - `filters` string — filters - in URL encoded format - applied to the list used in the broadcast - `filterName` string — filter name - `segmentId` string — segment id - `message` string — broadcast description - `origin` string — broadcast origin: code in sms, from in email - `broadcastDate` string, date-time — broadcast date in UTC - `broadcastStatus` 'DONE' | 'PENDING' | 'SCHEDULED' | 'SENDING' | 'SUSPENDED' | 'PAUSED' | 'DONE_WITH_FLAWS' | 'FATAL_ERROR' — broadcast status - `createdAt` string, date-time — broadcast creation date in UTC - `scheduleWithoutDate` boolean — flag to trigger now or schedule broadcast - `throttle` integer — throttle rate - `callbacks` string[] — callbacks list - `notSentCounter` integer — number of messages that have not been sent - `messagesSentCounter` integer — number of messages that have been sent - `smsField` string — list sms field - user additional field to be used in BigQuery reports - `emailField` string — list email field - user additional field to be used in BigQuery reports - `clientId` string — client Id field - user additional field to be used in BigQuery reports - `fallback` Fallback — Configuration to trigger the fallback mechanism - `channels` object[] — Map list to add configuration per channel - `multimediaFileName` string — Multimedia File Name - `report` Report — Information about reports from missandei to differents broadcasts - `sent` string — the message was sent - `delivered` string — the message was delivered - `unique_clicked` string — when the customer clicked at least once - `clicked` string — When the customer clicks - `failed` string — when the message failed - `requestDR` boolean — ONLY SMS: request DR flag - `subject` string — ONLY EMAIL: email broadcast subject. required in email broadcast - `draftId` string — ONLY EMAIL: email broadcast draft Id - `attachmentName` string — attachment name - `rcsConfig` RcsConfig — ONLY RCS: particular RCS broadcast information - `rcsMessage` object — RCS message payload. changes according to the type of RCS: text or standalonecard - `rcsMessageType` string — RCS message type: text or standalonecard - `rcsSuggestions` object[] — list with suggestions map - `whatsappConfig` WhatsAppConfig — ONLY WHATSAPP: particular WHATSAPP broadcast information - `whatsappTemplateName` string - `whatsappTemplateLanguage` string - `whatsappTemplateHeader` object - `whatsappTemplateButtons` TemplateButtons[] - `type` 'cta' | 'quick-reply' | 'flow', required — Button type - `values` ButtonValue[] - `index` integer, required — Button index position - `value` string — Button value/text. Required for regular buttons, optional for flow buttons - `whatsappTemplateId` string - `caption` string - `type` string ## Other responses - `400` — bad request - `401` — unauthorized: malformed jwt - `410` — gone: expired jwt - `412` — a precondition is not met - `500` — internal server error --- [API](https://skmtc.dev/messangi/apis/raven.md) · [All operations](https://skmtc.dev/messangi/apis/raven/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/messangi/raven/revisions/c87f398fa338/schema)