Referência completa de endpoints

Use esta página quando já souber qual funcionalidade precisa e quiser o endpoint exato, tipo de token e campos de requisição. Para exemplos guiados, comece por Integração em produção ou pelas páginas de funcionalidades.

Como ler esta referência

Use token para endpoints de sessão normais.
Use admintoken apenas para endpoints de administrador.
Os nomes dos campos diferenciam maiúsculas de minúsculas.
Alguns endpoints mais antigos usam nomes de campos JSON em maiúsculas. Envie os campos exatamente como aparecem nesta referência.

Sessões

`POST /session/init`

Cria uma linha de token WaGo local para um usuário.

Autenticação: Token admin

Campo	Tipo	Obrigatório
`Name`	`string`	Não
`Token`	`string`	Não
`Os`	`string`	Não

Exemplo de body:

{
  "Name": "JohnDoe",
  "Token": "veryhardtoken",
  "Os": "Chrome"
}

`POST /session/connect`

Inicia ou restaura o cliente WhatsApp para um token.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Subscribe`	`string`	Não
`Immediate`	`boolean`	Não

Exemplo de body:

{
  "Subscribe": [
    "Message",
    "ChatPresence"
  ],
  "Immediate": false
}

`POST /session/disconnect`

Desconecta o cliente ativo sem desvincular o WhatsApp.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /session/logout`

Desconecta o dispositivo WhatsApp vinculado.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`GET /session/status`

Retorna o estado de conexão e autenticação.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`GET /session/qr`

Retorna o QR code atual para vinculação de dispositivo.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`GET /session/all`

Lista sessões armazenadas para administradores.

Autenticação: Token admin

Nenhum body JSON é necessário.

`POST /session/pair`

Conecta com o fluxo de código de pareamento do WhatsApp.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não

Exemplo de body:

{
  "Phone": "+1872873827"
}

`POST /session/delete`

Exclui um token e seus dados de sessão locais.

Autenticação: Token admin

Nenhum body JSON é necessário.

`POST /session/scanned`

Lista tokens que concluíram a leitura/autenticação.

Autenticação: Token admin

Nenhum body JSON é necessário.

Webhooks e tempo real

`POST /webhook`

Lê ou atualiza a URL do webhook para um token.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`WebhookURL`	`string`	Sim

Exemplo de body:

{
  "WebhookURL": "http://server/webhook"
}

`GET /webhook`

Lê ou atualiza a URL do webhook para um token.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

Envio de mensagens

`POST /send/text`

Envia mensagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Body`	`string`	Sim
`Id`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Body": "How you doing?",
  "Id": "ABCDABCD1234",
  "ContextInfo": {}
}

`POST /send/image`

Envia imagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Image`	`string`	Sim
`Caption`	`string`	Não
`Id`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Image": "data:image/jpeg;base64,iVBORw0",
  "Caption": "Image Description",
  "Id": "ABCDABCD1234",
  "ContextInfo": {}
}

`POST /send/audio`

Envia áudio.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Audio`	`string`	Sim
`Ptt`	`boolean`	Não
`Duration`	`number`	Não
`Id`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Audio": "data:audio/ogg;base64,iVBORw0a",
  "Ptt": true,
  "Duration": 10,
  "Id": "ABCDABCD1234",
  "ContextInfo": {}
}

`POST /send/poll`

Envia enquete.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Question`	`string`	Sim
`MaxAnswer`	`number`	Sim
`Options`	`array<any>`	Sim
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Question": "What is the color of the sky?",
  "MaxAnswer": 1,
  "Options": [
    "red",
    "blue",
    "yellow"
  ],
  "ContextInfo": {}
}

`POST /send/document`

Envia documento.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Document`	`string`	Sim
`FileName`	`string`	Sim
`Caption`	`string`	Não
`Mimetype`	`string`	Não
`Id`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Document": "data:application/octet-stream;base64,aG9sYSBxdWUKdGFsCmNvbW8KXMK",
  "FileName": "file.txt",
  "Caption": "my file",
  "Mimetype": "text/plain",
  "Id": "ABCDABCD1234",
  "ContextInfo": {}
}

`POST /send/template`

Envia template.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Title`	`string`	Não
`Content`	`string`	Sim
`Footer`	`string`	Não
`Buttons`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Title": "Message title",
  "Content": "Message content",
  "Footer": "Text footer",
  "Buttons": [
    {
      "DisplayText": "tap to copy",
      "Type": "copy",
      "Id": "hello \ud83d\udc4b"
    },
    {
      "DisplayText": "Visit Site",
      "Type": "url",
      "Url": "https://www.google.com"
    },
    {
      "DisplayText": "Callme",
      "Type": "call",
      "PhoneNumber": "123811298"
    }
  ]
}

