Message APIs
Broadcast Message
This endpoint is used to send bulk messages to many chats
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header
Body
application/json
- Array of all the recipients
- For groups, enter the chat_id of the group. This will be a string that ends with @g.us
- For 1-1 chats, enter the country_code + number of the recipient e.g. 919537851844@c.us (The @c.us is optional)
- Required to send a media object. You can send a public URL of the media content, or the base64 data of the media
- Media can be a document, image, video or audio
url
- public URL that hosts the content to be sentfiledata
- Raw bytes of the file, represented in base64type
- The type of the media. Can be image, video, document or audiofilename
- The filename of the media. Only applicable for document messages
- The text body or caption. You can use basic markdown formatting supported by WhatsApp e.g. * for bold, and _ for italic, etc.
pollName
- The question or title of the pollpollOptions
- Raw bytes of the file, represented in base64options
- Additional options to be sent with the pollallowMultipleAnswers
- Boolean. When set to true, respondents can select multiple optionspollId
- Optional unique identifier of the poll. Useful when sending it across multiple chats
- To reply to a message, add the message_id in this field
Response
200 - application/json
The response object contains the broadcast_id
You can check the status and logs of the broadcast jobs from the /queue/jobs
endpoint
The broadcast_id
can also be mapped in the message object against the broadcast_id
(same key)
Was this page helpful?