Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Headers

x-phone
string

Optional. Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to let the API select an eligible phone automatically — within the token's phone scopes and connected; chat actions use a phone that has the chat (a group admin where required), message actions use the phone the message belongs to.

Example:

"919876543210"

Body

application/json
contact_ids
string[]
required

Phone numbers to check: country code + number without symbols or spaces (e.g. 911111111111). The @c.us suffix is accepted and ignored for matching.

Minimum array length: 1
Minimum string length: 1
Example:

Response

Existence result for each requested contact_id

contact_id
string

The contact_id exactly as sent in the request

Example:

"911111111111"

exists
boolean

Whether the number is registered on WhatsApp

Example:

true