`POST /send/video`

Envia vídeo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Video`	`string`	Sim
`Caption`	`string`	Não
`Id`	`string`	Não
`JpegThumbnail`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Video": "data:video/mp4;base64,s8s77s",
  "Caption": "my video",
  "Id": "ABCDABCD1234",
  "JpegThumbnail": "AA00D010",
  "ContextInfo": {}
}

`POST /send/sticker`

Envia figurinha.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Sticker`	`string`	Sim
`Id`	`string`	Não
`PngThumbnail`	`string`	Não
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Sticker": "data:image/webp;base64,iVBOR787s7sw0",
  "Id": "ABCDABCD1234",
  "PngThumbnail": "AA00D010",
  "ContextInfo": {}
}

`POST /send/location`

Envia localização.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Name`	`string`	Não
`Id`	`string`	Não
`Latitude`	`float`	Sim
`Longitude`	`float`	Sim
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Name": "Party",
  "Id": "ABCDABCD1234",
  "Latitude": 48.85837,
  "Longitude": 2.294481,
  "ContextInfo": {}
}

`POST /send/contact`

Envia contato.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Id`	`string`	Não
`Vcard`	`object`	Sim
`ContextInfo`	`object`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "Id": "ABCDABCD1234",
  "Vcard": {
    "FullName": "Salman",
    "Phone": "7927839289",
    "Organization": "John Doe"
  },
  "ContextInfo": {}
}

`POST /send/buttons`

Envia botões.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Title`	`string`	Sim
`Content`	`string`	Sim
`Footer`	`string`	Sim
`Buttons`	`object`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "Title": "testing buttons",
  "Content": "this is content aka body",
  "Footer": "this footer is optional",
  "Buttons": [
    {
      "id": "btn1",
      "text": "button 1"
    },
    {
      "id": "btn2",
      "text": "button 2"
    }
  ]
}

`POST /send/mediabutton`

Envia botão com mídia.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Content`	`string`	Sim
`Footer`	`string`	Não
`Title`	`string`	Não
`Filename`	`string`	Não
`MessageId`	`string`	Não
`Buttons`	`array<object>`	Sim
`Type`	`string`	Sim
`Media`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "Content": "Message title",
  "Footer": "Footer text (optional)",
  "Title": "Optional header text",
  "Filename": "file.pdf",
  "MessageId": "custom-message-id-123",
  "Buttons": [],
  "Type": "image",
  "Media": "data:image/jpeg;base64,<base64-data>"
}

`POST /send/mediaurl`

Envia URL de mídia.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Sim
`Url`	`string`	Sim
`Type`	`string`	Sim
`Duration`	`number`	Não
`Caption`	`string`	Sim
`Filename`	`string`	Sim

Exemplo de body:

{
  "Jid": "123456789",
  "Url": "https://picsum.photos/536/354",
  "Type": "image",
  "Duration": 10,
  "Caption": "this is caption",
  "Filename": ""
}

`POST /send/list`

Envia lista.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`ButtonText`	`string`	Sim
`Desc`	`string`	Sim
`TopText`	`string`	Sim
`List`	`object`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "ButtonText": "Click Here",
  "Desc": "This is a list",
  "TopText": "This is a list",
  "List": [
    {
      "title": "menu button 1",
      "desc": "long description ",
      "RowId": "1"
    },
    {
      "title": "menu button 2",
      "desc": "very good description ",
      "RowId": "2"
    }
  ]
}

`POST /send/preview`

