· 3 min read
WhatsApp Bulk Number Checker Simple API
Learn how to use the WhatsApp Bulk Number Checker Simple API to verify WhatsApp account status for multiple phone numbers simultaneously.
WhatsApp is a globally dominant messaging platform, and verifying account status at scale can provide valuable insights for businesses. This article introduces the WhatsApp Bulk Number Checker Simple API, which enables efficient verification of WhatsApp account status for multiple numbers simultaneously.
Main Features
The WhatsApp Bulk Number Checker Simple API offers essential verification capabilities:
Account Verification
Quick and reliable verification of WhatsApp account status for any phone number globally.
Bulk Processing
Process multiple numbers simultaneously through file upload, making it efficient for large-scale verification.
Real-time Status Updates
Monitor the progress of your bulk verification tasks with real-time status updates.
Usage Steps
File Upload
Upload a text file containing phone numbers in E.164 format:
curl --location 'https://api.ekycpro.com/wa/api/simple/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'file=@"/path/to/file.txt"'
Get Task Details
To check the status of a task, you can make a GET request to the /wa/api/simple/tasks/{task_id}
endpoint, where {task_id}
is the ID of the task you want to check.
curl --location 'https://api.ekycpro.com/wa/api/simple/tasks/{TASK_ID}' \
--header 'X-API-Key: API-KEY'
Request Parameters
file
: The file containing the numbers to be checked.country_code
: The country code of the numbers in the file.numbers
: A comma-separated list of numbers to be checked.
Response Parameters
task_id
: The ID of the task.created_at
: The time the task was created.updated_at
: The time the task was last updated.status
: The status of the task.total
: The total number of numbers in the task.success
: The number of successfully checked numbers.fail
: The number of failed numbers.result_url
: The URL to download the result file.
Request Body
Parameter | Type | Description |
---|---|---|
file | file | File containing numbers to check, one number per line |
country_code | string | Country code for the numbers, e.g., “91” for India |
numbers | string | Comma-separated numbers to check, e.g., “919999999991,919999999992” |
Response Body
Parameter | Type | Description |
---|---|---|
task_id | string | The ID of the created task |
created_at | string | The creation time of the task |
updated_at | string | The last update time of the task |
status | string | The status of the task, e.g., pending, processing, completed, exported |
total | integer | The total number of numbers in the task |
success | integer | The number of successfully processed numbers |
fail | integer | The number of failed numbers |
result_url | string | The download address of the result file |
Result Fields
The API returns basic verification information including:
- Phone number (E.164 format)
- WhatsApp account status (yes/no)
API Response Format
The API provides detailed task status information:
created_at
: Task creation timestampupdated_at
: Last status update timestamptask_id
: Unique task identifieruser_id
: User identifierstatus
: Current task status (pending/processing/completed/exported)total
: Total numbers processedsuccess
: Successfully processed numbersfailure
: Failed processing attemptsresult_url
: Download URL for completed results
Request Parameters
For file upload:
Parameter | Description |
---|---|
file | file , Upload file, each line should contain one phone number in E.164 format |
For status check:
Parameter | Description |
---|---|
user_id | string , User ID |
FAQ
1. What is the processing capacity of the API?
The API can handle large batches of numbers efficiently, with real-time status updates on processing progress.
2. What format should the input file be in?
The input file should be a text file with one phone number per line in E.164 format (e.g., +41798284651).
3. What information does the API return?
The API returns basic verification information: whether a phone number has an active WhatsApp account or not.
4. What are the API response status codes?
200
: Successful request (charged)400
: Invalid parameters or file format (free)500
: Internal server error (free)
5. What is the pricing for the API?
The price is $1 USD per 10,000 numbers for basic WhatsApp account status verification.
For more information about pricing and higher volume processing, please contact us.