Pular para o conteúdo principal

Referencia da API REST

Todos os endpoints da API sao prefixados com /api/ e requerem autenticacao via cookie de sessao. Todas as requisicoes e respostas usam Content-Type: application/json.


Conversas

EndpointMetodoDescricao
/api/conversationsGETListar conversas (filtros: status, channel_type, tag, search, page)
/api/conversations/{id}GETObter conversa (reseta unread_count)
/api/conversationsPOSTCriar conversa
/api/conversations/{id}/statusPOSTAtualizar status
/api/conversations/{id}/tagsPOSTAdicionar tag
/api/conversations/{id}/tags/{tag}DELETERemover tag
/api/conversations/{id}/assignPOSTAtribuir agente

Mensagens

EndpointMetodoDescricao
/api/conversations/{id}/messagesGETListar mensagens
/api/conversations/{id}/messagesPOSTEnviar mensagem

Sugestao de IA

EndpointMetodoDescricao
/api/ai-suggest?conversation_id={id}GETObter sugestao de resposta da IA

Contatos

EndpointMetodoDescricao
/api/contactsGETListar contatos
/api/contacts/{id}GETObter contato
/api/contactsPOSTCriar contato
/api/contacts/{id}PATCHAtualizar contato
/api/contacts/{id}DELETEExcluir contato (admin)

Canais (Somente Admin)

EndpointMetodoDescricao
/api/channelsGETListar canais
/api/channelsPOSTCriar canal
/api/channels/{id}PATCHAtualizar canal
/api/channels/{id}DELETEExcluir canal

Automacoes (Somente Admin)

EndpointMetodoDescricao
/api/automationsGETListar automacoes
/api/automationsPOSTCriar automacao
/api/automations/{id}/togglePOSTAlternar ativo/inativo
/api/automations/{id}DELETEExcluir automacao

Analises

EndpointMetodoDescricao
/api/analytics?days=30GETObter dados de analise

Agentes (Somente Admin)

EndpointMetodoDescricao
/api/agentsGETListar agentes
/api/agentsPOSTCriar agente
/api/agents/{id}/rolePOSTAtualizar funcao
/api/agents/{id}DELETEExcluir agente

Configuracoes

EndpointMetodoDescricao
/api/settings/workspaceGETObter configuracoes do workspace
/api/settings/workspacePOSTAtualizar workspace (admin)
/api/settings/passwordPOSTAlterar senha

Formato de Erro

{"error": "Human-readable error message"}
CodigoSignificado
200Sucesso
201Criado
400Requisicao Invalida
401Nao Autenticado
403Proibido
404Nao Encontrado
409Conflito
500Erro Interno