Envia prévia de link.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Text`	`string`	Sim
`MatchedURL`	`string`	Sim
`Title`	`string`	Sim
`Description`	`string`	Sim
`Image`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "Text": "This is a test message with a link preview https://google.com",
  "MatchedURL": "https://google.com",
  "Title": "Title of the preview message",
  "Description": "Description of the preview message",
  "Image": "data:image/jpeg;base64,Akd9300..."
}

`POST /send/preview2`

Envia prévia de link 2.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Text`	`string`	Sim
`MatchedURL`	`string`	Sim
`Title`	`string`	Sim
`Description`	`string`	Sim
`Image`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "Text": "This is a test message with a link preview https://google.com",
  "MatchedURL": "https://google.com",
  "Title": "Title of the preview message",
  "Description": "Description of the preview message",
  "Image": "data:image/jpeg;base64,Akd9300..."
}

`POST /send/groupinvite`

Envia convite de grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Text`	`string`	Sim
`MatchedText`	`string`	Sim
`Title`	`string`	Sim

Exemplo de body:

{
  "Phone": "987654321",
  "Text": "Open this link to join my WhatsApp Group: https://chat.whatsapp.com/LrOCfCEyd3",
  "MatchedText": "https://chat.whatsapp.com/LrOCfCEyd3",
  "Title": "my group"
}

`POST /send/locationbutton`

Envia botão de localização.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não
`Body`	`string`	Não

Exemplo de body:

{
  "Phone": "123456789",
  "Body": "\ud83d\uddfa\ufe0f *Tap the button to share your location*"
}

`POST /send/pixbutton`

Envia botão Pix.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Title`	`string`	Não
`Body`	`string`	Sim
`Footer`	`string`	Não
`PixKey`	`string`	Sim
`MerchantName`	`string`	Não
`PixType`	`string`	Não

Exemplo de body:

{
  "Phone": "123456789",
  "Title": "Payment Request",
  "Body": "Please complete your payment using the PIX button below",
  "Footer": "Thank you!",
  "PixKey": "+5511999999999",
  "MerchantName": "My Store",
  "PixType": "PHONE"
}

`POST /send/reviewpay`

Envia botão de revisar e pagar.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Title`	`string`	Não
`Body`	`string`	Sim
`Caption`	`string`	Não
`Footer`	`string`	Não
`PixKey`	`string`	Sim
`MerchantName`	`string`	Não
`PixType`	`string`	Não
`Currency`	`string`	Não
`ReferenceID`	`string`	Não
`TotalValue`	`integer`	Não
`TotalOffset`	`integer`	Não
`Items`	`array<object>`	Não

Exemplo de body:

{
  "Phone": "123456789",
  "Title": "Order Summary",
  "Body": "Please review your order and complete the payment",
  "Caption": "Your order details",
  "Footer": "Thank you for your purchase!",
  "PixKey": "+5511999999999",
  "MerchantName": "My Store",
  "PixType": "PHONE",
  "Currency": "BRL",
  "ReferenceID": "ORDER-12345",
  "TotalValue": 15000,
  "TotalOffset": 100,
  "Items": []
}

`POST /send/carousel`

Envia botão de carrossel.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /send/carouselmedia`

Envia botão de carrossel com mídia.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

Bots

`POST /bot/message`

Envia mensagem de bot.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Body`	`string`	Não
`PersonaID`	`string`	Não

Exemplo de body:

{
  "Body": "Hi",
  "PersonaID": ""
}

`GET /bot/list`

Obtém perfis de bot.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

Usuários

`POST /user/info`

Obtém usuário.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`object`	Sim

Exemplo de body:

{
  "Phone": [
    "123456789",
    "987654321"
  ]
}

`POST /user/check`

Verifica usuário.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`object`	Sim

Exemplo de body:

{
  "Phone": [
    "123456789",
    "987654321"
  ]
}

`GET /user/avatar`

Obtém avatar.

Autenticação: Token de sessão

Nenhum body JSON é necessário. A rota aceita GET e POST, mas o comportamento atual do endpoint decodifica um body. Use POST ao solicitar o avatar de outro usuário.

`POST /user/avatar`

Obtém avatar.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Preview`	`bool`	Sim

Exemplo de body:

{
  "Phone": "123456789",
  "Preview": true
}

`GET /user/contacts`

Obtém contatos.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`GET /user/privacy`

Obtém privacidade.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /user/block`

Bloqueia contato.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não

Exemplo de body:

{
  "Phone": "123456789"
}

`POST /user/unblock`

Desbloqueia contato.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não

Exemplo de body:

{
  "Phone": "123456789"
}

`GET /user/blocklist`

Obtém lista de bloqueados.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /user/profile`

Define foto de perfil.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Image`	`string`	Sim

Exemplo de body:

{
  "Image": "data:image/jpeg;base64,Akd9300..."
}

`POST /user/name`

Atualiza nome de perfil.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Name`	`string`	Não

Exemplo de body:

{
  "Name": "John Doe"
}

`POST /user/presence`

Envia presença.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Presence`	`string`	Não

Exemplo de body:

{
  "Presence": "available"
}

`GET /user/limits`

Obtém limites.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /user/parselid`

Obtém JID a partir do LID.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`LID`	`string`	Não

Exemplo de body:

{
  "LID": "123456789@lid"
}

`GET /user/appstate`

Busca estado do aplicativo.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

Contatos e transmissões

`POST /contact/add`

Adiciona contato.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não
`FirstName`	`string`	Não
`FullName`	`string`	Não
`SaveOnBook`	`boolean`	Não

Exemplo de body:

{
  "Phone": "123456789",
  "FirstName": "John",
  "FullName": "John Doe",
  "SaveOnBook": true
}

`POST /contact/remove`

Remove contato.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Não

Exemplo de body:

{
  "Phone": "123456789"
}

`POST /broadcast/listparticipants`

Lista participantes da transmissão.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`ID`	`string`	Sim

Exemplo de body:

{
  "ID": "123456789"
}

Mensagens

`POST /message/react`

Reage.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Body`	`string`	Sim
`Id`	`string`	Sim
`IsFromMe`	`boolean`	Sim

Exemplo de body:

{
  "Phone": "987654321",
  "Body": "\u2764\ufe0f",
  "Id": "3EB06F9067F80BAB89FF",
  "IsFromMe": true
}

`POST /message/presence`

Presença no chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`State`	`string`	Sim
`Media`	`string`	Não

Exemplo de body:

{
  "Phone": "987654321",
  "State": "composing",
  "Media": "audio"
}

`POST /message/markread`

Marca como lida.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`object`	Sim
`Chat`	`string`	Sim
`Sender`	`string`	Não

Exemplo de body:

{
  "Id": [
    "AABBCC11223344",
    "DDEEFF55667788"
  ],
  "Chat": "[email protected]",
  "Sender": "[email protected]"
}

`POST /message/status`

Obtém status da mensagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Sim

Exemplo de body:

{
  "Id": "987654321"
}

`POST /message/delete`

Exclui mensagem para todos.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim
`MessageID`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321",
  "MessageID": "1222222287379827392"
}

`POST /message/edit`

Edita mensagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim
`Message`	`string`	Sim
`MessageID`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321",
  "Message": "Hello World",
  "MessageID": "1222222287379827392"
}

`POST /message/downloadimage`

Baixa imagem.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /message/download/image`

Baixa imagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Url`	`string`	Sim
`DirectPath`	`string`	Não
`MediaKey`	`string`	Sim
`Mimetype`	`string`	Sim
`FileEncSHA256`	`string`	Não
`FileSHA256`	`string`	Sim
`FileLength`	`number`	Sim

Exemplo de body:

{
  "Url": "string",
  "DirectPath": "string",
  "MediaKey": "string",
  "Mimetype": "string",
  "FileEncSHA256": "string",
  "FileSHA256": "string",
  "FileLength": 0
}

`POST /message/download/video`

Baixa vídeo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Url`	`string`	Sim
`DirectPath`	`string`	Não
`MediaKey`	`string`	Sim
`Mimetype`	`string`	Sim
`FileEncSHA256`	`string`	Não
`FileSHA256`	`string`	Sim
`FileLength`	`number`	Sim

Exemplo de body:

{
  "Url": "string",
  "DirectPath": "string",
  "MediaKey": "string",
  "Mimetype": "string",
  "FileEncSHA256": "string",
  "FileSHA256": "string",
  "FileLength": 0
}

`POST /message/download/document`

