Ver o lead
GET /leads/{lead_id}
Lê o CRM de um contato pelo id do lead (vem em chat.lead_id). Para a conversa junto, use GET /chats/{chat_id}.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"name": "lead_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "O `lead.id` (na conversa, vem em `chat.lead_id`), ou a conversa do lead: o `chat_id` (`5511999999999@s.whatsapp.net` ou o `@lid`) ou o número com DDI (`5511999999999`, `+5511999999999`). O número é comparado como veio, sem trocar o nono dígito: a outra forma dá 404 (só o WhatsApp sabe se é a mesma conta)."
}
]
Respostas
{
"200": {
"description": "O lead.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioLead"
},
"example": {
"id": "rbb629d0fdfa7b3",
"phone": "5511999999999",
"name": "Maria",
"full_name": "Maria Souza",
"email": "maria@exemplo.com",
"document": "12345678900",
"status": "cliente",
"tags": [
"vip"
],
"fields": {
"field01": "Plano Pro"
},
"notes": "Prefere entrega à tarde.",
"kanban_order": 3
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"404": {
"description": "Lead não encontrado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_found",
"message": "Lead não encontrado."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Sim | |
| Sim | ||
| Messenger | Sim | |
| Telegram | Sim |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: POST /chat/details.
- Só o CRM, pelo id do lead (antes vinha dentro da conversa).
#/components/schemas/OrkesioLead
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id do lead na Orkesio. Opaco: guarde como veio, sem montar a partir de outro campo. Hoje é o id interno da conversa onde o lead nasceu."
},
"phone": {
"type": "string",
"description": "Telefone do contato com DDI (só dígitos), quando conhecido."
},
"lid": {
"type": "string",
"description": "LID do contato, quando conhecido (só no `whatsapp_web`)."
},
"name": {
"type": "string",
"description": "Como o contato quer ser chamado (ex.: `Dona Maria`), escrito por você, pela IA ou por um fluxo. Não vem do WhatsApp: os nomes do WhatsApp são `contact_name` e `push_name` da conversa."
},
"full_name": {
"type": "string",
"description": "Nome completo, para cadastro (nota, contrato), escrito por você, pela IA ou por um fluxo. Não vem do WhatsApp."
},
"email": {
"type": "string",
"description": "E-mail."
},
"document": {
"type": "string",
"description": "Documento (CPF/CNPJ ou outro)."
},
"status": {
"type": "string",
"description": "Etapa do funil, texto livre. A coluna do kanban é outra coisa: a tag com `kanban: true` em `tags`."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "Etiqueta do lead."
},
"description": "Etiquetas do lead (do CRM, não as do WhatsApp Business)."
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Campos personalizados (até 20), pela chave (`field01` a `field20`). O nome de cada um está em `GET /leads/fields`."
},
"notes": {
"type": "string",
"description": "Notas do CRM, só na Orkesio. Não são as notas do WhatsApp Business (essas são da conversa, em `GET /chats/{chat_id}`)."
},
"kanban_order": {
"type": "integer",
"description": "Posição do cartão na coluna do kanban (maior aparece primeiro)."
},
"identities": {
"type": "array",
"description": "As contas do contato em cada canal: uma por conversa ligada ao lead.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"channel",
"id"
],
"properties": {
"channel": {
"type": "string",
"enum": [
"whatsapp",
"telegram",
"messenger",
"instagram"
],
"description": "A rede (o WhatsApp Web e a API oficial são a mesma rede: `whatsapp`)."
},
"id": {
"type": "string",
"description": "O id do contato nesse canal, o mesmo de `chat.id`."
},
"username": {
"type": "string",
"description": "O nome de usuário nesse canal, quando há."
}
}
}
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Lead do CRM: o contato, com um lead por contato e por dono (hoje a inbox, então um por conversa direta). Grupo, canal e status não têm lead. Vem sempre em `message.received` e `message.sent` de conversa direta, e em cada conversa direta de `GET /chats`."
}
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
#/components/responses/InternalError
{
"description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Falha inesperada."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi