Como usar a documentação da API Send do Whaticket para enviar mensagens.

Aprenda como enviar mensagens usando a documentação da API Whaticket Send e descubra os principais campos e exemplos para integrar sistemas externos à plataforma.

A API Whaticket permite o envio de mensagens através de conexões do WhatsApp integradas à plataforma.

Todas as requisições feitas à API exigem um token Bearer para autenticação. Esse token é gerado na seção Tokens do painel de controle do Whaticket.

É essencial garantir que todas as permissões necessárias sejam concedidas ao criar o token para usar corretamente as funções da API.

Servidor de API base
https://api.whaticket.com/api/v1

Como obter os dados necessários

Antes de enviar usando a API de Envio, é necessário coletar alguns identificadores dentro da plataforma.

ID do WhatsApp

O ID do WhatsApp corresponde ao identificador da conexão do WhatsApp que será usada para enviar mensagens.

Para obtê-lo:

Acessar conexões .
Clique em Editar na conexão desejada.
Copie o ID da conexão usando o ícone .

ID do departamento

O ID do departamento é usado quando você deseja atribuir o ticket gerado a um departamento específico.

Para obtê-lo:

Acesse os departamentos e chatbots .
Selecione o ícone de lápis para editar o departamento.
Copie o ID do departamento usando o ícone .

ID do usuário

O ID do usuário permite atribuir automaticamente o ticket gerado a um agente específico.

Para obtê-lo:

Equipe de Acesso .
Selecione o ícone de lápis para editar o usuário.
Copie o ID do usuário usando o ícone .

ID do modelo de mensagem (Modelo)

Se você deseja usar modelos do WhatsApp Business , também precisará obter o ID do modelo.

Para obtê-lo:

Acesse os modelos de mensagens .
Selecione o ícone de exibição .
Copie o ID que aparece ao lado de “Editar modelo” .

Ative a API usando um token

A ativação da API no Whaticket é feita usando o token gerado dentro da plataforma . Esse token autorizará todas as solicitações feitas à API.

Criar o token

Para gerar o token:

Acesse a seção Tokens localizada no menu à esquerda do Whaticket.
Clique no botão Novo Token .
Atribua um nome ao token.
Aceite as permissões que serão usadas para o envio de mensagens (recomenda-se selecionar todas).
Clique no botão Salvar .

Após a criação, será gerada uma chave de permissão Token .

Copie esta chave clicando no ícone da pasta para usá-la posteriormente na API.

Autorizar o uso da API

A plataforma inclui documentação interativa da API que permite a realização de testes de submissão.

Para autorizar o uso da API:

Acesse a seção Documentação localizada no menu à esquerda.
Clique no botão Autorizar .

Cole a chave do token no campo correspondente.
Feche a janela de autorização.

Quando o cadeado no campo "Autorizar" aparecer fechado , significa que a API está corretamente habilitada e pronta para uso.

Envie sua primeira mensagem

Após a ativação da API, você poderá começar a enviar mensagens a partir da documentação.

Para fazer isso:

Acesse a seção Mensagens na documentação da API.
Clique no ícone de seta para expandir as informações do ponto final.
Clique no botão "Experimentar" para editar a mensagem.

Na seção Exemplos , você encontrará diversas mensagens de exemplo que poderá usar como base para personalizar a sua mensagem.

Exemplo de mensagem usando a API:

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "body": "Hola kb-article-module-5, gracias por tu mensaje.",
 "contactData": {
 "name": "Nombre del contacto",
 "email": "correo@ejemplo.com",
 "number": "5513991113966",
 "force": true,
 "customFields": [
 {
 "name": "Consulta",
 "value": "Necesito más info"
 }
 ]
 }
 }
 ]
 }

Exemplos de envios usando a API

Envie uma mensagem personalizada

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "name": "Test Contact",
 "body": "This is a test message body..."
 }
 ]
 }

Enviar a mesma mensagem para vários contatos

{
 "whatsappId": "TU_WHATSAPP_ID",
 "globalBody": "Hi, im here to talk about...!",
 "messages": [
 {
 "number": "5513991113966"
 },
 {
 "number": "5513991113966"
 },
 {
 "number": "5513991113966"
 }
 ]
 }

Enviar o mesmo arquivo de mídia para vários contatos

