Testando a API

Acesse o guia de referência da API para explorar e testar todos os endpoints disponíveis.

OBSERVAÇÃO GERAL — Webhook de status das mensagens

O webhook da API não retorna o conteúdo da mensagem enviada, ou seja, o body do webhook não contém o texto enviado como send text.

A API segue o mesmo padrão de funcionamento da API oficial da Meta, mantendo um modelo semelhante de requisição e resposta. Dessa forma, o webhook é utilizado principalmente para informar os eventos e status relacionados à mensagem.

Os principais status retornados pelo webhook são:

• send — mensagem enviada.
• delivery — mensagem entregue.
• read — mensagem lida.

Cada mensagem enviada gera um ID único, que pode ser utilizado para relacionar o evento recebido no webhook à mensagem originalmente enviada.Como o webhook não retorna diretamente o conteúdo da mensagem, caso seja necessário identificar o texto enviado, o sistema deverá implementar uma lógica de relacionamento utilizando o ID da mensagem recebido no webhook. Por exemplo, ao receber automaticamente o status delivery, o sistema poderá utilizar o endpoint getchat, informando o ID recebido no webhook, para localizar o registro correspondente da mensagem enviada. A partir desse registro, será possível identificar o conteúdo da mensagem, bem como outras informações relacionadas ao envio e ao responsável pelo envio.

Documentação da API:
https://api.uzapi.com.br/docs

Swagger:
https://api.uzapi.com.br/swagger

Enviando uma mensagem

Endpoint

POST {{baseUrl}}/:username/:version/:phone_number_id/messages

Obtendo os parâmetros da API

Antes de realizar a requisição, acesse o painel da sua instância e obtenha os seguintes parâmetros:

Configurando a autenticação

A API utiliza autenticação do tipo Bearer Token.

No Postman, crie uma variável de ambiente:

Nome: token

Valor:

eyJhbGcxxxxxx

Em seguida, na aba Authorization da requisição, selecione:

Type: Bearer Token
Token: {{token}}

Testando o endpoint /messages

Corpo da requisição

{
  "to": "55219xxxxxxxx",
  "delayMessage": 0,
  "delayTyping": 0,
  "type": "text",
  "text": {
    "body": "Olá Mundo!"
  }
}

Exemplo de resposta

{
  "status": "success",
  "message": "Mensagem colocada na fila de envios com sucesso!",
  "queueId": "BB3A206B22B97B70E3E2F74197747CB3",
  "messageId": "3EB033430E4C1324B0E016",
  "contacts": [
    {
      "input": "5521xxxxx",
      "wa_id": "5521xxxxx"
    }
  ],
  "messages": [
    {
      "id": "wamid.PXpweDEvZWtnZTZ6Tk1rVFNFOGxZaVIzVnVyT1ZMclhUcHhVdUM9Nw=="
    }
  ]
}

Descrição da resposta

Quando a requisição for processada com sucesso, a mensagem será adicionada à fila de envio e os identificadores retornados poderão ser utilizados para rastreamento e auditoria.