Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function checkContact() {
  const response = await client.contact.checkExists({
    contact_ids: ['919537851844', '919876543210']
  });

  console.log(response);
}

checkContact();
[
  {
    "contact_id": "[email protected]",
    "exists": true
  },
  {
    "contact_id": "[email protected]",
    "exists": false
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Body

application/json
​
contact_ids
string[]
required
  • Array of contact IDs to check. Must be formatted as country_code + number (e.g., 918527184400). It should be a non-empty array
Example:
["919537851844", "919876543210"]

Response

200 - application/json

200 OK

​
contact_id
string

The contact_id of the contact

Example:

"919537851844"

​
exists
boolean

Whether the contact exists on WhatsApp

Example:

true