Referência da API Visão geral da API
Todos os endpoints da v1, com a permissão que cada um exige.
Base URLhttps://app.nextchat.nextsistem.dev.br/api/integrations/v1
Endpoints
Os caminhos são relativos à base URL. IDs são UUIDs.
Chave
| Método | Caminho | Ação | Permissão |
|---|
| GET | /me | Identificar a integração | qualquer chave |
Conversas
| Método | Caminho | Ação | Permissão |
|---|
| GET | /channels | Listar números de WhatsApp | conversations:read |
| GET | /conversations | Listar conversas | conversations:read |
| POST | /conversations | Abrir conversa com um telefone ou contato | conversations:write |
| GET | /conversations/{id} | Detalhar conversa | conversations:read |
| PATCH | /conversations/{id} | Alterar conversa (arquivar, fixar, silenciar, nome, etiquetas) | conversations:write |
| POST | /conversations/{id}/read | Marcar como lida | conversations:write |
| POST | /conversations/{id}/transfer | Transferir para pessoa e/ou setor | conversations:write |
| PUT | /conversations/{id}/sector | Definir o setor | conversations:write |
Mensagens
| Método | Caminho | Ação | Permissão |
|---|
| GET | /conversations/{id}/messages | Ler mensagens | messages:read |
| POST | /conversations/{id}/messages | Enviar mensagem (idempotente por client_id) | messages:send |
| GET | /messages/{id} | Uma mensagem | messages:read |
| POST | /media | Enviar arquivo (multipart/form-data, campo file) | media:write |
| GET | /media/{id}/url | Link temporário da mídia | messages:read |
Contatos
| Método | Caminho | Ação | Permissão |
|---|
| GET | /contacts | Listar contatos | contacts:read |
| POST | /contacts | Criar contato | contacts:write |
| GET | /contacts/{id} | Detalhar contato | contacts:read |
| PATCH | /contacts/{id} | Editar contato | contacts:write |
| GET | /labels | Listar etiquetas | contacts:read |
Atendimentos
| Método | Caminho | Ação | Permissão |
|---|
| GET | /attendances | Listar atendimentos (protocolos) | attendances:read |
| GET | /attendances/{id} | Detalhar atendimento | attendances:read |
| GET | /conversations/{id}/attendance | Atendimento atual da conversa | attendances:read |
| GET | /conversations/{id}/assignments | Histórico de responsáveis | attendances:read |
| POST | /conversations/{id}/attendance/close | Finalizar atendimento | attendances:write |
Equipe
| Método | Caminho | Ação | Permissão |
|---|
| GET | /team | Equipe | team:read |
| GET | /sectors | Setores | team:read |
| GET | /company/attendance | Regras de atendimento da empresa | team:read |
Relatórios
| Método | Caminho | Ação | Permissão |
|---|
| GET | /reports/attendance | Relatório do gestor | reports:read |
Webhooks
| Método | Caminho | Ação | Permissão |
|---|
| GET | /integrations/webhooks | Listar webhooks | webhooks:manage |
| POST | /integrations/webhooks | Cadastrar webhook (devolve o segredo uma vez) | webhooks:manage |
| GET | /integrations/webhooks/events | Eventos disponíveis | webhooks:manage |
| PATCH | /integrations/webhooks/{id} | Editar ou reativar webhook | webhooks:manage |
| DELETE | /integrations/webhooks/{id} | Apagar webhook | webhooks:manage |
| POST | /integrations/webhooks/{id}/rotate-secret | Redefinir o segredo de assinatura | webhooks:manage |
| POST | /integrations/webhooks/{id}/test | Enviar evento de teste | webhooks:manage |
| GET | /integrations/webhooks/{id}/deliveries | Últimas entregas | webhooks:manage |
Kanban
| Método | Caminho | Ação | Permissão |
|---|
| GET | /kanban/boards | Listar quadros | read |
| GET | /kanban/boards/{id} | Consultar quadro | read |
| GET | /kanban/cards | Buscar cartões | read |
| GET | /kanban/cards/{id} | Consultar cartão e checklist | read |
| PATCH | /kanban/cards/{id} | Editar cartão | update |
| POST | /kanban/boards/{id}/cards | Criar cartão | create |
| POST | /kanban/cards/{id}/move | Mover cartão | move |
| POST | /kanban/cards/{id}/comments | Adicionar comentário | comments:write |
| GET | /kanban/cards/{id}/comments | Ler comentários do cartão | read |
| POST | /kanban/cards/{id}/checklist | Adicionar checklist | checklist:write |
| PATCH | /kanban/checklist/{id} | Editar checklist | checklist:write |
| DELETE | /kanban/checklist/{id} | Apagar item da checklist | checklist:write |
| GET | /kanban/labels | Listar etiquetas | read |
| GET | /kanban/boards/{id}/members | Quem pode ser responsável no quadro | read |
| GET | /kanban/boards/{id}/fields | Campos personalizados do quadro | read |
| GET | /kanban/boards/{id}/templates | Modelos de cartão do quadro | read |
| GET | /kanban/events | Feed de mudanças dos cartões | read |
| PATCH | /kanban/cards/{id}/comments/{commentId} | Editar comentário da própria chave | comments:write |
| DELETE | /kanban/cards/{id}/comments/{commentId} | Apagar comentário da própria chave | comments:write |
| GET | /kanban/cards/{id}/activity | Histórico do cartão (criou, editou, moveu) | read |
| POST | /kanban/cards/{id}/archive | Arquivar cartão (sem exigir versão) | update |
| POST | /kanban/cards/{id}/restore | Restaurar cartão arquivado | update |
| POST | /kanban/cards/{id}/attachments | Anexar arquivos (multipart, campo file, até 10) | attachments:write |
| GET | /kanban/cards/{id}/attachments | Listar anexos do cartão (link assinado de 5 minutos) | read |
| DELETE | /kanban/cards/{id}/attachments/{attachmentId} | Remover anexo | attachments:delete |
A especificação completa está no openapi.json, que também se baixa pelo link OpenAPI no topo.
NextChat