{
 "whatsappId": "TU_WHATSAPP_ID",
 "globalMediaKey": "mstile150x150_88e21cba92da4f1ca4cfbeef453b1fbe.png",
 "globalMediaType": "image",
 "messages": [
 {
 "number": "5513991113966"
 },
 {
 "number": "5513991113966"
 },
 {
 "number": "5513991113966"
 }
 ]
 }

Enviar mensagem e atribuí-la a um usuário e departamento.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "body": "Mensaje asignado",
 "ticketData": {
 "userId": "ID_USUARIO",
 "queueId": "ID_DEPARTAMENTO",
 "status": "pending"
 }
 }
 ]
 }

Envie uma mensagem e atribua seu ingresso a um usuário e fila predeterminados.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "name": "Test Contact",
 "body": "This is a test message body...",
 "ticketData": {
 "status": "open",
 "userId": "d58b13dd-3dd5-47e5-a601-a8383b8cd58b",
 "queueId": "324d90c5-a4f2-4fb6-a9f9-e28dd6839609",
 "force": true
 }
 }
 ]
 }

Envie uma mensagem e mantenha o ticket atribuído até uma data específica.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "name": "Test Contact",
 "body": "This is a test message body...",
 "ticketData": {
 "userId": "d58b13dd-3dd5-47e5-a601-a8383b8cd58b",
 "keepAssigned": true,
 "keepAssignedUntil": "2025-09-30",
 "force": true
 }
 }
 ]
 }

Envie uma mensagem e complete seu contato com informações personalizadas.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "messages": [
 {
 "number": "5513991113966",
 "body": "This is a test message body...",
 "contactData": {
 "name": "New name for my contact",
 "force": true,
 "customFields": [
 {
 "name": "custom_id",
 "value": "11111"
 },
 {
 "name": "country",
 "value": "Brazil"
 }
 ]
 }
 }
 ]
 }

Envie mensagens com modelos predefinidos usando a API do WhatsApp Business.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "templateId": "TU_TEMPLATE_ID",
 "messages": [
 {
 "number": "5513991113966",
 "name": "Test Contact"
 }
 ]
 }

Enviar mensagens de modelo da API do WhatsApp Business com variáveis

{
 "whatsappId": "TU_WHATSAPP_ID",
 "templateId": "TU_TEMPLATE_ID",
 "messages": [
 {
 "number": "5513991113966",
 "name": "Test Contact",
 "variables": [
 {
 "name": "1",
 "value": ""
 },
 {
 "name": "2",
 "value": ""
 }
 ]
 }
 ]
 }

Envie um modelo com mídia usando a API do WhatsApp.

{
 "whatsappId": "TU_WHATSAPP_ID",
 "globalMediaKey": "TU_Media_Key",
 "globalMediaType": "image",
 "templateId": "TU_TEMPLATE_ID",
 "messages": [
 {
 "number": "5513991113966",
 "body": "This is the body of the message"
 },
 {
 "number": "5513991113966",
 "body": "This is the body of the message"
 },
 {
 "number": "5513991113966",
 "body": "This is the body of the message"
 }
 ]
 }

Explicação dos campos de código

Enviar mensagens

• ID do WhatsApp
  ID de conexão do WhatsApp.
• nomeDaCampanha
  Nome da campanha.
• globalBody
  Mensagem global para todos os contatos.
• globalMediaKey
  Chave do arquivo a ser enviado.
• globalMediaType
  Tipo de mídia.
• modelo
  Modelo de mensagem da API do WhatsApp.
• nome
  Nome do modelo.
• idioma
  Linguagem modelo.
• variáveis
  Variáveis incluídas na mensagem.
• mídia
  Arquivo de modelo em anexo.
• link
  Link para o arquivo.
• nome do arquivo
  Nome do arquivo enviado.
• mensagens
  Corpo da mensagem.
• número
  Número de WhatsApp do contato.
• nome
  Nome para contato.
• corpo
  Conteúdo da mensagem individual.

Crie um contato no Whaticket usando CreateContactData.

• nome
  Nome para contato.
• número
  Número do WhatsApp.
• nome do tratamento
  Apelido ou sobrenome do contato.
• e-mail
  E-mail.
• Campos personalizados
  Campos de contato personalizados.

Exemplo:

nome: empresa
valor: Whaticket

Tem mais alguma dúvida? Não se preocupe, estamos aqui para ajudar. Entre em contato com nossa equipe clicando no botão "Suporte" localizado no menu à esquerda da nossa plataforma.