Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/inbound/messages

Registrar mensagem recebida do paciente (gateway; atômico e idempotente)

Somente token de serviço (gateway do canal → motor de automação). Em uma operação: encontra ou cria a conversa por (clínica, channel, externalChatRef), vincula paciente/lead pelo telefone dentro da clínica, grava a mensagem, atualiza não lidas/prévia e grava o evento message.received no outbox (reentrega com backoff; event_id estável).

Idempotência: cabeçalho Idempotency-Key (padrão <channel>:<externalMessageId>). Primeira vez → 201; repetição (sequencial ou simultânea) → 200 com o mesmo conteúdo e meta.idempotent = true, sem nova mensagem e sem novo evento. Mesma chave com outro conteúdo → 409 idempotency_key_reused. Mensagem já registrada por outro caminho com o mesmo externalMessageId na conversa também conta como repetição.

Mesmo externalMessageId já registrado na conversa com outro texto → 409 idempotency_key_reused, mesmo com outra Idempotency-Key.

Agent Preview: externalChatRef = prefixo reservado de prévia + UUIDv4 em minúsculas e channel = outros, sem phone, contactName nem media (422). A sessão pertence ao agente autenticado (outro agente → 404), nunca é vinculada a paciente/lead e não grava outbox nem dispara evento: data.event = null e meta.webhooks = [].

Sandbox: sem motor de automação configurado o evento fica no outbox com status disabled (visível em GET /v1/outbox, reenvio manual).

Permissão:conversations:writeDispara:message.received

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

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

    Chave de idempotência (ASCII visível, sem espaços). Padrão: <channel>:<externalMessageId>. · Entre 1 e 255 caracteres · Padrão (regex): ^[\x21-\x7E]+$

Corpo da requisição

application/json · obrigatório

  • channelstringObrigatório

    Canal da conversa. Conversas de prévia de agente (prefixo reservado) só com outros. · Valores: whatsapp, email, sms, instagram, outros

  • externalMessageIdstringObrigatório

    Id da mensagem no provedor do canal. Chave natural de deduplicação. · Entre 1 e 255 caracteres

  • externalChatRefstringObrigatório

    Id do chat no provedor do canal (ex.: 5516999990000@s.whatsapp.net) ou o prefixo reservado de prévia de agente. Conversa = (clínica, canal, externalChatRef). · Entre 1 e 255 caracteres

  • contactNamestringOpcional

    Nome exibido no provedor (pushName). Paciente/lead já cadastrado tem prioridade. · Entre 1 e 128 caracteres

  • phonestringOpcional

    Telefone do contato; se ausente, extraído de externalChatRef (dígitos antes do @). · Até 32 caracteres

  • textstringObrigatório

    Texto da mensagem (mídia sem legenda: descreva, ex.: "[imagem]"). · Entre 1 e 4000 caracteres

  • receivedAtstring (data-hora)Obrigatório

    Quando o provedor recebeu a mensagem (horário no futuro é limitado ao agora).

  • mediaobjectOpcional
  • typestringObrigatório
    media.type

    Valores: image, audio, video, document, sticker, location, other

  • urlstring (URL)Opcional
    media.url

    URL temporária do provedor (nunca binário). · Até 2048 caracteres

  • captionstringOpcional
    media.caption

    Até 1000 caracteres

  • mimeTypestringOpcional
    media.mimeType

    Até 100 caracteres

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/inbound/messages", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "channel": "whatsapp",    "externalMessageId": "<externalMessageId>",    "externalChatRef": "<externalChatRef>",    "text": "<text>",    "receivedAt": "2026-01-15T14:00:00.000Z",    "contactName": "<contactName>",    "phone": "<phone>",    "media": {      "type": "image",      "url": "https://exemplo.com",      "caption": "<caption>"    }  }),})​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": {    "conversation": {      "id": "<id>",      "name": "<name>",      "channel": "whatsapp",      "preview": "<preview>",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "unread": 1,      "mine": true,      "assignedTo": {        "id": "<id>",        "name": "<name>"      },      "archived": true,      "activeAgent": {        "key": "<key>",        "name": "<name>",        "image": "<image>"      },      "patientId": "<patientId>",      "leadId": "<leadId>",      "tags": [        "<tag>"      ]    },    "message": {      "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"    },    "conversationCreated": true,    "event": {      "id": "<id>",      "event": "message.received",      "eventId": "<eventId>",      "status": "pending",      "attempts": 1,      "nextAttemptAt": "2026-09-18T14:00:00.000Z",      "lastError": "<lastError>",      "lastHttpStatus": 1,      "createdAt": "2026-09-18T14:00:00.000Z",      "sentAt": "2026-09-18T14:00:00.000Z",      "traceId": "<traceId>",      "refType": "<refType>",      "refId": "<refId>"    }  },  "meta": {    "idempotent": true,    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}
201Created — Sucesso.
JSON
{  "data": {    "conversation": {      "id": "<id>",      "name": "<name>",      "channel": "whatsapp",      "preview": "<preview>",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "unread": 1,      "mine": true,      "assignedTo": {        "id": "<id>",        "name": "<name>"      },      "archived": true,      "activeAgent": {        "key": "<key>",        "name": "<name>",        "image": "<image>"      },      "patientId": "<patientId>",      "leadId": "<leadId>",      "tags": [        "<tag>"      ]    },    "message": {      "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"    },    "conversationCreated": true,    "event": {      "id": "<id>",      "event": "message.received",      "eventId": "<eventId>",      "status": "pending",      "attempts": 1,      "nextAttemptAt": "2026-09-18T14:00:00.000Z",      "lastError": "<lastError>",      "lastHttpStatus": 1,      "createdAt": "2026-09-18T14:00:00.000Z",      "sentAt": "2026-09-18T14:00:00.000Z",      "traceId": "<traceId>",      "refType": "<refType>",      "refId": "<refId>"    }  },  "meta": {    "idempotent": true,    "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.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

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: 600 requisições / 60 s. Sobre limites

Testar no Swagger(abre em nova aba)