PAPI WhatsAppInstall

Summary

Check if a specific phone number exists on WhatsApp using a given WhatsApp instance ID.

Inputs

• ID da Instância (required) — Specifies the WhatsApp instance ID to use for the number verification.
• Número de Telefone (required) — The phone number (including country code) to verify existence on WhatsApp (e.g., 5511999999999).

Output shape

a single JSON object containing the verification result for the given phone number

The operation performs an HTTP GET request to the endpoint /api/instances/{instanceId}/check-number/{phoneNumber} (or /api/instances//check-number/{phoneNumber} if instanceId is empty). The result includes whether the number exists on WhatsApp. Errors include authorization issues if API key is invalid or not authorized.

Examples

Example 1: Verify if a phone number is registered on WhatsApp using instance 'minha-instancia'

Provide 'minha-instancia' as the Instance ID and '5511999999999' as the phone number to check.