WhatsApp Broadcast
Component Definition
You don't need to use whatsappRecipient field if you already use recipient field. This also applies in a reverse way.
Create Recipients
Body Create Recipients
To create recipients, you must upload your recipient number with format .xlsx You must fill the recipients data and save it with format xlsx, like the image below.
You can choose form-data format on Body and fill the key with 'uploadFile', change the type with file then you can click select files button to select recipient document on your device. Click Send button to upload file.
Response
Response status: 200
Verify Phone Number
Response
Response status: 200
Send Broadcast Text
Body :
Response: 200
Example Send Broadcast Text
Below is a representation when using the WhatsApp broadcast API for sending a broadcast text on the 3Dolphins application.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Image
Body :
Response: 200
Example Send Broadcast Image
Below is a representation when using the WhatsApp broadcast API for sending a broadcast image on the 3Dolphins application.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template (when using images notification template, you must fill in the 'type' field with 'image' and your image url with https format and image extension type). The name field will also be the title for your notification. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Video
Body :
Response: 200
Example Send Broadcast Video
Below is a representation when using the WhatsApp broadcast API for sending a broadcast video on the 3Dolphins application.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template (when using video notification template, you must fill in the 'type' field with 'video' and your video url with https format and video extension type). The name field will also be the title for your notification. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Document
Body:
Response
Response status: 200
Example Send Broadcast Document
Below is a representation when using the WhatsApp broadcast API for sending a broadcast document on the 3Dolphins application.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template (when using document notification template, you must fill in the 'type' field with 'document' and your document url with https format and document extension type). The name field will also be the title for your notification. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Quick Reply
Body :
Response
Response status: 200
Example Send Broadcast Quick Reply
Below is a representation when using the WhatsApp broadcast API for sending a broadcast quick reply on the 3Dolphins application.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template. The name field will also be the title for your notification. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Macro in Body
Body :
Response
Response status: 200
Example of macro variable:
Example of recipient file (must be .xlsx format) :
In the example above, field that is being defined is Nama and Title. We can use this field on our Header Variables/Body Variables.
Example Send Broadcast Macro in Body
Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification body.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for the body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Broadcast Macro in Header and Body
Component Explanation:
Example of macro variable:
Example of recipient file (must be .xlsx format) :
In example above, field that being defined is Nama and Title. We can use this field on our Header Variables/Body Variables.
Body :
Response
Response status: 200
The example of headerVariables above has a meaning, you mapping value of field Name into macro {1} The example of bodyVariables above has a meaning, you mapping value of field Name into macro {1} and value of field Tanggal into macro {2}.
When broadcast being send into the recipient macro {1} and {2} would replaced with the value from recipient file. On this example, the macro would replaced with M.Ridwan and 22-04-2021. So the end result would be like this:
Halo, M.Ridwan
Terima kasih sudah mendaftarkan diri anda. Berikut lampiran datanya Nama: M. Ridwan Tanggal keberangkatan: 22-04-2021
Example Send Broadcast Macro in Header and Body
Below is a representation when using the WhatsApp broadcast API for sending a broadcast macro in the notification header and body.
When you enter the channel field using the channel id in the API, it will be like selecting an account on the application, as well as the templateId field like selecting the notification template. The name field will also be the title for your notification. The template variables field for header and body will appear when you use a broadcast macro to fill in the values for the key, type, and value fields. SendingMode field is like specify the sending option to be used (if you use 'schedule', you can choose the time when the notification will be sent).
Send Multiple Broadcast
Multiple broadcast allows you to create more than one broadcast at once.
Body for Multiple Broadcast :
Response
Response status: 200
Get Broadcast Detail by ID
Response
Response status : 200
Create Broadcast WhatsApp
Broadcast template id must be created first in order to use WhatsApp broadcast API.
Body:
Response:
Response Status: 200
Last updated