Verificar Números no WhatsApp

POST /chat/check

Verifica se números fornecidos estão registrados no WhatsApp e retorna informações detalhadas.

Funcionalidades:

  • Verifica múltiplos números simultaneamente
  • Suporta números individuais e IDs de grupo
  • Retorna nome verificado quando disponível
  • Identifica grupos e comunidades
  • Verifica subgrupos de comunidades

Comportamento específico:

  • Para números individuais:
    • Verifica registro no WhatsApp
    • Retorna nome verificado se disponível
    • Normaliza formato do número
  • Para grupos:
    • Verifica existência
    • Retorna nome do grupo
    • Retorna id do grupo de anúncios se buscado por id de comunidade

Autenticação

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

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "numbers"
        ],
        "properties": {
          "numbers": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string"
            },
            "description": "Lista de números ou IDs de grupo para verificar",
            "example": [
              "5511999999999",
              "123456789@g.us"
            ]
          }
        }
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "Resultado da verificação",
    "content": {
      "application/json": {
        "schema": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "query": {
                "type": "string",
                "description": "Número/ID original consultado"
              },
              "jid": {
                "type": "string",
                "description": "JID do WhatsApp"
              },
              "lid": {
                "type": "string",
                "description": "LID do WhatsApp"
              },
              "isInWhatsapp": {
                "type": "boolean",
                "description": "Indica se está no WhatsApp"
              },
              "verifiedName": {
                "type": "string",
                "description": "Nome verificado se disponível"
              },
              "groupName": {
                "type": "string",
                "description": "Nome do grupo se aplicável"
              },
              "error": {
                "type": "string",
                "description": "Mensagem de erro se houver"
              }
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "Payload inválido ou sem números",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "Missing numbers in payload"
            }
          }
        }
      }
    }
  },
  "401": {
    "description": "Sem sessão ativa",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "No active session"
            }
          }
        }
      }
    }
  },
  "500": {
    "description": "Erro interno do servidor",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string",
              "example": "WhatsApp client is not connected"
            }
          }
        }
      }
    }
  }
}

Guias relacionados

Autenticação · Erros e retries · Server URL