Pular para o conteúdo

Mensagens

Todos os endpoints de envio requerem autenticacao via header x-api-key e identificacao da sessao via header x-instance.

O campo to aceita:

  • Numero individual: 5511999999999@s.whatsapp.net
  • Grupo: 120363000000000000@g.us

POST /chat/send/text

Envia uma mensagem de texto simples. Suporta mencoes e resposta a mensagens anteriores.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
textstringSimConteudo da mensagem
mentionsstring[]NaoLista de JIDs mencionados no texto
replyTostringNaoID da mensagem sendo respondida

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/text \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"text": "Ola, tudo bem? Seu pedido #4521 foi enviado."
}'

Response

{
"messageId": "3EB0B430A6F7DC0E2E6B12",
"messageid": "3EB0B430A6F7DC0E2E6B12"
}

POST /chat/send/image

Envia uma imagem a partir de URL publica. Suporta legenda, mencoes e resposta.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
imagestringSimURL publica da imagem
captionstringNaoLegenda da imagem
mimetypestringNaoMIME type (ex: image/jpeg)
mentionsstring[]NaoLista de JIDs mencionados
replyTostringNaoID da mensagem sendo respondida

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/image \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"image": "https://cdn.minhaempresa.com.br/produtos/camiseta-azul.jpg",
"caption": "Camiseta Azul - Tamanho M - R$ 89,90"
}'

Response

{
"messageId": "3EB0C1A2B3D4E5F607A819",
"messageid": "3EB0C1A2B3D4E5F607A819"
}

POST /chat/send/audio

Envia um arquivo de audio. Com ptt: true, aparece como mensagem de voz (bolinha verde).

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
audiostringSimURL publica do audio
pttbooleanNaoSe true, envia como mensagem de voz
replyTostringNaoID da mensagem sendo respondida

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/audio \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"audio": "https://cdn.minhaempresa.com.br/audios/confirmacao-pedido.ogg",
"ptt": true
}'

Response

{
"messageId": "3EB0D2E3F4A5B6C708D920",
"messageid": "3EB0D2E3F4A5B6C708D920"
}

POST /chat/send/video

Envia um video a partir de URL publica. Suporta legenda e mencoes.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
videostringSimURL publica do video
captionstringNaoLegenda do video
mentionsstring[]NaoLista de JIDs mencionados
replyTostringNaoID da mensagem sendo respondida

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/video \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"video": "https://cdn.minhaempresa.com.br/videos/tutorial-produto.mp4",
"caption": "Tutorial de uso do produto"
}'

Response

{
"messageId": "3EB0E3F4A5B6C7D809EA21",
"messageid": "3EB0E3F4A5B6C7D809EA21"
}

POST /chat/send/document

Envia um documento (PDF, planilha, etc.) com nome de arquivo personalizado.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
documentstringSimURL publica do documento
filenamestringSimNome do arquivo exibido ao destinatario
mimetypestringNaoMIME type (ex: application/pdf)
mentionsstring[]NaoLista de JIDs mencionados
replyTostringNaoID da mensagem sendo respondida

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/document \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"document": "https://cdn.minhaempresa.com.br/docs/orcamento-2026.pdf",
"filename": "orcamento-2026.pdf"
}'

Response

{
"messageId": "3EB0F4A5B6C7D8E90AFB22",
"messageid": "3EB0F4A5B6C7D8E90AFB22"
}

POST /chat/send/sticker

Envia um sticker (figurinha) a partir de URL de imagem WebP.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
stickerstringSimURL publica do sticker (formato WebP)

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/sticker \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"sticker": "https://cdn.minhaempresa.com.br/stickers/obrigado.webp"
}'

Response

{
"messageId": "3EB0A5B6C7D8E9F00B1C23",
"messageid": "3EB0A5B6C7D8E9F00B1C23"
}

POST /chat/send/location

Envia uma localizacao com coordenadas e nome do local.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
latitudenumberSimLatitude do local
longitudenumberSimLongitude do local
namestringNaoNome exibido no mapa

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/location \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"latitude": -23.5505,
"longitude": -46.6333,
"name": "Av. Paulista, 1000 - Sao Paulo"
}'

Response

{
"messageId": "3EB0B6C7D8E9F0A10C2D24",
"messageid": "3EB0B6C7D8E9F0A10C2D24"
}

POST /chat/send/contact

Envia um cartao de contato (vCard).

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
namestringSimNome exibido do contato
vcardstringSimConteudo vCard completo

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/contact \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"name": "Maria Oliveira",
"vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Maria Oliveira\nTEL;type=CELL:+5521987654321\nEND:VCARD"
}'

