Resumo

Se você está usando o recurso de Vários Números de WhatsApp do Wati, este guia explica como usar a API do Wati em diferentes números conectados.

Instruções

Se a sua conta Wati tiver vários números de WhatsApp conectados, você pode usar esses números para enviar e receber mensagens por meio da API.

Para garantir que uma solicitação de API use o número de WhatsApp correto, pode ser necessário incluir uma chave adicional no payload ou na URL da solicitação. A chave necessária e a forma de transmiti-la dependem do endpoint da API que você utilizar.

Este guia lista as APIs do Wati que atualmente suportam vários números de WhatsApp e explica como especificar o número de WhatsApp para cada solicitação de API.

Antes de começar

Autenticação: crie um token de API com escopo em Connector > API > Create API Token.

Host: https://live-mt-server.wati.io

Os caminhos v1 incluem /{tenantId}/ após o host: https://live-mt-server.wati.io/{tenantId}/api/v1/...
Os caminhos v3 NÃO incluem /{tenantId}/: https://live-mt-server.wati.io/api/ext/v3/...

Formato do número de telefone: Use apenas dígitos com o código do país, sem o símbolo "+". Exemplo: 85264318722.

Nota:

A v3 é recomendada para todas as novas integrações. A v1 é legada, mas ainda é suportada.

Uma resposta 200 significa que sua solicitação foi aceita, não que a mensagem foi entregue. A entrega é confirmada pelos webhooks de Entregue, Lido ou Respondido. Falhas são relatadas pelo webhook de Falha na Mensagem de Modelo (Template Message Failed).

Endpoints da API v1

1. Enviar Mensagem de Modelo (Template Message)

Endpoint: POST /{tenantId}/api/v1/sendTemplateMessage

Parâmetro	Local	Notas
`channel_number`	Corpo (Body)	O número de onde enviar
`target`	Corpo (Body)	Número de telefone, ContactId ou BSUID do destinatário. Quando fornecido, `whatsappNumber` é opcional.

2. Enviar Mensagens de Modelo (em massa)

Endpoint: POST /{tenantId}/api/v1/sendTemplateMessages

Parâmetro	Local	Notas
`channel_number`	Corpo (Body)	O número de onde enviar

3. Enviar Mensagem de Modelo via CSV

Endpoint: POST /{tenantId}/api/v1/sendTemplateMessageCSV

Parâmetro	Local	Notas
`channelNumber`	Query	O número de onde enviar

4. Atualizar Status do Chat

Endpoint: POST /{tenantId}/api/v1/updateChatStatus

Parâmetro	Local	Notas
`channelPhoneNumber`	Corpo (Body)	O número cujo status de chat você deseja atualizar

5. Obter mensagens por número de WhatsApp

Endpoint: GET /{tenantId}/api/v1/getMessages/{whatsappNumber}

Parâmetro	Local	Notas
`tenantId`	Path	Seu ID de tenant no Wati
`whatsappNumber`	Path	O número de WhatsApp do destinatário
`channelPhoneNumber`	Query	O número conectado do qual buscar as mensagens

6. Endpoints que aceitam channelPhoneNumber como parâmetro de consulta

Os endpoints a seguir usam channelPhoneNumber como parâmetro de consulta (query parameter) para especificar qual número conectado usar. Para sendSessionMessage, messageText também é um parâmetro de consulta.

Endpoint	Método
`/{tenantId}/api/v1/sendSessionMessage/{whatsappNumber}`	POST
`/{tenantId}/api/v1/sendSessionFile/{whatsappNumber}`	POST
`/{tenantId}/api/v1/sendSessionFileViaUrl/{whatsappNumber}`	POST
`/{tenantId}/api/v1/sendInteractiveButtonsMessage/{whatsappNumber}`	POST
`/{tenantId}/api/v1/sendInteractiveListMessage/{whatsappNumber}`	POST
`/{tenantId}/api/v1/assignOperator/{whatsappNumber}`	POST

Para todos os endpoints acima: whatsappNumber (path) é opcional quando target é fornecido.

7. APIs que funcionam sem especificar um número

Os dados de contato são compartilhados entre todos os números conectados, portanto, esses endpoints não exigem um número de canal:

API	Endpoint
Adicionar Contato	`POST /{tenantId}/api/v1/addContact/{whatsappNumber}`
Atualizar Atributos do Contato	`POST /{tenantId}/api/v1/updateContactAttributes/{whatsappNumber}`
Atualizar Atributos para Vários Contatos	`POST /{tenantId}/api/v1/updateContactAttributesForMultiContacts` (Apenas plano Business)
Obter Lista de Contatos	`GET /{tenantId}/api/v1/getContacts`

API v3 — Recomendada para novas integrações

A v3 é a versão recomendada para todas as novas integrações. Ela não usa /{tenantId}/ no caminho.

Escopos de Token — crie em Connector > API > Create API Token:

contactsv3:* — operações de contato
conversationsv3:* — operações de conversa
messagetemplatev3:write — envio de modelos

Listar números conectados

Endpoint: GET https://live-mt-server.wati.io/api/ext/v3/channels

Retorna todos os números de WhatsApp conectados à sua conta Wati.

Enviar Mensagem de Modelo (v3)

Use o campo channel no corpo da solicitação para especificar de qual número enviar.

O campo target aceita:

Número de telefone — 85264318722
ContactId
BSUID
Formato com escopo de canal — Channel:85264318722

Suporte da API para vários números de WhatsApp

API	Vários números suportados
Enviar mensagem de modelo	Sim
Enviar mensagens de modelo	Sim
Enviar mensagem de modelo via CSV	Sim
Enviar mensagem de sessão	Sim
Enviar arquivo de sessão	Sim
Enviar arquivo de sessão via URL	Sim
Enviar mensagem de botões interativos	Sim
Enviar mensagem de lista interativa	Sim
Atribuir operador	Sim
Atualizar status do chat	Sim
Obter mensagens por número de WhatsApp	Sim
Obter lista de contatos	Sim
Adicionar contato	Sim
Atualizar atributos do contato	Sim
Atualizar atributos para vários contatos	Sim (Apenas plano Business)

Para obter mais informações sobre as APIs do Wati, consulte nossa documentação oficial para desenvolvedores.

Suporte da API do Wati para múltiplos números de WhatsApp