Baixa documento.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Url`	`string`	Sim
`DirectPath`	`string`	Não
`MediaKey`	`string`	Sim
`Mimetype`	`string`	Sim
`FileEncSHA256`	`string`	Não
`FileSHA256`	`string`	Sim
`FileLength`	`number`	Sim

Exemplo de body:

{
  "Url": "string",
  "DirectPath": "string",
  "MediaKey": "string",
  "Mimetype": "string",
  "FileEncSHA256": "string",
  "FileSHA256": "string",
  "FileLength": 0
}

`POST /message/download/audio`

Baixa áudio.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Url`	`string`	Sim
`DirectPath`	`string`	Não
`MediaKey`	`string`	Sim
`Mimetype`	`string`	Sim
`FileEncSHA256`	`string`	Não
`FileSHA256`	`string`	Sim
`FileLength`	`number`	Sim

Exemplo de body:

{
  "Url": "string",
  "DirectPath": "string",
  "MediaKey": "string",
  "Mimetype": "string",
  "FileEncSHA256": "string",
  "FileSHA256": "string",
  "FileLength": 0
}

`POST /message/download/sticker`

Baixa figurinha.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Url`	`string`	Sim
`DirectPath`	`string`	Não
`MediaKey`	`string`	Sim
`Mimetype`	`string`	Sim
`FileEncSHA256`	`string`	Não
`FileSHA256`	`string`	Sim
`FileLength`	`number`	Sim

Exemplo de body:

{
  "Url": "string",
  "DirectPath": "string",
  "MediaKey": "string",
  "Mimetype": "string",
  "FileEncSHA256": "string",
  "FileSHA256": "string",
  "FileLength": 0
}

Chats

`POST /chat/pin`

Fixa chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321"
}

`POST /chat/unpin`

Desfixa chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321"
}

`POST /chat/archive`

Arquiva chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321"
}

`POST /chat/mute`

Silencia chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Chat`	`string`	Sim

Exemplo de body:

{
  "Chat": "987654321"
}

`POST /chat/typing/start`

Inicia digitação.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Sim

Exemplo de body:

{
  "Jid": "123456789"
}

`POST /chat/typing/stop`

Para digitação.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Sim

Exemplo de body:

{
  "Jid": "123456789"
}

`POST /chat/delete`

Exclui chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789"
}

`POST /chat/read`

Marca chat como lido.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789"
}

`POST /chat/unread`

Marca chat como não lido.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim

Exemplo de body:

{
  "Phone": "123456789"
}

`POST /chat/recording/start`

Inicia gravação.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Sim

Exemplo de body:

{
  "Jid": "123456789"
}

`POST /chat/recording/stop`

Para gravação.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Sim

Exemplo de body:

{
  "Jid": "123456789"
}

`POST /chat/disappearing-timer`

Mensagens temporárias.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`phone`	`string`	Sim
`timer`	`string`	Sim

Exemplo de body:

{
  "phone": "1276543210",
  "timer": "24h"
}

Grupos

`GET /group/list`

Lista grupos.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /group/info`

Obtém informações do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]"
}

`POST /group/invitelink`

Obtém link de convite do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`Reset`	`boolean`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "Reset": false
}

`POST /group/photo`

Define foto do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`Image`	`string`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "Image": "data:image/jpeg;base64,Akd9300..."
}

`POST /group/name`

Define nome do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`Name`	`string`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "Name": "My group name"
}

`POST /group/create`

Cria grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupName`	`string`	Não
`Participants`	`array<any>`	Não

Exemplo de body:

{
  "GroupName": "Family Group",
  "Participants": [
    "22222",
    "33333"
  ]
}

`POST /group/update`

Atualiza participante.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`ParticipantJID`	`array<any>`	Não
`Action`	`string`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "ParticipantJID": [
    "9999999999",
    "9876543128"
  ],
  "Action": "add"
}

`GET /group/myall`

Obtém meus grupos.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /group/join`

Entra no grupo via link.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Code`	`string`	Não

Exemplo de body:

{
  "Code": "123456xyz"
}

`POST /group/leave`

Sai do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupId`	`string`	Sim

Exemplo de body:

{
  "GroupId": "[email protected]"
}

`POST /group/description`

Atualiza descrição do grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`Description`	`string`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "Description": "This is new group description"
}

`POST /group/lock`

Bloqueia grupo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`Lock`	`boolean`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "Lock": true
}

`POST /group/adminonly`

Define grupo como apenas administradores.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`GroupJID`	`string`	Não
`AdminOnly`	`boolean`	Não

Exemplo de body:

{
  "GroupJID": "[email protected]",
  "AdminOnly": true
}

Comunidades

`POST /community/create`

Cria comunidade.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CommunityName`	`string`	Não