Response

{
"messageId": "3EB0C7D8E9F0A1B20D3E25",
"messageid": "3EB0C7D8E9F0A1B20D3E25"
}

POST /chat/send/poll

Envia uma enquete com opcoes de resposta.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
questionstringSimPergunta da enquete
optionsstring[]SimLista de opcoes (min 2, max 12)
maxAnswersnumberNaoMaximo de respostas por pessoa (default: 1)

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/poll \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "120363041524927604@g.us",
"question": "Melhor horario para a reuniao?",
"options": ["09:00", "14:00", "16:00"],
"maxAnswers": 1
}'

Response

{
"messageId": "3EB0D8E9F0A1B2C30E4F26",
"messageid": "3EB0D8E9F0A1B2C30E4F26"
}

POST /chat/send/buttons

Envia uma mensagem interativa com botoes de resposta rapida.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
bodystringSimTexto principal da mensagem
footerstringNaoTexto do rodape
buttonsobject[]SimLista de botoes (max 3)
buttons[].idstringSimIdentificador unico do botao
buttons[].textstringSimTexto exibido no botao

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/buttons \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"body": "Seu pedido #4521 esta pronto. O que deseja fazer?",
"footer": "Responda em ate 24h",
"buttons": [
{ "id": "confirmar", "text": "Confirmar entrega" },
{ "id": "reagendar", "text": "Reagendar" },
{ "id": "cancelar", "text": "Cancelar pedido" }
]
}'

Response

{
"messageId": "3EB0E9F0A1B2C3D40F5A27",
"messageid": "3EB0E9F0A1B2C3D40F5A27"
}

POST /chat/send/list

Envia uma mensagem com lista de opcoes organizadas em secoes.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
titlestringSimTitulo da mensagem
bodystringSimTexto principal
footerstringNaoTexto do rodape
buttonTextstringSimTexto do botao que abre a lista
sectionsobject[]SimSecoes com itens da lista
sections[].titlestringSimTitulo da secao
sections[].rowsobject[]SimItens da secao
sections[].rows[].idstringSimIdentificador unico do item
sections[].rows[].titlestringSimTitulo do item
sections[].rows[].descriptionstringNaoDescricao do item

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/list \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"title": "Catalogo de Produtos",
"body": "Selecione um produto para mais detalhes",
"footer": "Precos sujeitos a alteracao",
"buttonText": "Ver produtos",
"sections": [
{
"title": "Camisetas",
"rows": [
{ "id": "cam_001", "title": "Camiseta Basica", "description": "100% algodao - R$ 49,90" },
{ "id": "cam_002", "title": "Camiseta Premium", "description": "Pima cotton - R$ 89,90" }
]
},
{
"title": "Calcas",
"rows": [
{ "id": "cal_001", "title": "Calca Jeans Slim", "description": "Stretch - R$ 149,90" }
]
}
]
}'

Response

{
"messageId": "3EB0F0A1B2C3D4E50A6B28",
"messageid": "3EB0F0A1B2C3D4E50A6B28"
}

POST /chat/send/link

Envia uma mensagem com preview de link (Open Graph).

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
urlstringSimURL do link
captionstringNaoTexto adicional exibido acima do preview
titlestringNaoTitulo do preview (sobrescreve OG title)
descriptionstringNaoDescricao do preview (sobrescreve OG description)

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/link \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"url": "https://minhaempresa.com.br/produtos/camiseta-azul",
"caption": "Confira nosso lancamento!",
"title": "Camiseta Azul Premium",
"description": "100% algodao pima, disponivel em todos os tamanhos"
}'

Response

{
"messageId": "3EB0A1B2C3D4E5F60B7C29",
"messageid": "3EB0A1B2C3D4E5F60B7C29"
}

POST /chat/send/edit

Edita o texto de uma mensagem ja enviada.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do chat onde a mensagem foi enviada
idstringSimID da mensagem original a ser editada
textstringSimNovo conteudo da mensagem

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/edit \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"id": "3EB0B430A6F7DC0E2E6B12",
"text": "Correcao: seu pedido #4521 sera entregue amanha."
}'

Response

{
"messageId": "3EB0B430A6F7DC0E2E6B12",
"messageid": "3EB0B430A6F7DC0E2E6B12"
}

POST /chat/send/ptv

Envia um video em formato circular (PTV, video note). Aparece como bolha redonda no chat.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
videostringSimURL publica do video

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/ptv \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"video": "https://cdn.minhaempresa.com.br/videos/saudacao-cliente.mp4"
}'

Response

{
"messageId": "3EB0B2C3D4E5F6A70C8D30",
"messageid": "3EB0B2C3D4E5F6A70C8D30"
}

