--- title: Como funciona a API do Whaticket description: "Entenda a API do Whaticket: crie o token, autorize na documentação e envie mensagens, mídias e atribua chats a atendentes e departamentos." --- [Pular para o conteúdo](https://help.whaticket.com/pt/articles/20822-como-funciona-nossa-api#main-content) - [Português](https://help.whaticket.com/pt/articles/20822-como-funciona-nossa-api) - [Español](https://help.whaticket.com/es/articles/20822-como-funciona-nuestra-api) 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/20822-como-funciona-nossa-api) - [Español](https://help.whaticket.com/es/articles/20822-como-funciona-nuestra-api) 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 funciona a API do Whaticket ## Crie um token, teste as rotas na documentação e envie mensagens, consulte conexões e atribua chats pela API. A API do [Whaticket](https://whaticket.com/) permite que outros sistemas enviem mensagens e trabalhem com chats, contatos e outros dados da sua conta. Toda chamada usa um token, e o que esse token pode fazer depende das permissões do perfil ligado a ele. ### O que dá para fazer com a API - Enviar mensagens de texto, mídias e templates para um ou vários contatos. - Consultar as conexões e reiniciar uma conexão WhatsApp QR Code desconectada. - Listar e criar contatos, e criar ou atualizar um contato existente. - Listar chats, responder, resolver, adiar, transferir, atribuir e trocar o departamento de um chat. - Consultar usuários, departamentos, respostas rápidas, mensagens agendadas e relatórios de conversas. - Gerenciar os artigos e as lacunas da base de conhecimento da Wäbot. A lista completa de rotas, com as permissões que cada uma exige, está na aba **Documentação**. ### Antes de começar - Usar a API exige conhecimento técnico. Recomendamos contar com um profissional de TI com experiência em integrações. - Para criar tokens, seu perfil precisa da permissão **Criar** no grupo **Tokens de API**. - O perfil escolhido para o token precisa das permissões de cada rota que você vai usar. Para enviar mensagens, por exemplo, são necessárias **Criar** e **Iniciar** no grupo **Campanhas**. - Em conexões **WhatsApp QR Code**, as mensagens enviadas pela API consomem créditos de campanha. Conexões de API oficial não usam créditos, mas exigem um template aprovado. ### Passo a passo: #### **Crie um token de acesso** 1. No menu à esquerda, clique em **Integrações**. 2. Na aba **Tokens**, clique em **Novo token**. 3. Dê um **Nome** ao token e escolha o **Perfil**. Em **Permissões deste perfil**, confira o que o token vai poder fazer. 4. Clique em **salvar**. 5. Na janela **Copie a chave do token**, copie a **Chave** e guarde em local seguro. Ela não aparece de novo depois que você fecha a janela. ![Como criar um token de API em Integrações no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373390185.gif?width=670&name=file-1773373390185.gif) As permissões do perfil valem a cada requisição. Se você editar o perfil, o token passa a seguir as novas permissões na hora, sem precisar gerar outro. #### **Autorize o token na documentação** 1. Em **Integrações**, abra a aba **Documentação**. 2. Clique em **Authorize**. 3. Cole a chave do token e confirme. 4. Em cada rota, use **Try it out** para preencher os campos e **Execute** para enviar a requisição. #### **Consulte suas conexões** A rota **GET /whatsapps** lista as conexões de WhatsApp com **id**, **name**, **status** e **channel**. O **id** é o que você usa para enviar mensagens e reiniciar uma conexão. O **channel** mostra se é QR Code (WHATSAPP) ou API oficial (WABA ou WABA-COEX). #### **Reinicie uma conexão desconectada** 1. Abra a rota **PATCH /whatsapps/start/{whatsappId}** e clique em **Try it out**. 2. Informe o ID da conexão. 3. Clique em **Execute**. ![Como reiniciar uma conexão pela documentação da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373889989.gif?width=670&name=file-1773373889989.gif) A rota tem o mesmo efeito de tentar reconectar na tela de **Conexões**. Ela funciona só para conexões WhatsApp QR Code com status desconectado, e o perfil do token precisa da permissão **Reiniciar** no grupo **Conexões**. #### **Envie mensagens** 1. Abra a rota **POST /messages** e clique em **Try it out**. 2. Preencha **connectionId** com o ID da conexão. 3. Em **messages**, informe para cada contato o **number** (só números, com código do país), o **name** e o **body** com o texto. 4. Clique em **Execute**. ![Envio de mensagem personalizada pela rota POST /messages da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373658923.png?width=670&name=file-1773373658923.png) Para enviar o mesmo texto a vários contatos, use **globalBody** e deixe em **messages** só o **number** de cada contato. Cada requisição aceita até 999 mensagens. ![Envio da mesma mensagem para vários contatos com globalBody na API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373693197.png?width=670&name=file-1773373693197.png) Em conexões de API oficial, informe também o **templateId** do template aprovado. #### **Envie arquivos de mídia** 1. Abra a rota **POST /medias**, clique em **Try it out** e selecione o arquivo no seu computador. ![Seleção do arquivo na rota POST /medias da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373778398.png?width=670&name=file-1773373778398.png) 1. Clique em **Execute** e copie o **mediaKey** que aparece na resposta. ![mediaKey gerado na resposta da rota POST /medias](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373799578.png?width=670&name=file-1773373799578.png) 1. Na rota **POST /messages**, informe o **connectionId**, cole o código em **globalMediaKey** e indique o tipo em **globalMediaType**: **image**, **video**, **audio** ou **document**. Para uma mídia diferente por contato, use **mediaKey** e **mediaType** dentro de cada mensagem. ![Envio de mídia para vários contatos com globalMediaKey na API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373826521.png?width=670&name=file-1773373826521.png) #### **Atribua o chat a um atendente e a um departamento** 1. Na mensagem, adicione o bloco **ticketData**. 2. Em **status**, use **open**, **pending** ou **closed**. 3. Em **userId**, informe o ID do atendente. Você copia o ID em **Equipe**, editando o usuário. 4. Em **queueId**, informe o ID do departamento, copiado em **Departamentos & Chatbots**. 5. Use **force** com valor **true** para aplicar esses dados também a um chat que já existe. ![Bloco ticketData com status do chat na API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773373965476.png?width=670&name=file-1773373965476.png) ![Como copiar o ID do usuário em Equipe no Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773374766601.gif?width=670&name=file-1773374766601.gif) ![Campo force no bloco ticketData da API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773374599683.png?width=670&name=file-1773374599683.png) Sem **ticketData**, o chat é criado em **Resolvidos**. #### **Mantenha o chat com o atendente** Pela API, você aplica as opções **Manter comigo** e **Manter comigo até** no chat criado. 1. Para manter o chat com o atendente sem prazo, use **keepAssigned** com valor **true** junto com o **userId**. ![Opção keepAssigned para manter o chat com o atendente na API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773374671789.png?width=670&name=file-1773374671789.png) 1. Para manter até uma data, adicione **keepAssignedUntil** com uma data futura (a partir de amanhã) no formato AAAA-MM-DD. O chat é liberado automaticamente no início do dia informado, à 0h no horário UTC. Para manter o chat durante um dia inteiro, informe o dia seguinte. ![Opção keepAssignedUntil com data de liberação na API do Whaticket](https://help.whaticket.com/hs-fs/hubfs/imagens%20userguiding/file-1773374692386.png?width=670&name=file-1773374692386.png) - A retenção é aplicada quando a API cria o chat. Para mudar a retenção ou a data de um chat que já existe, envie os novos valores com **force** igual a **true**. A nova data substitui a anterior. - Se enviar **keepAssigned** sem data, o chat fica com o atendente sem prazo. ### Perguntas frequentes **Existe limite de uso?** Sim. Cada rota aceita até 600 requisições por minuto. Cada mensagem pode levar até 120 segundos para ser enviada. **Onde vejo as mensagens enviadas pela API?** Em **Campanhas**. Os envios da API ficam agrupados em uma campanha por dia e por conexão, com o nome **API -** seguido da data. **O que faço se a requisição der erro?** Leia a mensagem de erro na resposta. Ela indica o campo com problema, como número fora do formato internacional ou falta de permissão no perfil do token. Revise os campos e tente de novo. **Perdi a chave do token. E agora?** Na aba **Tokens**, clique em **Regenerar**. A chave antiga para de funcionar na hora, então atualize os sistemas que a usam. #### Artigos relacionados - [Como usar a documentação da API Send do Whaticket para enviar mensagens](https://help.whaticket.com/pt/articles/20842-como-usar-a-documentacao-da-api-send-do-whaticket?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) - [Como criar perfis e permissões personalizados](https://help.whaticket.com/pt/articles/25213-como-criar-perfis-e-permissoes-personalizados?hsLang=pt) - [MCP: Conecte Claude, ChatGPT ou outro agente de IA a Whaticket](https://help.whaticket.com/pt/articles/conectar-agente-de-ia-ao-whaticket-mcp?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) [mailto:contact@whaticket.com](mailto:contact@whaticket.com) Copyright © 2026, Whaticket