---
title: Como usar a documentação da API Send do Whaticket para enviar mensagens
description: "Envie mensagens pela API do Whaticket: copie os IDs de conexão, departamento, usuário e modelo, crie o token e teste o envio na aba Documentação."
---

[Pular para o conteúdo](https://help.whaticket.com/pt/articles/20842-como-usar-a-documentacao-da-api-send-do-whaticket#main-content)

- [Português](https://help.whaticket.com/pt/articles/20842-como-usar-a-documentacao-da-api-send-do-whaticket)
- [Español](https://help.whaticket.com/es/articles/20842-como-utilizar-la-documentacion-de-la-api-send-de)

Português

Mostrar submenu para traduções

[![Logo Blanco (1)](https://help.whaticket.com/hs-fs/hubfs/Logo%20Blanco%20(1).png?width=200&height=37&name=Logo%20Blanco%20(1).png)](https://help.whaticket.com/?hsLang=pt)

Abrir navegação principal

Fechar navegação principal

- - [Português](https://help.whaticket.com/pt/articles/20842-como-usar-a-documentacao-da-api-send-do-whaticket)
    - [Español](https://help.whaticket.com/es/articles/20842-como-utilizar-la-documentacion-de-la-api-send-de)

  Português
  
  Mostrar submenu para traduções
- [Login](https://app.whaticket.com/?utm_source=helpdesk&utm_medium=referral&utm_campaign=app&utm_content=header)

[Login](https://app.whaticket.com/?utm_source=helpdesk&utm_medium=referral&utm_campaign=app&utm_content=header)

 Como podemos ajudá-lo?

- Não há sugestões porque o campo de pesquisa está em branco.

1. [Help Whaticket](https://help.whaticket.com/pt/articles?hsLang=pt)
2. [Integrações e API](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt)
3. [Tokens e documentação da API](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#tokens-e-documenta%C3%A7%C3%A3o-da-api)

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

## Crie um token, encontre os IDs necessários e envie mensagens de outros sistemas pela API do Whaticket.

A API Send do [Whaticket](https://whaticket.com/) permite enviar mensagens de outros sistemas pelas suas conexões de WhatsApp, API oficial do WhatsApp e Web Chat. Toda requisição é autenticada com um **token Bearer**, criado na tela **Integrações**.

Neste artigo você encontra os IDs necessários, cria o token, faz o primeiro envio pela documentação interativa e consulta exemplos prontos.

### O que muda para sua operação

- Seu CRM, e-commerce ou automação envia mensagens pelo Whaticket sem ninguém precisar abrir a plataforma.
- Você já pode direcionar o chat criado para um departamento ou usuário específico.
- Os dados do contato, como nome, e-mail e campos personalizados, são preenchidos no mesmo envio.

### Antes de começar

- Seu perfil precisa das permissões **Visualizar** e **Criar** do grupo **Tokens de API**.
- O token usa as permissões de um perfil. Para enviar mensagens, esse perfil precisa das permissões **Criar** e **Iniciar** do grupo **Campanhas**.
- Você só consegue vincular ao token um perfil com permissões que você também tem.
- Servidor base da API: [https://api.whaticket.com/api/v1](https://api.whaticket.com/api/v1).

### Passo a passo:

#### **Copie o ID da conexão**

1. No menu à esquerda, clique em **Conexões**.
2. No menu de ações da conexão que vai enviar as mensagens, clique em **Editar**.
3. Na janela **Editar Conexão**, clique no ícone de copiar ao lado do título para copiar o ID.

![Como copiar o ID da conexão em Editar Conexão no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1777839222938.png?width=670&name=file-1777839222938.png)

Use esse ID no campo `connectionId`.

#### **Copie o ID do departamento**

1. No menu à esquerda, clique em **Departamentos & Chatbots**. Se o item não aparecer, procure em **Mais**.
2. Clique no departamento ou, no menu de ações dele, em **Editar**.
3. Clique no ícone **Copiar ID** ao lado do título.

![Como copiar o ID do departamento no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1777839277774.png?width=670&name=file-1777839277774.png)

Use esse ID no campo `queueId` quando quiser que o chat caia em um departamento específico.

#### **Copie o ID do usuário**

1. No menu à esquerda, clique em **Equipe**.
2. Clique no usuário ou, no menu de ações dele, em **Editar**.
3. Clique no ícone **Copiar ID** ao lado do título.

![Como copiar o ID do usuário em Equipe no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1777839283905.png?width=670&name=file-1777839283905.png)

Use esse ID no campo `userId` quando quiser atribuir o chat a um atendente.

#### **Copie o ID do modelo de mensagem**

1. No menu à esquerda, clique em **Modelos e Flows**. O item só aparece quando a empresa tem uma conexão da API oficial do WhatsApp.
2. Abra o modelo que você quer enviar.
3. Clique no ícone de copiar ao lado do nome do modelo.

![Como copiar o ID do modelo de mensagem no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1777839331944.png?width=670&name=file-1777839331944.png)

Use esse ID no campo `templateId`. Ele é obrigatório para conexões da API oficial do WhatsApp.

#### **Crie o token**

1. No menu à esquerda, clique em **Integrações** e fique na aba **Tokens**.
2. Clique em **Novo token**.
3. Preencha o **Nome** do token.
4. Em **Perfil**, escolha o perfil cujas permissões o token vai usar. A lista **Permissões deste perfil** mostra o que ele libera.
5. Clique em **Salvar**.
6. Na janela **Copie a chave do token**, copie a **Chave** e clique em **Concluir**.

![Como criar um novo token de API em Integrações no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1777839342135.png?width=670&name=file-1777839342135.png)

Guarde a chave em um lugar seguro: ela não aparece de novo depois que você fecha a janela. Se perder, use **Regenerar** no token para gerar uma chave nova.

#### **Autorize a documentação com o token**

1. Em **Integrações**, abra a aba **Documentação**.
2. Clique no botão **Authorize**.

![Botão Authorize na documentação da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773290490819.png?width=670&name=file-1773290490819.png)

1. Cole a chave do token no campo e clique em **Authorize**.
2. Feche a janela. Quando o cadeado do botão **Authorize** aparece fechado, a documentação está pronta para testar.

![Cadeado fechado indicando a API autorizada na documentação do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773290507905.png?width=670&name=file-1773290507905.png)

#### **Envie sua primeira mensagem**

1. Na documentação, abra a seção **Messages** e clique na rota `POST /messages` para expandir.
2. Clique em **Try it out**.
3. Em **Examples**, escolha um exemplo e troque os IDs e o número pelos seus.
4. Clique em **Execute** para enviar.

![Como testar o envio de mensagens com Try it out na documentação da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773290541943.png?width=670&name=file-1773290541943.png)

Exemplo de envio simples:

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

### Exemplos de envio pela API

#### **Enviar a mesma mensagem para vários contatos**

```
{  "connectionId": "ID_DA_CONEXAO",  "globalBody": "Hi, im here to talk about...!",  "messages": [    { "number": "5513991113966" },    { "number": "5513991113967" },    { "number": "5513991113968" }  ]}
```

#### **Enviar o mesmo arquivo para vários contatos**

Antes, envie o arquivo pela rota `POST /medias` e use a chave que ela devolve em `globalMediaKey`.

```
{  "connectionId": "ID_DA_CONEXAO",  "globalMediaKey": "mstile150x150_88e21cba92da4f1ca4cfbeef453b1fbe.png",  "globalMediaType": "image",  "messages": [    { "number": "5513991113966" },    { "number": "5513991113967" }  ]}
```

#### **Enviar e atribuir o chat a um usuário e departamento**

```
{  "connectionId": "ID_DA_CONEXAO",  "messages": [    {      "number": "5513991113966",      "name": "Test Contact",      "body": "This is a test message body...",      "ticketData": {        "status": "open",        "userId": "ID_DO_USUARIO",        "queueId": "ID_DO_DEPARTAMENTO",        "force": true      }    }  ]}
```

#### **Enviar e manter o chat com o usuário até uma data**

Com `keepAssigned`, as próximas mensagens do contato voltam para o mesmo usuário, sem passar pelo chatbot. A data de `keepAssignedUntil` precisa ser futura, no formato AAAA-MM-DD.

```
{  "connectionId": "ID_DA_CONEXAO",  "messages": [    {      "number": "5513991113966",      "name": "Test Contact",      "body": "This is a test message body...",      "ticketData": {        "userId": "ID_DO_USUARIO",        "keepAssigned": true,        "keepAssignedUntil": "2026-12-31",        "force": true      }    }  ]}
```

#### **Enviar e completar os dados do contato**

```
{  "connectionId": "ID_DA_CONEXAO",  "messages": [    {      "number": "5513991113966",      "body": "This is a test message body...",      "contactData": {        "name": "New name for my contact",        "email": "contato@exemplo.com",        "force": true,        "customFields": [          { "name": "custom_id", "value": "11111" },          { "name": "country", "value": "Brazil" }        ]      }    }  ]}
```

#### **Enviar modelo da API oficial do WhatsApp**

```
{  "connectionId": "ID_DA_CONEXAO",  "templateId": "ID_DO_MODELO",  "messages": [    { "number": "5513991113966", "name": "Test Contact" }  ]}
```

#### **Enviar modelo com variáveis**

Em `name`, use o nome da variável exatamente como aparece no modelo, ou seja, o número da variável entre chaves duplas. O exemplo pronto está na aba **Documentação**, em **Examples**. A quantidade de variáveis precisa ser a mesma do modelo.

```
{  "connectionId": "ID_DA_CONEXAO",  "templateId": "ID_DO_MODELO",  "messages": [    {      "number": "5513991113966",      "name": "Test Contact",      "variables": [        { "name": "NOME_DA_VARIAVEL_NO_MODELO", "value": "Maria" }      ]    }  ]}
```

#### **Enviar modelo com mídia**

```
{  "connectionId": "ID_DA_CONEXAO",  "templateId": "ID_DO_MODELO",  "globalMediaKey": "CHAVE_DA_MIDIA",  "globalMediaType": "image",  "messages": [    { "number": "5513991113966" },    { "number": "5513991113967" }  ]}
```

#### **Enviar mensagem pelo Web Chat**

No Web Chat, o contato é identificado por `externalId` no lugar de `number`.

```
{  "connectionId": "ID_DA_CONEXAO_WEB_CHAT",  "messages": [    {      "externalId": "user-abc-123",      "name": "Web Chat User",      "body": "Hello from the API via Web Chat channel"    }  ]}
```

### Campos da requisição

**Campos gerais**

- `connectionId`: ID da conexão que envia as mensagens. O campo antigo `whatsappId` ainda é aceito.
- `templateId`: ID do modelo. Obrigatório na API oficial do WhatsApp e proibido nos outros canais.
- `campaignName`: nome da campanha em que os envios ficam agrupados.
- `globalBody`: texto enviado para todos os contatos.
- `globalMediaKey` e `globalMediaType`: chave e tipo do arquivo enviado para todos os contatos.
- `globalVariables`: variáveis do modelo aplicadas a todas as mensagens que não tiverem as próprias.
- `fastMode`: envia sem o intervalo padrão entre mensagens. Use só em envios transacionais.
- `messages`: lista de mensagens, de 1 a 999 por requisição.

**Campos de cada mensagem**

- `number`: número do contato com DDI e DDD, só dígitos e sem zero no início. Obrigatório no WhatsApp e na API oficial.
- `externalId`: identificador do contato no Web Chat, no lugar de `number`.
- `name`: nome do contato, com pelo menos 3 caracteres. Usado ao criar um contato novo.
- `body`: texto da mensagem.
- `mediaKey` e `mediaType`: arquivo só desta mensagem.
- `variables`: variáveis do modelo só desta mensagem.

**Dados do chat (`ticketData`)**

- `status`: `open`, `pending` ou `closed`.
- `userId` e `queueId`: usuário e departamento do chat.
- `keepAssigned` e `keepAssignedUntil`: mantêm o chat com o usuário, opcionalmente até uma data.
- `aiHandling`: cria o chat com a Wäbot respondendo.
- `force`: aplica esses dados também a um chat que já existe.

**Dados do contato (`contactData`)**

- `name`, `treatmentName` (apelido ou forma de tratamento) e `email`.
- `customFields`: campos personalizados, cada um com `name` e `value`.
- `tagIds`: IDs das etiquetas aplicadas ao contato.
- `force`: atualiza um contato que já existe.

### Perguntas frequentes

**A mensagem é enviada na hora?**  
A rota `POST /messages` cria ou reaproveita uma campanha do tipo **API** e agenda os envios. Cada mensagem pode levar até 120 segundos para sair, e você acompanha os envios em **Campanhas**.

**Como respondo um chat que já existe na API oficial do WhatsApp?**  
Pela rota `POST /messages`, a API oficial sempre exige um modelo. Para responder um chat aberto, use a rota `POST /tickets/{ticketId}/messages`, descrita na mesma documentação.

**Existe limite de requisições?**  
Sim. A API aceita até 600 requisições por minuto por empresa.

**O que acontece se eu mudar o perfil do token?**  
O token passa a usar as novas permissões do perfil na hora, sem precisar criar outro token. Um perfil com token vinculado não pode ser excluído.

#### Artigos relacionados

- [Como funciona a API do Whaticket](https://help.whaticket.com/pt/articles/20822-como-funciona-nossa-api?hsLang=pt)
- [O que você pode e o que não pode fazer com a API do Whaticket](https://help.whaticket.com/pt/articles/20781-o-que-voce-pode-e-o-que-nao-pode-fazer-com-a-api?hsLang=pt)
- [N8N: como integrar o Whaticket usando a API Send](https://help.whaticket.com/pt/articles/20846-n8n-como-integrar-o-whaticket-usando-a-api-send?hsLang=pt)
- [Como criar perfis e permissões personalizados](https://help.whaticket.com/pt/articles/25213-como-criar-perfis-e-permissoes-personalizados?hsLang=pt)

Tem alguma dúvida adicional? 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.

Ainda não tem uma conta na Whaticket? [Crie sua conta e experimente grátis por 14 dias](https://whaticket.com/pt/?utm_source=helpdesk&utm_medium=referral&utm_campaign=app&utm_content=article)!

- [Primeiros Passos](https://help.whaticket.com/pt/articles/primeiros-passos?hsLang=pt)
- [Conexões](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#main-content)

    - [WhatsApp](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#whatsapp)
    - [Telegram](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#telegram)
    - [Web Chat](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#web-chat)
    - [Facebook e Instagram](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#facebook-e-instagram)
    - [TikTok](https://help.whaticket.com/pt/articles/conex%C3%B5es?hsLang=pt#tiktok)
- [API do WhatsApp](https://help.whaticket.com/pt/articles/api-do-whatsapp?hsLang=pt#main-content)

    - [Whatsapp Business API Coexistência](https://help.whaticket.com/pt/articles/api-do-whatsapp?hsLang=pt#whatsapp-business-api-coexist%C3%AAncia)
    - [Whatsapp Business API Cloud](https://help.whaticket.com/pt/articles/api-do-whatsapp?hsLang=pt#whatsapp-business-api-cloud)
    - [Templates de mensagem](https://help.whaticket.com/pt/articles/api-do-whatsapp?hsLang=pt#templates-de-mensagem)
    - [Configuração geral](https://help.whaticket.com/pt/articles/api-do-whatsapp?hsLang=pt#configura%C3%A7%C3%A3o-geral)
- [Chats](https://help.whaticket.com/pt/articles/chats?hsLang=pt#main-content)

    - [Histórico e gestão](https://help.whaticket.com/pt/articles/chats?hsLang=pt#hist%C3%B3rico-e-gest%C3%A3o)
    - [Atenção e fluxo](https://help.whaticket.com/pt/articles/chats?hsLang=pt#aten%C3%A7%C3%A3o-e-fluxo)
    - [Horários e disponibilidade](https://help.whaticket.com/pt/articles/chats?hsLang=pt#hor%C3%A1rios-e-disponibilidade)
- [Contatos](https://help.whaticket.com/pt/articles/contatos?hsLang=pt)
- [Etiquetas](https://help.whaticket.com/pt/articles/etiquetas?hsLang=pt)
- [Respostas rápidas](https://help.whaticket.com/pt/articles/respostas-r%C3%A1pidas?hsLang=pt)
- [Automação de mensagens](https://help.whaticket.com/pt/articles/automa%C3%A7%C3%A3o-de-mensagens?hsLang=pt#main-content)

    - [Envio em massa](https://help.whaticket.com/pt/articles/automa%C3%A7%C3%A3o-de-mensagens?hsLang=pt#envio-em-massa)
    - [Mensagens programadas](https://help.whaticket.com/pt/articles/automa%C3%A7%C3%A3o-de-mensagens?hsLang=pt#mensagens-programadas)
- [Wäbot IA](https://help.whaticket.com/pt/articles/w%C3%A4bot-ia?hsLang=pt#main-content)

    - [Configuração e ativação](https://help.whaticket.com/pt/articles/w%C3%A4bot-ia?hsLang=pt#configura%C3%A7%C3%A3o-e-ativa%C3%A7%C3%A3o)
    - [Créditos e token da OpenAI](https://help.whaticket.com/pt/articles/w%C3%A4bot-ia?hsLang=pt#cr%C3%A9ditos-e-token-da-openai)
    - [Base de conhecimento](https://help.whaticket.com/pt/articles/w%C3%A4bot-ia?hsLang=pt#base-de-conhecimento)
- [Equipe](https://help.whaticket.com/pt/articles/equipe?hsLang=pt)
- [Departamentos e Chatbots](https://help.whaticket.com/pt/articles/departamentos-e-chatbots?hsLang=pt#main-content)

    - [Departamentos e distribuição](https://help.whaticket.com/pt/articles/departamentos-e-chatbots?hsLang=pt#departamentos-e-distribui%C3%A7%C3%A3o)
    - [Chatbot](https://help.whaticket.com/pt/articles/departamentos-e-chatbots?hsLang=pt#chatbot)
- [Relatórios](https://help.whaticket.com/pt/articles/relat%C3%B3rios?hsLang=pt#main-content)

    - [Pesquisa de Satisfação (CSAT)](https://help.whaticket.com/pt/articles/relat%C3%B3rios?hsLang=pt#pesquisa-de-satisfa%C3%A7%C3%A3o-csat)
    - [Métricas gerais](https://help.whaticket.com/pt/articles/relat%C3%B3rios?hsLang=pt#m%C3%A9tricas-gerais)
    - [Kanban](https://help.whaticket.com/pt/articles/relat%C3%B3rios?hsLang=pt#kanban)
- [Integrações e API](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#main-content)

    - [MCP](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#mcp)
    - [Make](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#make)
    - [N8N](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#n8n)
    - [Zapier](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#zapier)
    - [Tokens e documentação da API](https://help.whaticket.com/pt/articles/integra%C3%A7%C3%B5es-e-api?hsLang=pt#tokens-e-documenta%C3%A7%C3%A3o-da-api)
- [Minha conta](https://help.whaticket.com/pt/articles/minha-conta?hsLang=pt#main-content)

    - [Perfil e acesso](https://help.whaticket.com/pt/articles/minha-conta?hsLang=pt#perfil-e-acesso)
    - [Disponibilidade](https://help.whaticket.com/pt/articles/minha-conta?hsLang=pt#disponibilidade)
- [Assinatura](https://help.whaticket.com/pt/articles/assinatura?hsLang=pt#main-content)

    - [Planos](https://help.whaticket.com/pt/articles/assinatura?hsLang=pt#planos)
    - [Pagamentos e reembolsos](https://help.whaticket.com/pt/articles/assinatura?hsLang=pt#pagamentos-e-reembolsos)
- [Perguntas frequentes](https://help.whaticket.com/pt/articles/perguntas-frequentes?hsLang=pt#main-content)

    - [Produto e políticas](https://help.whaticket.com/pt/articles/perguntas-frequentes?hsLang=pt#produto-e-pol%C3%ADticas)
    - [Erros técnicos](https://help.whaticket.com/pt/articles/perguntas-frequentes?hsLang=pt#erros-t%C3%A9cnicos)
- [Configuração](https://help.whaticket.com/pt/articles/configura%C3%A7%C3%A3o?hsLang=pt)
- [Kanban](https://help.whaticket.com/pt/articles/kanban?hsLang=pt)
- [Modelos e Flows](https://help.whaticket.com/pt/articles/modelos-e-flows?hsLang=pt#main-content)

    - [Flows](https://help.whaticket.com/pt/articles/modelos-e-flows?hsLang=pt#flows)

[![Logos Whaticket](https://help.whaticket.com/hs-fs/hubfs/Logos%20Whaticket.png?width=282&height=50&name=Logos%20Whaticket.png "Logos Whaticket")](http:/?hsLang=pt)

<https://www.instagram.com/whaticket> [mailto:contact@whaticket.com](mailto:contact@whaticket.com) <https://www.facebook.com/whaticketlatam>

Copyright © 2026, Whaticket