Phone numbers
Use country code and number without+, spaces, or punctuation:
WhatsApp JIDs
Common JID suffixes:| Suffix | Meaning | Example |
|---|---|---|
@s.whatsapp.net | Normal user JID | [email protected] |
@g.us | Group JID | [email protected] |
@newsletter | Newsletter/channel JID | 120363151889@newsletter |
Groups
Group endpoints usually require a group JID. Group JIDs end in@g.us.
Use GET /group/list to list groups known to the connected session. Use POST /group/info when you already have a group JID and need metadata.
Messages
Message operations use:| Field | Meaning |
|---|---|
id or messageid | WhatsApp message ID returned by send response or webhook. |
chat or jid | Chat JID where the message exists. |
participant | Sender JID inside a group message. Needed for some quoted or group operations. |
isfromme / isFromMe | Whether the target message was sent by the current session. |
Calls
Call endpoints usecallID or CallID depending on the endpoint. The value comes from call webhooks, /call/make, or /call/status.
Use GET /call/status to list tracked calls:
Labels
Label endpoints uselabelid. Existing labels come from WhatsApp state. POST /label/edit can create, update, or delete labels depending on the action value.
