Pular para o conteúdo
MyClinicAPI Docs
POST

/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). 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.

Permissão:conversations:writeDispara:message.sendconversation.takeover

Autenticaçã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ório

    Id do recurso. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clí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-KeystringOpcional

    Obrigatória com recordOnly: true (chave técnica do turno da prévia; ASCII visível, sem espaços). Ignorada nos demais casos. · Entre 1 e 255 caracteres · Padrão (regex): ^[\x21-\x7E]+$

Corpo da requisição

application/json · obrigatório

  • textstringObrigatório

    Entre 1 e 4000 caracteres

  • directionstringOpcional

    inbound está obsoleto (use POST /v1/inbound/messages). · Valores: outbound, inbound · Padrão: "outbound"

  • externalRefstringOpcional

    Até 255 caracteres

  • recordOnlybooleanOpcional

    Somente 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

200OK — Sucesso.
JSON
{  "data": {    "id": "<id>",    "from": "patient",    "text": "<text>",    "sentAt": "2026-09-18T14:00:00.000Z",    "agent": {      "key": "<key>",      "name": "<name>",      "image": "<image>"    },    "authorName": "<authorName>",    "read": true,    "delivery": "enviando"  },  "meta": {    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}
201Created — Sucesso.
JSON
{  "data": {    "id": "<id>",    "from": "patient",    "text": "<text>",    "sentAt": "2026-09-18T14:00:00.000Z",    "agent": {      "key": "<key>",      "name": "<name>",      "image": "<image>"    },    "authorName": "<authorName>",    "read": true,    "delivery": "enviando"  },  "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.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

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

Testar no Swagger(abre em nova aba)