Exemplo de body:

{
  "CommunityName": "My Community"
}

`POST /community/add`

Adiciona à comunidade.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CommunityJID`	`string`	Não
`GroupJID`	`Array`	Não

Exemplo de body:

{
  "CommunityJID": "[email protected]",
  "GroupJID": [
    "[email protected]",
    "[email protected]"
  ]
}

`POST /community/remove`

Remove da comunidade.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CommunityJID`	`string`	Não
`GroupJID`	`Array`	Não

Exemplo de body:

{
  "CommunityJID": "[email protected]",
  "GroupJID": [
    "[email protected]",
    "[email protected]"
  ]
}

Etiquetas

`POST /label/chat`

Etiqueta chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`LabelId`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "LabelId": "1"
}

`POST /label/message`

Etiqueta mensagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`LabelId`	`string`	Não
`MessageId`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "LabelId": "1",
  "MessageId": "9812JHSHAS87"
}

`POST /label/edit`

Edita etiqueta.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`LabelId`	`string`	Não
`Name`	`string`	Não
`Color`	`number`	Não
`Action`	`boolean`	Não

Exemplo de body:

{
  "LabelId": "1",
  "Name": "My Label",
  "Color": 1,
  "Action": true
}

`POST /unlabel/chat`

Remove etiqueta de chat.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`LabelId`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "LabelId": "1"
}

`POST /unlabel/message`

Remove etiqueta de mensagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`LabelId`	`string`	Não
`MessageId`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "LabelId": "1",
  "MessageId": "9812JHSHAS87"
}

Newsletters

Cria newsletter.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Name`	`string`	Não
`Description`	`string`	Não

Exemplo de body:

{
  "Name": "My Newsletter",
  "Description": "This is my newsletter"
}

Lista newsletter.

Autenticação: Token de sessão

Nenhum body JSON é necessário. Obtém newsletter.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789"
}

Obtém convite de newsletter.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Key`	`string`	Não

Exemplo de body:

{
  "Key": "123456789"
}

Inscreve-se na newsletter.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789"
}

Obtém mensagens da newsletter.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`Count`	`number`	Não
`BeforeId`	`number`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "Count": 10,
  "BeforeId": 123456789
}

Negócios

`POST /business/get/profile`

Obtém perfil comercial.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789"
}

`GET /business/get/categories`

Obtém categorias comerciais.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /business/update/desc`

Atualiza descrição comercial.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Desc`	`string`	Não

Exemplo de body:

{
  "Desc": "This is my business description"
}

`POST /business/update/address`

Atualiza endereço comercial.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Address`	`string`	Não

Exemplo de body:

{
  "Address": "This is my business address"
}

`POST /business/update/email`

Atualiza e-mail comercial.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Email`	`string`	Não

Exemplo de body:

{
  "Email": "[email protected]"
}

`POST /business/catalog/create`

Cria produto no catálogo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Não
`Name`	`string`	Não
`Images`	`array<string>`	Não
`Description`	`string`	Não
`Price`	`string`	Não
`Currency`	`string`	Não
`Url`	`string`	Não
`IsHidden`	`boolean`	Não

Exemplo de body:

{
  "Id": "1234567890",
  "Name": "My Product",
  "Images": [],
  "Description": "This is my product",
  "Price": "100000",
  "Currency": "INR",
  "Url": "https://google.com",
  "IsHidden": false
}

`POST /business/catalog/edit`

Edita produto no catálogo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Não
`Name`	`string`	Não
`Images`	`array<string>`	Não
`Description`	`string`	Não
`Price`	`string`	Não
`Currency`	`string`	Não
`Url`	`string`	Não
`IsHidden`	`boolean`	Não

Exemplo de body:

{
  "Id": "1234567890",
  "Name": "My Product",
  "Images": [],
  "Description": "This is my product",
  "Price": "100000",
  "Currency": "INR",
  "Url": "https://google.com",
  "IsHidden": false
}

`POST /business/catalog/list`

Obtém catálogo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789"
}

`POST /business/catalog/info`

