Skip to main content
A API REST do ChatClean permite que scripts e integrações façam o que você faz no app: criar e listar conversas, enviar mensagens, atribuir conversas, gerenciar contatos, etiquetas, times, canais, respostas prontas, automações e webhooks, e ler os relatórios de atendimento.

URL base

As rotas da conta começam em /api/v1/accounts/{account_id}. O account_id é o número que aparece no endereço do app depois de /app/accounts/. Por exemplo, em https://chat.chatclean.com.br/app/accounts/3/dashboard, o account_id é 3.

Autenticação

Toda requisição envia um token no cabeçalho Authorization, como token Bearer:
O cabeçalho antigo api_access_token: SEU_TOKEN continua aceito, mas use o Bearer em integrações novas.

Onde encontrar o token

O token pessoal fica no seu perfil: clique no seu nome, no rodapé do menu lateral, escolha Configurações do Perfil e copie o Token de acesso. O botão Reiniciar gera um token novo e invalida o anterior. Veja Perfil. O token age com as suas permissões: um agente só enxerga, pela API, o que ele enxerga no app. Para integrações da empresa, prefira o token de um usuário administrador criado para isso.
Trate o token como uma senha. Não o coloque em código que roda no navegador nem o envie para um repositório. Se ele vazar, clique em Reiniciar no perfil.

Token de robô

Robôs (veja Robôs) têm o próprio token. Ele só acessa as rotas permitidas para robôs, como responder e transferir conversas do canal ao qual o robô está ligado.

API do cliente

As rotas que começam em /public/api/v1/inboxes/{inbox_identifier} formam a API do cliente. Elas não usam token de usuário: servem para um app ou site criar o contato e conversar com a sua empresa por um canal do tipo API. O inbox_identifier aparece nas configurações do canal. Veja Canal API.

Erros

Próximos passos

Enviar mensagens

Crie uma conversa e envie a primeira mensagem

Webhooks

Receba os eventos da conta na sua URL
As descrições dos endpoints, nas páginas geradas a seguir, ainda estão em inglês.