Verificar números no WhatsApp

POST /numbers/check

Confere se números ou grupos existem no WhatsApp, vários de uma vez.

Número: responde se tem WhatsApp, o id certo (a api acerta o nono dígito pela resposta do WhatsApp), o lid e o verified_name de conta comercial verificada. Um LID (<id>@lid) também vale: a api devolve o número dele, quando conhece.
Grupo (<id>@g.us): responde se existe e o group_name. Para o id de uma comunidade, o id é o do grupo de avisos dela.
Quem não existe vem com on_whatsapp: false, ainda com status 200; no número, o motivo vem em error.
A api guarda o resultado de cada número por um tempo, para não perguntar de novo ao WhatsApp.
Recado (about, o texto do perfil): com "include": ["about"] no corpo, para todos os números com WhatsApp, em consultas de até 100 números ao WhatsApp. Não vem quando o contato não tem recado ou o esconde pela privacidade. Sem o include, a api não faz essa consulta.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "numbers"
        ],
        "properties": {
          "numbers": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string"
            },
            "description": "Números com DDI, LIDs (`<id>@lid`) ou ids de grupo (`<id>@g.us`) a conferir."
          },
          "include": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "about"
              ]
            },
            "description": "`[\"about\"]`: traz o recado de cada número com WhatsApp (consultas a mais ao WhatsApp, de até 100 números cada)."
          }
        }
      },
      "example": {
        "numbers": [
          "5511999999999",
          "120363123456789012@g.us"
        ]
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "Um resultado por item de `numbers`, na mesma ordem.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "results"
          ],
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string",
                    "description": "O valor como veio em `numbers`."
                  },
                  "id": {
                    "type": "string",
                    "description": "Id do WhatsApp do número (`<número>@s.whatsapp.net`, já com o nono dígito certo) ou do grupo. Use este para enviar."
                  },
                  "lid": {
                    "type": "string",
                    "description": "LID do contato, quando a api conhece."
                  },
                  "on_whatsapp": {
                    "type": "boolean",
                    "description": "`true` quando o número tem WhatsApp ou o grupo existe."
                  },
                  "verified_name": {
                    "type": "string",
                    "description": "Nome verificado da conta comercial, quando houver."
                  },
                  "group_name": {
                    "type": "string",
                    "description": "Nome do grupo (só para ids de grupo)."
                  },
                  "error": {
                    "type": "string",
                    "description": "Por que o número não está no WhatsApp ou não pôde ser conferido (formato inválido, falha na consulta)."
                  },
                  "username": {
                    "type": "string",
                    "description": "Nome de usuário do WhatsApp, quando a conta tem e o WhatsApp devolve."
                  },
                  "about": {
                    "type": "string",
                    "description": "Recado do contato (o texto do perfil). Só com `\"include\": [\"about\"]`; não vem quando o contato não tem recado ou o esconde."
                  }
                },
                "required": [
                  "query",
                  "on_whatsapp"
                ],
                "additionalProperties": false
              }
            }
          }
        },
        "example": {
          "results": [
            {
              "query": "5511999999999",
              "id": "5511999999999@s.whatsapp.net",
              "lid": "123456789012345@lid",
              "on_whatsapp": true,
              "about": "Disponível"
            },
            {
              "query": "120363123456789012@g.us",
              "id": "120363123456789012@g.us",
              "on_whatsapp": true,
              "group_name": "Clientes VIP"
            }
          ]
        }
      }
    }
  },
  "400": {
    "description": "Corpo inválido, `numbers` vazio ou `include` com algo além de `about`.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "numbers é obrigatório."
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "O WhatsApp recusou ou a operação falhou (também a busca do recado, com `include`).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Erro ao falar com o WhatsApp; tente de novo."
        }
      }
    }
  },
  "501": {
    "$ref": "#/components/responses/CloudUnsupported"
  },
  "503": {
    "description": "`disconnected`: a inbox está desconectada do WhatsApp.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "disconnected",
          "message": "Inbox desconectada do WhatsApp."
        }
      }
    }
  }
}

Estado: Disponível

Compatibilidade de canais

Canal	Compatível	Observação
WhatsApp (Web)	Sim
WhatsApp (API oficial)	Não	Só no WhatsApp Web: na API oficial responde 501.
Instagram	Não
Messenger	Não
Telegram	Não

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

POST /numbers/check; resposta em results.
jid → id; isInWhatsapp → on_whatsapp; verifiedName → verified_name; groupName → group_name.
Sem sessão: 503 disconnected (antes 401).
Recado do contato (about) com "include": ["about"], em consultas de até 100 números (antes só pelo /instance/info, campo Status).

#/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/CloudUnsupported

{
  "description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "unsupported_for_channel",
        "message": "Esta rota não está disponível no canal da inbox."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi