Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/onboarding/messages

Mensagens do onboarding (polling, ordem crescente)

Mensagens da conversa com a Renata em ordem crescente. Polling: guarde meta.nextCursor e chame de novo com after=<nextCursor> para receber só o que chegou depois. meta.session traz o estado da sessão (turno em aberto e stale). after desconhecido → 422 invalid_cursor; sessão não iniciada → 404 onboarding_not_started.

Permissão:onboarding:read

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 consulta

  • afterstringOpcional

    Id da última mensagem já recebida (meta.nextCursor). · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • limitintegerOpcional

    Mensagens por página (1–100). · Padrão: 50 · Entre 1 e 100

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}$

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/onboarding/messages?limit=25", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​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>",      "sessionId": "<sessionId>",      "role": "user",      "turn": 0,      "part": 1,      "seq": 0,      "text": "<text>",      "clientMessageId": "<clientMessageId>",      "inReplyTo": "<inReplyTo>",      "eventId": "<eventId>",      "delivery": "pendente",      "outcome": "ok",      "final": true,      "authorName": "<authorName>",      "sentAt": "2026-09-18T14:00:00.000Z"    }  ],  "meta": {    "hasNext": true,    "nextCursor": "<nextCursor>",    "limit": 1,    "session": {      "id": "<id>",      "status": "ativa",      "step": "boas_vindas",      "percent": 1,      "version": 1,      "turn": 0,      "awaitingReply": {        "messageId": "<messageId>",        "since": "2026-09-18T14:00:00.000Z",        "stale": true      },      "stepState": {},      "startedAt": "2026-09-18T14:00:00.000Z",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "completedAt": "2026-09-18T14:00:00.000Z",      "createdAt": "2026-09-18T14:00:00.000Z",      "updatedAt": "2026-09-18T14:00:00.000Z"    }  }}

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

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)