Obtém produto do catálogo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Jid`	`string`	Não
`Id`	`string`	Não

Exemplo de body:

{
  "Jid": "123456789",
  "Id": "988782362"
}

`POST /business/catalog/delete`

Exclui produto do catálogo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Não

Exemplo de body:

{
  "Id": "988782362"
}

`POST /business/catalog/show`

Exibe produto.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Não

Exemplo de body:

{
  "Id": "988782362"
}

`POST /business/catalog/hide`

Oculta produto.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Id`	`string`	Não

Exemplo de body:

{
  "Id": "988782362"
}

`POST /business/order/details`

Obtém detalhes do pedido.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`OrderId`	`string`	Sim
`Token`	`string`	Sim

Exemplo de body:

{
  "OrderId": "123456789",
  "Token": "AR7LsQpmS1K/HO24sdk5QnV80g=="
}

`POST /business/send/catalog`

Envia catálogo comercial.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Phone`	`string`	Sim
`Text`	`string`	Sim
`MatchedText`	`string`	Sim
`Title`	`string`	Sim

Exemplo de body:

{
  "Phone": "987654321",
  "Text": "Follow this link to view our catalog on WhatsApp: https://wa.me/c/123456789",
  "MatchedText": "https://wa.me/c/123456789",
  "Title": "MyShopName"
}

Chamadas

`POST /call/make`

Inicia uma chamada de áudio WhatsApp.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallTo`	`string`	Sim
`AudioFile`	`string`	Não

Exemplo de body:

{
  "CallTo": "string",
  "AudioFile": "string"
}

`POST /call/answer`

Atende uma chamada recebida rastreada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/reject`

Rejeita uma chamada recebida rastreada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/hangup`

Encerra uma chamada rastreada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/play`

Reproduz um arquivo de áudio do lado do servidor em uma chamada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim
`AudioFile`	`string`	Sim

Exemplo de body:

{
  "CallID": "string",
  "AudioFile": "string"
}

`POST /call/play/pause`

Pausa a reprodução de áudio da chamada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/play/resume`

Retoma a reprodução de áudio da chamada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/play/stop`

Para a reprodução de áudio da chamada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`POST /call/record`

Grava o áudio da chamada em WAV no servidor.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim
`Path`	`string`	Não

Exemplo de body:

{
  "CallID": "string",
  "Path": "string"
}

`POST /call/record/stop`

Para a gravação da chamada ativa.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`CallID`	`string`	Sim

Exemplo de body:

{
  "CallID": "string"
}

`GET /call/status`

Lista chamadas rastreadas ou inspeciona uma chamada por parâmetro de consulta.

Autenticação: Token de sessão

Nenhum body JSON é necessário. Consulta opcional: callID=CALL_ID retorna uma chamada rastreada. Sem ela, o endpoint retorna todas as chamadas rastreadas.

`GET /call/webrtc/config`

Retorna configuração STUN e marcador de TURN (em breve).

Autenticação: Token de sessão

Nenhum body JSON é necessário.

`POST /call/webrtc/offer`

Aceita oferta SDP do navegador e retorna resposta SDP do WaGo.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`callID`	`string`	Sim
`sdp`	`string`	Sim
`type`	`string`	Não

Exemplo de body:

{
  "callID": "string",
  "sdp": "string",
  "type": "string"
}

`POST /call/webrtc/close`

Fecha a ponte de áudio ao vivo do navegador sem encerrar a chamada.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`callID`	`string`	Sim

Exemplo de body:

{
  "callID": "string"
}

Status

`POST /status/text`

Status de texto.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Text`	`string`	Não
`TextColor`	`number`	Não
`BackgroundColor`	`number`	Não
`Font`	`number`	Não

Exemplo de body:

{
  "Text": "Hey there! I am using WhatsApp.",
  "TextColor": 4294967295,
  "BackgroundColor": 4285408638,
  "Font": 1
}

`POST /status/image`

Status de imagem.

Autenticação: Token de sessão

Campo	Tipo	Obrigatório
`Image`	`string`	Não
`Caption`	`string`	Não

Exemplo de body:

{
  "Image": "data:image/jpeg;base64,Akd9300...",
  "Caption": "this is caption"
}

`POST /status/video`

Status de vídeo.

Autenticação: Token de sessão

Nenhum body JSON é necessário.

Servidor e admin

`GET /server/ok`

Verificação de saúde.

Autenticação: Nenhuma

Nenhum body JSON é necessário.

