Chat AGPT
Chat AGPTCentral de Ajuda
Chat AGPT
Chat AGPTCentral de Ajuda
Trilhas Recursos Referência APIs Outra Nova

Nada encontrado por aqui.

APIs ▾
Pré-Requisitos das APIs Conteúdos sobre APIs ▸
API x Webhook Estrutura de API Bibliotecas
Mensagem ▸
API Digitando… Básica API Digitando…. Pro API Gravando… Básica API Gravando…. Pro API Mensagem de Texto Básica Pro API Mensagem de Texto via LID Pro API Web Mensagem de Texto Webchat API Oficial Mensagem Oficial API Oficial Mensagem Template Oficial API Oficial Mensagem Template sem variável Oficial API Oficial Template sem variável (Hub) Oficial Hub API Oficial Template com variável (Hub) Oficial Hub API Oficial Template Customizado (Hub) Oficial Hub API Mensagem Interna Todas API Mensagem para Grupos Básica API Mensagem para Grupos Pro API Mensagem de Lista Básica API Mensagem de Lista Pro API Oficial Mensagem de Lista Oficial API Mensagem via Flowbuilder Todas API Mensagem via Typebot Todas API Criar Agendamento Todas API Deletar Agendamento Todas API Enviar Contato Básica API Obter Mensagens por Ticket Todas API Obter Mensagens por Protocolo Todas API Criar Mensagens Template Meta Oficial API Obter Mensagens Template Meta Oficial API Listar Mensagens Template Meta Oficial API Obter uma Mensagem Template Meta Oficial
Mídias ▸
API Enviar Imagem por URL Básica API Enviar Imagem por URL Pro API Oficial Enviar Imagem por URL Oficial API Enviar Áudio por URL Básica API Enviar Áudio por URL Pro API Oficial Enviar Áudio por URL Oficial API Enviar Áudio Base64 Pro API Enviar Vídeo por URL Básica API Enviar Vídeo por URL Pro API Oficial Enviar Vídeo por URL Oficial API Enviar Documento por URL Básica API Enviar Documento por URL Pro API Oficial Enviar Documento por URL Oficial API Enviar Arquivos Básica Pro API Web Enviar Arquivos Webchat API Enviar Imagem por URL para Grupos Pro API Enviar Áudio por URL para Grupos Pro API Enviar Vídeo por URL para Grupos Pro API Enviar Documento por URL para Grupos Pro API Enviar Arquivos por URL para Grupos Pro
Ticket ▸
API Criar Ticket Todas API Obter um Ticket Todas API Obter Tickets Todas API Obter Tickets do Contato Todas API Obter Protocolos de um Ticket Todas API Atualizar Ticket Todas API Atualizar Tags Todas API Encerrar Ticket Todas API Encerrar Ticket em Massa Todas API Encerrar Tickets por "Dias de Inatividade" Todas API Transferir Tickets para um Setor Todas API Transferir Tickets entre Conexões Todas
Contatos ▸
API Criar Contato Todas API Criar Contato (com validação) Básica Pro API Validar Contato Básica Pro API Obter um Contato Todas API Obter Contatos Todas API Obter Contatos por Tag Todas API Atualizar Contato Todas API Deletar TODOS os Contatos Todas
Conexões ▸
API Criar Conexão Pro API Obter QR Code Pro API Status das Conexões Todas API Reiniciar Conexões Todas
Setores ▸
API Obter Filas da Empresa Todas
Equipe ▸
API Obter Usuários da Empresa Todas API Transferir Carteira de Clientes Todas
CRM ▸
API Criar Oportunidade Todas API Atualizar Oportunidade Todas API Deletar Oportunidade Todas API Criar Produto Todas API Obter Produtos Todas API Obter Produto por ID Todas API Atualizar Produto Todas API Deletar Produto Todas
Tags ▸
API Obter Tags da Empresa Todas
Tarefas ▸
API Criar Tarefa Todas API Obter Tarefas Todas
Botões no WhatsApp ▸
Pré-Requisitos dos Botões API Botão Carrossel Pro API Botão Copia e Cola Básica API Botão Copia e Cola Pro API Botão URL Básica API Botão URL Pro API Oficial Botão URL Oficial API Botão Quick Reply Básica API Botão Quick Reply Pro API Oficial Botão Quick Reply Oficial API Botão Ligação Pro API Botão Pix Pro
Extras ▸
API Enviar Status de Texto Pro API Enviar Status de Imagem Pro API Enviar Status de Vídeo Pro API Horário de Expediente Todas API Ligação (Somente Chamar) Básica
FAQ API 👾
Webhooks ▸
Webhook x API Webhook da Conexão Webhook de Filas Webhook Eventos Webhook Triggers Arquivos no Webhook
Precisa de ajuda?
(41) 3077-6744
APIs › FAQ API

FAQ API

👾
🔍

P: Fiz a chamada mas recebi erro de autenticação. O que verificar primeiro? R: São dois os tokens aceitos. O mais comum é o token da conexão, configurado em Conexões → Integrações → Token da Conexão — cada conexão tem o seu. Existe também o Token da Empresa, único para a empresa inteira, em Configurações → Token da Empresa. Nos dois casos o header da requisição deve ser Authorization: Bearer {seu_token_aqui}. Verifique se está usando o token correto para a operação desejada.

