Global API Gateway (1.0.0)

Download OpenAPI specification:Download

🔑 Need an API Key?

Get your API key to start using our APIs with higher rate limits and priority support.

Dynamic API Proxy

JSON-driven API proxy; add new APIs by adding JSON only

WhatsApp Number Validation & Profile Lookup

Verify whether phone numbers are registered on WhatsApp and retrieve public profile data in real time: account existence, profile photo (avatar/DP), About status text, presence/last-seen, and full WhatsApp Business profile (name, verified level, description, address, email, website). A two-step flow keeps lookups efficient — first call a check-exist endpoint to confirm the number and obtain a userHash, then pass that userHash to the profile endpoints. RESTful JSON API for lead validation, CRM enrichment, and customer intelligence.

Check WhatsApp Account Exists (by Full Number)

path Parameters
phoneNumber
required
string

e.g. 551121770100

query Parameters
key
required
string

API Key (ak_...)

Responses

Check WhatsApp Account Exists (CC + Phone Split)

query Parameters
key
required
string

API Key (ak_...)

cc
required
string

e.g. 55

phone
required
string

e.g. 1121770100

Responses

Get Profile Avatar (Display Photo)

query Parameters
key
required
string

API Key (ak_...)

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

type
string

type (string)

Responses

Get About / Status Text

query Parameters
key
required
string

API Key (ak_...)

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Get Business Profile

query Parameters
key
required
string

API Key (ak_...)

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Get Presence / Last Seen

query Parameters
key
required
string

API Key (ak_...)

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Check Active Status

path Parameters
phoneNumber
required
string

e.g. 551121770100

query Parameters
key
required
string

API Key (ak_...)

Responses

Batch Check (up to 10 numbers)

query Parameters
key
required
string

API Key (ak_...)

accounts
required
string

e.g. 551121770100,5511999999999

Responses

Telegram Number Validation & Profile Lookup

Check in real time whether a phone number is registered on Telegram and retrieve public profile fields: username, display name, About bio, Telegram user ID, common-chats count, call availability, last-seen timestamp, and quality/risk flags (premium, verified, bot, scam, fake, deleted, restricted). A single GET by phone number returns a clear registered=true/false plus profile data when available. RESTful JSON API for lead validation, account quality scoring, and contact enrichment.

Telegram Lookup by Phone Number

path Parameters
phoneNumber
required
string

e.g. 16156296515

query Parameters
key
required
string

API Key (ak_...)

Responses

WhatsApp Messaging API

WhatsApp capabilities wrapped as a simple REST API: link your own WhatsApp account via QR or pairing code, then send text messages, read the inbox, browse chat history, download media, look up contacts, and create and manage groups. A session-based flow keeps things simple — create a session, complete login on your phone, then reuse the sessionId across every messaging, contact, and group endpoint. Ideal for support bots, marketing automation, two-way CRM sync, and cross-border e-commerce outreach, and easy to wire into n8n, Zapier, or Make workflows. Not the official WhatsApp Business Cloud API — use only with authorized accounts and in compliance with WhatsApp's Terms of Service.

Create a WhatsApp Session (QR / Pairing Login)

query Parameters
key
required
string

API Key (ak_...)

Request Body schema: application/json
required
mode
required
string

mode

deviceName
string

My Bot

phoneNumber
string

8613800138000 (required for pairing mode)

Responses

Request samples

Content type
application/json
{
  • "mode": "string",
  • "deviceName": "My Bot",
  • "phoneNumber": "8613800138000 (required for pairing mode)"
}

Send a Text Message

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

Request Body schema: application/json
required
to
required
string

8613800138000

text
required
string

Hello!

Responses

Request samples

Content type
application/json
{
  • "to": "8613800138000",
  • "text": "Hello!"
}

List Recent Incoming Messages

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

limit
number

e.g. 50 (max 500)

Responses

List All Chats

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

Responses

List Messages in a Chat

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

chatJid
required
query Parameters
key
required
string

API Key (ak_...)

limit
number

e.g. 20

Responses

Download Message Media

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

chatJid
required
messageId
required
string

e.g. 3EB0XXXXXXXXXXXXXXXX

query Parameters
key
required
string

API Key (ak_...)

Responses

List Contacts

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

Responses

Check Whether a Number Is on WhatsApp

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

phoneNumber
required
string

e.g. 8613800138000

query Parameters
key
required
string

API Key (ak_...)

Responses

Get a Contact's About Text

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

phoneNumber
required
string

e.g. 8613800138000

query Parameters
key
required
string

API Key (ak_...)

Responses

Get a Contact's Profile Picture URL

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

phoneNumber
required
string

e.g. 8613800138000

query Parameters
key
required
string

API Key (ak_...)

Responses

Get Logged-in Account Info

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

Responses

Get Group Metadata

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

groupJid
required
query Parameters
key
required
string

API Key (ak_...)

Responses

Create a WhatsApp Group

path Parameters
sessionId
required
string

e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6

query Parameters
key
required
string

API Key (ak_...)

Request Body schema: application/json
required
body
required
string

{"name":"Support Group","participants":[8613800138000,4915256515060]}

Responses

Request samples

Content type
application/json
{
  • "body": "{\"name\":\"Support Group\",\"participants\":[8613800138000,4915256515060]}"
}

Signal Number Validation & Profile Lookup

Check in real time whether a phone number is registered on Signal and retrieve a compact set of public profile fields: display name, given/family name, About bio, E.164 phone, stable ACI/PNI UUIDs, avatar color, registration status, and trust flags (blocked, verified, profile-sharing). A single GET by phone number returns a clear registered=true/false plus profile data when available. RESTful JSON API for lead validation, identity resolution, and risk scoring.

Signal Lookup by Phone Number

path Parameters
phoneNumber
required
string

e.g. 17135193910

query Parameters
key
required
string

API Key (ak_...)

Responses