`POST /server/license`

Lê informações da licença.

Autenticação: Token admin

Nenhum body JSON é necessário.

`GET /server/update`

Verifica ou executa o fluxo de atualização do servidor.

Autenticação: Token admin

Nenhum body JSON é necessário.

Endpoints de servidor e administração Dicionário de campos de requisição

​Como ler esta referência

​Sessões

​POST /session/init

​POST /session/connect

​POST /session/disconnect

​POST /session/logout

​GET /session/status

​GET /session/qr

​GET /session/all

​POST /session/pair

​POST /session/delete

​POST /session/scanned

​Webhooks e tempo real

​POST /webhook

​GET /webhook

​Envio de mensagens

​POST /send/text

​POST /send/image

​POST /send/audio

​POST /send/poll

​POST /send/document

​POST /send/template

​POST /send/video

​POST /send/sticker

​POST /send/location

​POST /send/contact

​POST /send/buttons

​POST /send/mediabutton

​POST /send/mediaurl

​POST /send/list

​POST /send/preview

​POST /send/preview2

​POST /send/groupinvite

​POST /send/locationbutton

​POST /send/pixbutton

​POST /send/reviewpay

​POST /send/carousel

​POST /send/carouselmedia

​Bots

​POST /bot/message

​GET /bot/list

​Usuários

​POST /user/info

​POST /user/check

​GET /user/avatar

​POST /user/avatar

​GET /user/contacts

​GET /user/privacy

​POST /user/block

​POST /user/unblock

​GET /user/blocklist

​POST /user/profile

​POST /user/name

​POST /user/presence

​GET /user/limits

​POST /user/parselid

​GET /user/appstate

​Contatos e transmissões

​POST /contact/add

​POST /contact/remove

​POST /broadcast/listparticipants

​Mensagens

​POST /message/react

​POST /message/presence

​POST /message/markread

​POST /message/status

​POST /message/delete

​POST /message/edit

​POST /message/downloadimage

​POST /message/download/image

​POST /message/download/video

​POST /message/download/document

​POST /message/download/audio

​POST /message/download/sticker

​Chats

​POST /chat/pin

​POST /chat/unpin

​POST /chat/archive

​POST /chat/mute

​POST /chat/typing/start

Como ler esta referência

Sessões

`POST /session/init`

`POST /session/connect`

`POST /session/disconnect`

`POST /session/logout`

`GET /session/status`

`GET /session/qr`

`GET /session/all`

`POST /session/pair`

`POST /session/delete`

`POST /session/scanned`

Webhooks e tempo real

`POST /webhook`

`GET /webhook`

Envio de mensagens

`POST /send/text`

`POST /send/image`

`POST /send/audio`

`POST /send/poll`

`POST /send/document`

`POST /send/template`

`POST /send/video`

`POST /send/sticker`

`POST /send/location`

`POST /send/contact`

`POST /send/buttons`

`POST /send/mediabutton`

`POST /send/mediaurl`

`POST /send/list`

`POST /send/preview`

`POST /send/preview2`

`POST /send/groupinvite`

`POST /send/locationbutton`

`POST /send/pixbutton`

`POST /send/reviewpay`

`POST /send/carousel`

`POST /send/carouselmedia`

Bots

`POST /bot/message`

`GET /bot/list`

Usuários

`POST /user/info`

`POST /user/check`

`GET /user/avatar`

`POST /user/avatar`

`GET /user/contacts`

`GET /user/privacy`

`POST /user/block`

`POST /user/unblock`

`GET /user/blocklist`

`POST /user/profile`

`POST /user/name`

`POST /user/presence`

`GET /user/limits`

`POST /user/parselid`

`GET /user/appstate`

Contatos e transmissões

`POST /contact/add`

`POST /contact/remove`

`POST /broadcast/listparticipants`

Mensagens

`POST /message/react`

`POST /message/presence`

`POST /message/markread`

`POST /message/status`

`POST /message/delete`

`POST /message/edit`

`POST /message/downloadimage`

`POST /message/download/image`

`POST /message/download/video`

`POST /message/download/document`

`POST /message/download/audio`

`POST /message/download/sticker`

Chats

`POST /chat/pin`

`POST /chat/unpin`

`POST /chat/archive`

`POST /chat/mute`

`POST /chat/typing/start`