API ReferenceConversations

Conversations

Acesse o histórico de conversas, mensagens e gerencie sessões de atendimento.

Listar Conversas

GET
/api/conversations

Retorna todas as conversas do usuário

Response
[
  {
    "id": "clxyz...",
    "agentId": "clxyz...",
    "title": "Atendimento #123",
    "status": "active",
    "startedAt": "2026-03-06T10:00:00Z",
    "endedAt": null
  }
]

Obter Conversa

GET
/api/conversations/:id

Detalhes de uma conversa específica

Listar Mensagens

GET
/api/conversations/messages/:conversationId

Todas as mensagens de uma conversa

Response
[
  {
    "id": "clxyz...",
    "type": "agent",
    "content": "Olá! Como posso ajudá-lo?",
    "timestamp": "2026-03-06T10:00:01Z"
  },
  {
    "id": "clxyz...",
    "type": "user",
    "content": "Preciso de ajuda com meu pedido",
    "timestamp": "2026-03-06T10:00:15Z"
  }
]

Enviar Mensagem

POST
/api/conversations/message/send/:conversationId

Envia mensagem em conversa ativa

ParameterTypeRequiredDescription
typestringRequired"user", "agent" ou "system"
contentstringRequiredConteúdo da mensagem

Iniciar Conversa

POST
/api/conversations/start

Inicia uma nova sessão

ParameterTypeRequiredDescription
agentIdstringRequiredID do agente participante
titlestringOptionalTítulo da conversa
Request
curl -X POST https://api.vendoria.com.br/api/conversations/start \
  -H "X-Api-Key: vk_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "agentId": "clxyz..." }'

Encerrar Conversa

POST
/api/conversations/end

Encerra conversa ativa

ParameterTypeRequiredDescription
conversationIdstringRequiredID da conversa