/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 = [].
Remetente (`data.senderRole`): owner/staff somente quando o chat individual do WhatsApp é o número verificado de um usuário ativo desta clínica (PUT /v1/users/{id}/whatsapp + POST /v1/users/{id}/whatsapp/verify); qualquer outro caso → lead. Campos extras no corpo (ex.: um papel) são descartados. Se phone vier e não bater com o chat, vale lead.
Mensagem do dono/equipe: a mensagem grava sender_role (o mesmo data.senderRole) e sai com message.senderRole; a conversa passa a audience = "team" (selo "Equipe" na Comunicação; filtro GET /v1/conversations?audience=team) e não volta sozinha. Mensagens antigas, sem o campo, valem lead. É a origem aceita por POST /v1/clinic/profile/proposals (só owner).
Lead na entrada: remetente lead (WhatsApp, chat individual) cujo telefone não é de nenhum paciente nem lead da clínica → a API cria o lead (etapa NEW, origem FECHADA, canal WhatsApp; $id determinístico por clínica + telefone E.164, sem duplicar em repetições) e vincula à conversa: conversation.leadId e lead_id do evento trazem o id. Nunca para owner/staff (que também não são vinculados a paciente/lead), prévia ou telefone já cadastrado. Se a criação falhar, o registro da mensagem NÃO falha: lead_id fica nulo.
Mídia: media.type, media.mimeType e media.durationSeconds (opcional) ficam gravados na mensagem e voltam em message.media; media.url (link temporário do provedor) e media.caption não são guardados (a legenda, se houver, vai no text). O texto entendido da mídia (transcrição / texto lido na imagem) chega depois, por PUT /v1/conversations/{id}/messages/{messageId}/derived.
Sandbox: sem motor de automação configurado o evento fica no outbox com status disabled (visível em GET /v1/outbox, reenvio manual).
conversations:writeDispara:message.receivedAutenticaçã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-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). Padrão:
<channel>:<externalMessageId>. · Entre 1 e 255 caracteres · Padrão (regex):^[\x21-\x7E]+$
Corpo da requisição
application/json · obrigatório
channelstringObrigatórioCanal da conversa. Conversas de prévia de agente (prefixo reservado) só com
outros. · Valores:whatsapp,email,sms,instagram,outrosexternalMessageIdstringObrigatórioId da mensagem no provedor do canal. Chave natural de deduplicação. · Entre 1 e 255 caracteres
externalChatRefstringObrigatórioId 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 caracterescontactNamestringOpcionalNome exibido no provedor (pushName). Paciente/lead já cadastrado tem prioridade. · Entre 1 e 128 caracteres
phonestringOpcionalTelefone do contato; se ausente, extraído de externalChatRef (dígitos antes do @). · Até 32 caracteres
textstringObrigatórioTexto da mensagem (mídia sem legenda: descreva, ex.: "[imagem]"). · Entre 1 e 4000 caracteres
receivedAtstring (data-hora)ObrigatórioQuando o provedor recebeu a mensagem (horário no futuro é limitado ao agora).
mediaobjectOpcionaltypestringObrigatóriomedia.typeValores:
audio,image,document,video,sticker,location,otherurlstring (URL)Opcionalmedia.urlURL temporária do provedor (nunca binário). · Até 2048 caracteres
captionstringOpcionalmedia.captionAté 1000 caracteres
mimeTypestringOpcionalmedia.mimeTypeAté 100 caracteres
durationSecondsintegerOpcionalmedia.durationSecondsDuração em segundos (áudio/vídeo), quando o gateway souber. Guardada na mensagem. · Entre 0 e 86400
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": "audio", "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
{ "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>" }, "agentReplyKeys": [ "<agentReplyKey>" ], "patientId": "<patientId>", "leadId": "<leadId>", "tags": [ "<tag>" ], "audience": "contact", "isPreview": true }, "message": { "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" } }, "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>" }, "senderRole": "owner" }, "meta": { "idempotent": true, "webhooks": [ { "event": "appointment.cancelled", "status": "sent" } ] }}{ "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>" }, "agentReplyKeys": [ "<agentReplyKey>" ], "patientId": "<patientId>", "leadId": "<leadId>", "tags": [ "<tag>" ], "audience": "contact", "isPreview": true }, "message": { "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" } }, "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>" }, "senderRole": "owner" }, "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.
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: 600 requisições / 60 s. Sobre limites