Referência de API - ChatDigi
Base URL: https://api.chatdigi.digitalface.dev.br
Todos os endpoints (exceto autenticação) requerem header:
Authorization: Bearer JWT_TOKEN
Autenticação
| Método |
Endpoint |
Descrição |
| POST |
/auth/login |
Login com email/senha |
| POST |
/auth/signup |
Cadastro de novo usuário |
| POST |
/auth/refresh_token |
Renovar token JWT |
Tickets
| Método |
Endpoint |
Descrição |
| GET |
/tickets |
Listar tickets (paginado) |
| POST |
/tickets |
Criar ticket |
| GET |
/tickets/:id |
Buscar ticket por ID |
| PUT |
/tickets/:id |
Atualizar ticket |
| DELETE |
/tickets/:id |
Remover ticket |
| POST |
/tickets/:id/messages |
Enviar mensagem |
| GET |
/tickets/:id/messages |
Listar mensagens |
Query params GET /tickets: status (open/closed/pending), queueId, pageNumber, searchParam
Contatos
| Método |
Endpoint |
Descrição |
| GET |
/contacts |
Listar contatos |
| POST |
/contacts |
Criar contato |
| GET |
/contacts/:id |
Buscar por ID |
| PUT |
/contacts/:id |
Atualizar contato |
| DELETE |
/contacts/:id |
Remover contato |
| POST |
/contacts/import |
Importar CSV |
Conexões (WhatsApp)
| Método |
Endpoint |
Descrição |
| GET |
/whatsapp |
Listar conexões |
| POST |
/whatsapp |
Criar conexão |
| PUT |
/whatsapp/:id |
Atualizar conexão |
| DELETE |
/whatsapp/:id |
Remover conexão |
| GET |
/whatsapp/:id/qrCode |
Obter QR Code |
Filas
| Método |
Endpoint |
Descrição |
| GET |
/queue |
Listar filas |
| POST |
/queue |
Criar fila |
| PUT |
/queue/:id |
Atualizar fila |
| DELETE |
/queue/:id |
Remover fila |
Usuários
| Método |
Endpoint |
Descrição |
| GET |
/users |
Listar usuários |
| POST |
/users |
Criar usuário |
| PUT |
/users/:id |
Atualizar usuário |
| DELETE |
/users/:id |
Remover usuário |
Campanhas
| Método |
Endpoint |
Descrição |
| GET |
/campaigns |
Listar campanhas |
| POST |
/campaigns |
Criar campanha |
| PUT |
/campaigns/:id |
Atualizar campanha |
| DELETE |
/campaigns/:id |
Remover campanha |
| POST |
/campaigns/:id/start |
Iniciar campanha |
| POST |
/campaigns/:id/cancel |
Cancelar campanha |
Mensagens Rápidas
| Método |
Endpoint |
Descrição |
| GET |
/quick-messages |
Listar mensagens rápidas |
| POST |
/quick-messages |
Criar mensagem rápida |
| PUT |
/quick-messages/:id |
Atualizar |
| DELETE |
/quick-messages/:id |
Remover |
| Método |
Endpoint |
Descrição |
| GET |
/tags |
Listar tags |
| POST |
/tags |
Criar tag |
| PUT |
/tags/:id |
Atualizar tag |
| DELETE |
/tags/:id |
Remover tag |
Agendamentos
| Método |
Endpoint |
Descrição |
| GET |
/schedules |
Listar agendamentos |
| POST |
/schedules |
Criar agendamento |
| PUT |
/schedules/:id |
Atualizar |
| DELETE |
/schedules/:id |
Remover |
Relatórios
| Método |
Endpoint |
Descrição |
| GET |
/reports/tickets |
Relatório de tickets |
| GET |
/reports/users |
Relatório por usuário |
| GET |
/reports/queues |
Relatório por fila |
API Externa (Integração)
| Método |
Endpoint |
Descrição |
| POST |
/api/messages/send |
Enviar mensagem via API key |
Header: apikey: API_KEY_DA_EMPRESA
Webhooks
| Evento |
Descrição |
| message.created |
Nova mensagem recebida |
| ticket.created |
Novo ticket aberto |
| ticket.updated |
Status do ticket alterado |
| contact.created |
Novo contato cadastrado |
Códigos de Resposta
| Código |
Significado |
| 200 |
Sucesso |
| 201 |
Criado com sucesso |
| 400 |
Requisição inválida |
| 401 |
Não autenticado |
| 403 |
Sem permissão |
| 404 |
Não encontrado |
| 429 |
Rate limit excedido |
| 500 |
Erro interno do servidor |