API
Chat
Contatos, etiquetas e ações sobre mensagens já enviadas. Guarde o messageId de cada envio.
Depois do envio
Reagir, editar, apagar, encaminhar, marcar lida e consultar delivery usam o messageId.
No playground: Presença, Marcar lida e Status de entrega.
/api/chat/contacts/{instance}Contatos
Lista sincronizada.
Auth: TokenInstance
/api/chat/contactsByLabel/{instance}Por etiqueta
Filtra chats com a label.
Auth: TokenInstance
/api/chat/getMessage/{instance}Buscar mensagem
?messageId=
Auth: TokenInstance
/api/chat/tag/{instance}Listar etiquetas
Labels da instância.
Auth: TokenInstance
/api/chat/tag/{instance}Criar etiqueta
name + color.
Auth: TokenInstance
/api/chat/tag/{instance}Deletar etiqueta
Remove a label e atribuições.
Auth: TokenInstance
/api/chat/assignTag/{instance}Atribuir etiqueta
Aplica label a um chat.
Auth: TokenInstance
/api/chat/assignTag/{instance}Remover etiqueta
Tira a label do chat.
Auth: TokenInstance
/api/chat/archive/{instance}Arquivar
number + archive bool.
Auth: TokenInstance
/api/chat/markRead/{instance}Marcar mensagem lida
ACK de uma ou mais mensagens. number + messageId / messageIds[].
Auth: TokenInstance
Body
| Campo | Tipo | Descrição | |
|---|---|---|---|
number | string | obrigatório | chat |
messageId | string | uma mensagem | |
messageIds | string[] | várias |
/api/chat/markChatRead/{instance}Marcar chat lido
Chat inteiro.
Auth: TokenInstance
/api/chat/pinChat/{instance}Fixar chat
number + pin bool.
Auth: TokenInstance
/api/chat/pinMessage/{instance}Fixar mensagem
messageId + pin.
Auth: TokenInstance
/api/chat/favorite/{instance}Favoritar
Chat ou mensagem.
Auth: TokenInstance
/api/chat/mute/{instance}Silenciar
number + mute bool.
Auth: TokenInstance
/api/chat/block/{instance}Bloquear
number + block bool.
Auth: TokenInstance
/api/chat/presence/{instance}Presença
state: composing | recording | paused.
Auth: TokenInstance
Body
| Campo | Tipo | Descrição | |
|---|---|---|---|
number | string | obrigatório | chat |
state | string | obrigatório | composing / recording / paused |
cURL
curl -X POST https://api.wagzap.com.br/api/chat/presence/vendas \
-H "token: $TOKEN_INSTANCE" \
-H "Content-Type: application/json" \
-d '{
"number": "5511999999999",
"state": "composing"
}'/api/chat/history/{instance}Histórico
Mensagens armazenadas. number + limit.
Auth: TokenInstance
/api/chat/base64/{instance}Mídia em base64
Conteúdo local de uma mídia.
Auth: TokenInstance
/api/chat/status/{instance}Delivery
?messageId= → pending / sent / delivered / read / played.
Auth: TokenInstance
Query
| Campo | Tipo | Descrição | |
|---|---|---|---|
messageId | string | obrigatório | stanza id |
/api/chat/poll/{instance}Votos de enquete
?messageId= da poll.
Auth: TokenInstance
/api/chat/forward/{instance}Encaminhar
to/number + messageId + fromChat.
Auth: TokenInstance
/api/chat/edit/{instance}Editar
Altera texto enviado por você.
Auth: TokenInstance
/api/chat/delete/{instance}Apagar mensagem
Revoga para todos ou só local.
Auth: TokenInstance
/api/chat/deleteChat/{instance}Apagar chat
Remove o chat localmente.
Auth: TokenInstance
/api/chat/profilePicture/{instance}Foto de perfil
URL da foto de um número.
Auth: TokenInstance