P: Autentiquei com o Token da Empresa e recebi erro 400 pedindo a conexão. Por quê? R: Porque o Token da Empresa não carrega a conexão dentro dele, e a plataforma não escolhe uma sozinha. Informe whatsappId, connectionId ou whatsappName na query string ou no corpo da requisição — em envio com arquivo, use a query string. A lista de IDs das suas conexões está em Configurações → Token da Empresa. Com o token da conexão esse erro não acontece.

P: Preciso habilitar algo antes de usar as APIs? R: Sim. Dois pré-requisitos obrigatórios: (1) a conexão precisa ter um token definido em Conexões → Integrações → Token da Conexão; (2) a funcionalidade API Externa precisa estar habilitada no plano. Se qualquer um dos dois estiver faltando, a chamada retorna erro. Entre em contato com o suporte da plataforma se precisar habilitar a API Externa.

P: Como confirmar que minhas credenciais estão corretas antes de testar endpoints complexos? R: Use o endpoint de Status da Conexão — ele só exige o token e retorna o estado atual da conexão (online/offline). Se retornar dados, autenticação e endpoint estão corretos. Se retornar erro, o problema está nas credenciais ou na URL base.

P: Qual a URL base das APIs e como montar o endpoint? R: A URL base é o backendURL da sua instância (disponível nas configurações da plataforma). Cada API tem seu path específico documentado. Estrutura completa: https://{backendURL}/api/{recurso}. Verifique sempre: (1) URL base correta para sua instância, (2) path exato do endpoint, (3) método HTTP correto (GET, POST, PUT, DELETE).

P: Posso usar o mesmo token em duas conexões diferentes? R: Não. Cada token deve ser único por conexão. Usar o mesmo token em duas conexões gera conflito e a API pode retornar erro ou responder de forma inesperada.

P: Como envio o payload? O formato importa? R: O payload deve ser JSON com Content-Type: application/json. Atenção ao tipo de cada campo. Payload malformado gera erro 422 ou similar. Sempre valide o JSON antes de enviar.

P: A API retornou erro 404. O que significa? R: O endpoint não foi encontrado. Causas mais comuns: URL base errada, path do endpoint com erro de digitação, ou o recurso buscado não existe. Verifique a URL completa caractere por caractere comparando com a documentação.

P: Tentei enviar mensagem e recebi Message Undeliverable. Por quê? R: A mensagem saiu do servidor mas não foi entregue ao destinatário. Causas: (1) o cliente bloqueou seu número; (2) o número não tem WhatsApp ativo; (3) para canais oficiais, a janela de 24h está fechada e você não usou Mensagem Template.

P: O que é a janela de 24 horas e quando ela bloqueia minha API? R: Em canais oficiais, a Meta só permite mensagens livres enquanto o cliente respondeu nos últimos 24h. Se a janela estiver fechada, apenas Mensagem Template aprovada pode ser enviada. Em canais não oficiais essa regra não se aplica formalmente.

P: Preciso enviar uma mensagem para um cliente que não interagiu há mais de 24h. Como fazer via API? R: Use a API de Mensagem Template (disponível para canais oficiais). O template precisa estar previamente aprovado pela Meta. Após o cliente responder, a janela de 24h reabre e mensagens livres voltam a funcionar.

P: Recebi erro #131008 Required parameter is missing. O que fazer? R: Esse erro é específico da API Oficial. Um campo obrigatório do Template não foi enviado. Verifique na Meta quantas variáveis o template aprovado exige e certifique-se de que o payload contém todas elas preenchidas.

P: Recebi erro #132000 Number of parameters does not match. O que fazer? R: Esse erro é específico da API Oficial. A quantidade de variáveis enviadas é diferente da quantidade que o template exige. Confira o template aprovado na Meta e ajuste o número de parâmetros no payload para bater exatamente.

P: Como transferir um ticket para outro Setor via API? R: Use o endpoint de atualização de ticket (PUT /api/tickets/updateAPI) passando o novo queueId. O ticket continua aberto e vai para o Setor especificado.

P: Como depurar uma chamada API que não está funcionando? R: Sequência recomendada: (1) verifique autenticação com o endpoint de Status da Conexão; (2) confirme método HTTP (POST, GET, PUT, DELETE); (3) confira a URL completa; (4) o cabeçalho deve conter Authorization: Bearer {seu_token_aqui}; (5) valide o JSON do payload; (6) teste com o mínimo de campos obrigatórios; (7) leia o corpo completo da resposta de erro — geralmente contém o motivo exato.

P: O cliente diz que a integração funcionava e parou de funcionar do nada.

◽ 1. Primeira checagem: status da conexão em Conexões. Se caiu para QR Code, toda a integração para — nenhuma mensagem sai nem entra até reconectar.

◽ 2. Segunda: o token mudou? O token da conexão é por conexão. Se a conexão foi recriada (excluída e readicionada), o token muda e o antigo passa a retornar 401.

← AnteriorAPI Ligação (Somente Chamar) Próximo →Webhooks