Skip to main content
A API pública do Connecta DESK dá acesso, em /api/v1, às mesmas funções que você usa na plataforma: enviar e ler mensagens, abrir e encerrar atendimentos, manter contatos e campos personalizados, trabalhar nos painéis do CRM, disparar campanhas e consultar relatórios. Toda chamada é autenticada por um token da empresa, criado no painel com as permissões de cada módulo e método. Um token que só tem GET em contatos consegue ler contatos e nada além disso.

Primeira chamada

Crie o token e receba sua primeira resposta em poucos minutos.

Autenticação

Formato do token, header e o que faz a API responder 401.

Permissões

Como o token libera cada módulo e cada método.

Referência

Os 150 endpoints, com corpo da requisição, resposta e exemplos prontos para executar.

​
O que dá para fazer

Conversas

Envie texto, mídia, template e mensagem interativa. Abra, transfira, encerre e qualifique atendimentos.

Cadastros

Contatos com campos personalizados, tags, filas, tipos de qualificação, respostas rápidas e usuários da empresa.

CRM e produtos

Painéis, etapas, cards, histórico e anotações. Catálogo de produtos com categorias e desempenho em vendas.

Campanhas e dados

Disparos em massa com controle de execução, além de relatórios de conversas, automações e dashboards.

​
Como a API se comporta

Três regras valem para todos os endpoints. Conhecer essas regras antes da primeira integração ajuda a entender a maior parte das respostas que você vai receber.
O token pertence à empresa, e não a um usuário. Se você enviar companyId no corpo ou na query, o valor é ignorado e a API usa sempre a empresa do token. A regra vale também para os endpoints que aceitam esse campo por compatibilidade.
Todo endpoint de lista é paginado. O meta traz apenas page, perPage e hasMore e não informa o total de registros. Para saber se existe outra página, use hasMore. Veja Paginação.
POST /messages responde 202 com um jobId e faz o envio em segundo plano. O resultado fica disponível em GET /messages/jobs/{jobId}. Veja Enviar mensagens.

​
Antes de começar

Para criar tokens, você precisa de um usuário administrador da empresa. Atendentes não veem o menu Integrações.
A URL base é:
Instalações próprias (on-premise) usam o domínio do próprio ambiente, seguido de /api/v1.