Guide
Phone numbers and chats
Write numbers in international format
Wherever a recipient is expected (chat_id, phone, targets), write +<country code><number>: +44 7700 900123, +62 812-3456-7890. Spaces, dashes and brackets are ignored.
A number in local format (0812 3456 7890, 07700 900123) is read with your business country from GET /v1/profile — or with country_code (the calling code, e.g. "62") where an endpoint accepts it. International format is always safer.
WhatsApp chat ids (JIDs)
WhatsApp names every chat with an id. Anywhere a chat_id is expected you can pass one directly:
| Kind | Looks like |
|---|---|
| Person | [email protected] (digits with country code, no +) |
| Group | [email protected] — see GET /v1/sessions/{sessionId}/groups |
| Hidden number | …@lid — some people appear with a privacy id instead of their number |
| Channel | …@newsletter |
In responses and webhooks, chats are given as JIDs and stored numbers as digits with the country code and no + (447700900123).
In a URL path, encode the @: /v1/sessions/{sessionId}/inbox/447700900123%40s.whatsapp.net/messages.
Check numbers before a campaign
POST /v1/sessions/{sessionId}/validate tells which of up to 1 000 numbers are on WhatsApp. Sending to a number that is not on WhatsApp ends as failed.