POST /chat/send/carousel

Envia um carrossel de cards com imagem, texto e botoes. Cada card pode ter botoes de resposta rapida ou URL.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
messagestringSimTexto principal acima do carrossel
carouselobject[]SimLista de cards do carrossel
carousel[].textstringNaoTexto do card
carousel[].mediaUrlstringNaoURL da midia do card
carousel[].mediaTypestringNaoTipo de midia (image, video)
carousel[].filenamestringNaoNome do arquivo de midia
carousel[].captionstringNaoLegenda da midia
carousel[].buttonsobject[]NaoBotoes do card
carousel[].buttons[].typestringSimTipo do botao (quick_reply ou url)
carousel[].buttons[].idstringNaoID do botao (para quick_reply)
carousel[].buttons[].labelstringSimTexto do botao
carousel[].buttons[].urlstringNaoURL de destino (para url)

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/carousel \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"message": "Confira nossos destaques da semana:",
"carousel": [
{
"text": "Camiseta Premium",
"mediaUrl": "https://cdn.minhaempresa.com.br/produtos/camiseta.jpg",
"mediaType": "image",
"buttons": [
{ "type": "quick_reply", "id": "buy_cam", "label": "Comprar" },
{ "type": "url", "label": "Ver detalhes", "url": "https://minhaempresa.com.br/p/camiseta" }
]
},
{
"text": "Calca Jeans Slim",
"mediaUrl": "https://cdn.minhaempresa.com.br/produtos/calca.jpg",
"mediaType": "image",
"buttons": [
{ "type": "quick_reply", "id": "buy_cal", "label": "Comprar" }
]
}
]
}'

Response

{
"messageId": "3EB0C3D4E5F6A7B80D9E31",
"messageid": "3EB0C3D4E5F6A7B80D9E31"
}

POST /chat/send/event

Envia um convite de evento com data, local e detalhes.

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario (normalmente grupo)
namestringSimNome do evento
descriptionstringNaoDescricao do evento
startTimenumberSimUnix timestamp de inicio (segundos)
endTimenumberNaoUnix timestamp de termino (segundos)
locationstringNaoEndereco do evento
latitudenumberNaoLatitude do local
longitudenumberNaoLongitude do local
extraGuestsAllowedbooleanNaoSe convidados podem levar acompanhantes
isCanceledbooleanNaoSe true, cancela o evento
isScheduleCallbooleanNaoSe o evento e uma chamada agendada

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/event \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "120363041524927604@g.us",
"name": "Reuniao de Planejamento Q3",
"description": "Revisao de metas e definicao de prioridades para o trimestre.",
"startTime": 1780340400,
"endTime": 1780347600,
"location": "Sala 301 - Escritorio SP",
"latitude": -23.5612,
"longitude": -46.6560,
"extraGuestsAllowed": false
}'

Response

{
"messageId": "3EB0D4E5F6A7B8C90EAF32",
"messageid": "3EB0D4E5F6A7B8C90EAF32"
}

POST /chat/send/flow

Envia uma mensagem interativa com WhatsApp Flows (formularios e fluxos personalizados).

Parameters

NomeTipoObrigatorioDescricao
tostringSimJID do destinatario
bodystringSimTexto principal da mensagem
headerstringNaoTexto do cabecalho
footerstringNaoTexto do rodape
buttonsobject[]SimConfiguracao dos botoes de flow
buttons[].namestringSimNome do botao (identificador)
buttons[].buttonParamsJSONstringSimJSON com parametros do botao (flow_id, flow_action, etc.)
buttons[].paramsJSONstringNaoJSON com dados iniciais do flow
buttons[].messageVersionnumberNaoVersao da mensagem

Request

Terminal window
curl -X POST https://api.wi.api.br/chat/send/flow \
-H "x-api-key: $WIAPI_KEY" \
-H "x-instance: session_01" \
-H "Content-Type: application/json" \
-d '{
"to": "5511998765432@s.whatsapp.net",
"body": "Preencha o formulario para agendar sua consulta.",
"header": "Agendamento",
"footer": "Horarios sujeitos a disponibilidade",
"buttons": [
{
"name": "flow_reply",
"buttonParamsJSON": "{\"flow_id\":\"1234567890\",\"flow_action\":\"navigate\",\"flow_token\":\"abc123\"}",
"paramsJSON": "{\"screen\":\"APPOINTMENT\"}",
"messageVersion": 3
}
]
}'

Response

{
"messageId": "3EB0E5F6A7B8C9D01FB033",
"messageid": "3EB0E5F6A7B8C9D01FB033"
}