/v1/conversations/{id}/messages
Enviar mensagem (humano ou agente) / registrar recebida (token de serviço)
Humano enviando numa conversa conduzida por agente assume a conversa (o agente para de responder).
Entrega (outbox): a mensagem é gravada com delivery = enviando e o evento message.send vai para o outbox (reentrega automática com backoff; event_id estável por mensagem — o F05 deduplica por event_id ou data.message_id). enviando continua enquanto o outbox reenvia; entregue/lido chegam pela confirmação do F05 (PATCH …/messages/{messageId}); falhou só quando o outbox desiste (ou o F05 informa falha); registrado quando o motor de automação não está configurado. meta.webhooks traz o resultado da 1ª tentativa.
Idempotência (`Idempotency-Key`): obrigatória para token de serviço (422 sem ela; use reply:<request_id>), opcional para pessoas. Escopo: clínica. Primeira vez → 201; repetição com o mesmo corpo e o mesmo autor → 200 com Idempotent-Replayed: true, a MESMA mensagem e nenhum evento novo; mesma chave com outro conteúdo, outra conversa ou outro autor → 409 idempotency_key_reused. Resposta incerta (5xx/timeout): repita com a MESMA chave.
Agente x equipe: o token de serviço só envia na conversa que o agente conduz: a chave precisa estar em agentReplyKeys da conversa (o próprio agente ativo; ou a Lívia, knowledge, quando o agente ativo é um especialista que ela orquestra). Conversa assumida pela equipe ou em handoff (sem agente ativo), com outro agente ativo, ou agente em pausa → 409 conversation_not_with_agent (motivo em details[0].code: conversation_taken_over | conversation_other_agent | agent_paused). Nada é gravado nem enviado. A reentrega pelo outbox de uma resposta de agente é conferida de novo a cada tentativa: se a conversa deixou de estar com o agente, o evento é encerrado sem envio (dead) e a mensagem fica falhou. Idade máxima: resposta de agente com mais de 10 min (MESSAGE_SEND_AGENT_MAX_AGE_MS) não é mais entregue — o evento vira dead (send_expired) e a mensagem falhou; mensagem de pessoa, sem limite por padrão (MESSAGE_SEND_HUMAN_MAX_AGE_MS).
direction: "inbound" e externalRef só são aceitos com token de serviço (automação registrando a mensagem do paciente).
Obsoleto: direction: "inbound" continua funcionando por compatibilidade, mas não é idempotente nem gera message.received. Use `POST /v1/inbound/messages` (atômico, idempotente, com outbox). Respostas inbound trazem os cabeçalhos Deprecation: true e Link: </v1/inbound/messages>; rel="successor-version".
Agent Preview (`recordOnly: true`): só o agente dono da sessão de prévia (token de serviço), direction = outbound, cabeçalho `Idempotency-Key` obrigatório, sem externalRef. Grava com delivery = registrado e não emite message.send nem outbox. Primeira gravação → 201; repetição exata → 200 com Idempotent-Replayed: true; mesma chave com outro conteúdo → 409 idempotency_key_reused. Resposta incerta (erro 5xx/timeout): repita com a MESMA chave — a repetição conclui a gravação sem duplicar. Conversas de prévia não aceitam mensagem sem recordOnly (403 preview_record_only); outro agente → 404.
E-mail verificado: quando a verificação de e-mail está ligada no ambiente, contas com e-mail ainda não confirmado recebem 403 email_not_verified.
conversations:writeDispara:message.sendconversation.takeoverAutenticação
Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar
Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>Parâmetros
Parâmetros de caminho
idstringObrigatórioId do recurso. · Entre 1 e 64 caracteres · Padrão (regex):
^[A-Za-z0-9._-]+$
Cabeçalhos
X-Clinic-IdstringOpcionalClínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex):
^[A-Za-z0-9._-]{1,64}$Idempotency-KeystringOpcionalChave de idempotência (ASCII visível, sem espaços), escopo por clínica. Obrigatória para token de serviço no envio (ex.:
reply:<request_id>) e comrecordOnly: true; opcional para pessoas. Ignorada emdirection: "inbound"(obsoleto). · Entre 1 e 255 caracteres · Padrão (regex):^[\x21-\x7E]+$
Corpo da requisição
application/json · obrigatório
textstringObrigatórioEntre 1 e 4000 caracteres
directionstringOpcionalinboundestá obsoleto (use POST /v1/inbound/messages). · Valores:outbound,inbound· Padrão:"outbound"externalRefstringOpcionalAté 255 caracteres
recordOnlybooleanOpcionalSomente token de serviço (agente dono da sessão): registra uma resposta de Agent Preview sem emitir message.send. Exige Idempotency-Key. · Padrão:
false
Exemplo de requisição
Gerado do contrato. Troque os marcadores entre < > pelos seus valores.
const res = await fetch("https://myclinc.leadpoint.com.br/v1/conversations/<id>/messages", { method: "POST", headers: { Authorization: "Bearer <TOKEN>", "X-Clinic-Id": "<clinic_id>", "X-Agent-Key": "<agent_key>", "Content-Type": "application/json", }, body: JSON.stringify({ "text": "<text>", "direction": "outbound", "externalRef": "<externalRef>", "recordOnly": false }),})if (!res.ok) { const { error } = await res.json() throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()Resposta
{ "data": { "id": "<id>", "from": "patient", "text": "<text>", "sentAt": "2026-09-18T14:00:00.000Z", "agent": { "key": "<key>", "name": "<name>", "image": "<image>" }, "authorName": "<authorName>", "senderRole": "owner", "read": true, "delivery": "enviando", "media": { "type": "audio", "mimeType": "<mimeType>", "durationSeconds": 0 }, "derived": { "kind": "transcription", "status": "available", "text": "<text>", "derivedAt": "2026-09-18T14:00:00.000Z" } }, "meta": { "webhooks": [ { "event": "appointment.cancelled", "status": "sent" } ] }}{ "data": { "id": "<id>", "from": "patient", "text": "<text>", "sentAt": "2026-09-18T14:00:00.000Z", "agent": { "key": "<key>", "name": "<name>", "image": "<image>" }, "authorName": "<authorName>", "senderRole": "owner", "read": true, "delivery": "enviando", "media": { "type": "audio", "mimeType": "<mimeType>", "durationSeconds": 0 }, "derived": { "kind": "transcription", "status": "available", "text": "<text>", "derivedAt": "2026-09-18T14:00:00.000Z" } }, "meta": { "webhooks": [ { "event": "appointment.cancelled", "status": "sent" } ] }}Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.
Códigos de erro
Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.
Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).
Unauthorized — Token ausente, inválido ou expirado.
Forbidden — Autenticado, mas sem permissão (perfil ou clínica).
Not Found — Recurso não encontrado na clínica ativa.
Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).
Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).
Too Many Requests — Limite de requisições excedido (veja Retry-After).
Internal Server Error — Erro interno (sem detalhes expostos).
Service Unavailable — Banco de dados indisponível ou não configurado.
Limites
Esta operação tem limite próprio: 60 requisições / 60 s. Sobre limites