Send Messages
Send messages from your channel to a user by specifying the content type. Supports identification by phone number or BSUID.
Identifying the recipient
TheuserId field accepts two formats:
- Phone number: E.164 format without the leading
+(e.g.:593999999999). - BSUID (Business-Scoped User ID): an identifier with the format
CC.alphanumeric(e.g.:US.13491208655302741918).
userId to send them a message without needing their phone number.- With phone number
- With BSUID
Use Cases
- Simple notifications
- Confirmations
- Informational messages
- Basic automated responses
- Replying to a user who enabled number privacy in WhatsApp, using the BSUID received in an incoming webhook
- Sending proactive messages to users identified exclusively by BSUID, without needing to store or know their real phone number
Examples
Replying to an incoming message identified by BSUID
When a user with number privacy enabled writes to you, the incoming webhook carries their BSUID instead of a phone number. Use that same value to reply:Sending an image to a recipient identified by BSUID
Every other message type (image, document, location, etc.) works the same way: just swap theuserId value for the recipient’s BSUID.
Authorizations
Basic authentication using Base64 encoded clientId:clientSecret
Path Parameters
The unique identifier of the bot
Body
Message payload. The structure varies based on the message type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Type of message to send
text "text"
Unique identifier of the user receiving the message. Accepts either a phone number in E.164 format without the leading '+' (e.g. '593999999999') or a BSUID (Business-Scoped User ID, e.g. 'US.13491208655302741918') for users who have enabled phone number privacy in WhatsApp.
"593999999999"
Text content of the message
"Hello, this is a text message"
Unique identifier of the bot sending the message
"BOT_ID"