Números de telefone
Use o código do país e o número sem+, espaços ou pontuação:
JIDs do WhatsApp
Sufixos comuns de JID:| Sufixo | Significado | Exemplo |
|---|---|---|
@s.whatsapp.net | JID de usuário normal | [email protected] |
@g.us | JID de grupo | [email protected] |
@newsletter | JID de newsletter/canal | 120363151889@newsletter |
Grupos
Os endpoints de grupo geralmente exigem um JID de grupo. Os JIDs de grupo terminam em@g.us.
Use GET /group/list para listar os grupos conhecidos pela sessão conectada. Use POST /group/info quando você já tiver um JID de grupo e precisar de metadados.
Mensagens
As operações de mensagem utilizam:| Campo | Significado |
|---|---|
id ou messageid | ID da mensagem do WhatsApp retornado pela resposta de envio ou webhook. |
chat ou jid | JID do chat onde a mensagem existe. |
participant | JID do remetente dentro de uma mensagem de grupo. Necessário para algumas operações de citação ou de grupo. |
isfromme / isFromMe | Indica se a mensagem alvo foi enviada pela sessão atual. |
Chamadas
Os endpoints de chamada utilizamcallID ou CallID, dependendo do endpoint. O valor é obtido a partir de webhooks de chamada, /call/make ou /call/status.
Use GET /call/status para listar as chamadas rastreadas:
Etiquetas
Os endpoints de etiquetas utilizamlabelid. As etiquetas existentes vêm do estado do WhatsApp. O POST /label/edit pode criar, atualizar ou excluir etiquetas, dependendo do valor de action.