WhatsApp Number Verification Results API
End Point: https://wbiztool.com/api/v1/verification/results/
Request Type: GET
Required Parameters
-
api_key (String)
- Your API Key (Given on API Keys page) (Can be sent in Authorization header as Bearer token)
Optional Parameters
-
campaign_id (Integer)
- Filter results by specific campaign ID -
status (String)
- Filter by verification status: "pending", "verified", or "invalid" -
limit (Integer)
- Number of results per page (default: 100, max: 1000) -
offset (Integer)
- Number of results to skip for pagination (default: 0)
Fields in Response
-
status (String)
- "success" if request processed successfully -
total_count (Integer)
- Total number of verification results matching filters -
returned_count (Integer)
- Number of results returned in this response -
limit (Integer)
- Results per page limit used -
offset (Integer)
- Offset used for pagination -
has_more (Boolean)
- Whether there are more results available -
results (Array)
- Array of verification results with detailed information
Example
The following example shows how to retrieve verification results with filtering and pagination.
curl -X GET "https://wbiztool.com/api/v1/verification/results/?campaign_id=123&status=verified&limit=50&offset=0" \
-H "Authorization: Bearer your_api_key"
// Response
{
"status": "success",
"total_count": 150,
"returned_count": 50,
"limit": 50,
"offset": 0,
"has_more": true,
"results": [
{
"id": 1001,
"campaign_id": 123,
"campaign_name": "Customer Numbers Verification",
"number": "919876543210",
"status": "verified",
"checked_at": "2024-01-15T10:30:00Z",
"created_at": "2024-01-15T10:00:00Z"
},
{
"id": 1002,
"campaign_id": 123,
"campaign_name": "Customer Numbers Verification",
"number": "911234567890",
"status": "verified",
"checked_at": "2024-01-15T10:31:00Z",
"created_at": "2024-01-15T10:00:00Z"
}
]
}
Retrieve WhatsApp Number Verification Results with Python
import requests
# Your API key
api_key = "your_api_key"
# API endpoint with optional filters
url = "https://wbiztool.com/api/v1/verification/results/"
# Request headers
headers = {
"Authorization": f"Bearer {api_key}"
}
# Optional parameters for filtering and pagination
params = {
"campaign_id": 123, # Optional: filter by campaign
"status": "verified", # Optional: filter by status
"limit": 50, # Optional: results per page
"offset": 0 # Optional: pagination offset
}
# Make the request
response = requests.get(url, headers=headers, params=params)
result = response.json()
print("Total results:", result.get("total_count"))
print("Returned:", result.get("returned_count"))
print("Has more:", result.get("has_more"))
# Process results
for item in result.get("results", []):
print(f"Number: {item['number']}, Status: {item['status']}, Campaign: {item['campaign_name']}")
# Pagination example - get next page
if result.get("has_more"):
next_params = params.copy()
next_params["offset"] = params["offset"] + params["limit"]
next_response = requests.get(url, headers=headers, params=next_params)
# Process next page...
Retrieve WhatsApp Number Verification Results with PHP
123,
"status" => "verified",
"limit" => 50,
"offset" => 0
];
$url = "https://wbiztool.com/api/v1/verification/results/?" . http_build_query($params);
$headers = [
"Authorization: Bearer " . $api_key
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$result = json_decode($response, true);
echo "Total results: " . $result["total_count"] . "\n";
echo "Returned: " . $result["returned_count"] . "\n";
echo "Has more: " . ($result["has_more"] ? "Yes" : "No") . "\n";
// Process results
foreach ($result["results"] as $item) {
echo "Number: " . $item["number"] . ", Status: " . $item["status"] . "\n";
}
// Pagination - get all results
$all_results = $result["results"];
$offset = $params["limit"];
while ($result["has_more"]) {
$params["offset"] = $offset;
$url = "https://wbiztool.com/api/v1/verification/results/?" . http_build_query($params);
curl_setopt($ch, CURLOPT_URL, $url);
$response = curl_exec($ch);
$result = json_decode($response, true);
$all_results = array_merge($all_results, $result["results"]);
$offset += $params["limit"];
}
curl_close($ch);
echo "Total fetched: " . count($all_results) . " results\n";
?>
Retrieve WhatsApp Number Verification Results with Node.js
const axios = require('axios');
const apiKey = "your_api_key";
const baseUrl = "https://wbiztool.com/api/v1/verification/results/";
const headers = {
"Authorization": `Bearer ${apiKey}`
};
// Function to get results with pagination
async function getAllVerificationResults(campaignId = null, status = null) {
let allResults = [];
let offset = 0;
const limit = 100;
let hasMore = true;
while (hasMore) {
const params = {
limit: limit,
offset: offset
};
if (campaignId) params.campaign_id = campaignId;
if (status) params.status = status;
try {
const response = await axios.get(baseUrl, {
headers: headers,
params: params
});
const result = response.data;
allResults = allResults.concat(result.results);
console.log(`Fetched ${result.returned_count} results (${allResults.length}/${result.total_count})`);
hasMore = result.has_more;
offset += limit;
} catch (error) {
console.error("Error:", error.response.data);
break;
}
}
return allResults;
}
// Usage examples
async function main() {
// Get all verified numbers
const verifiedNumbers = await getAllVerificationResults(null, "verified");
console.log(`Total verified numbers: ${verifiedNumbers.length}`);
// Get results for specific campaign
const campaignResults = await getAllVerificationResults(123);
console.log(`Campaign 123 results: ${campaignResults.length}`);
// Process results
verifiedNumbers.forEach(item => {
console.log(`${item.number} - ${item.status} (Campaign: ${item.campaign_name})`);
});
}
main();
Retrieve WhatsApp Number Verification Results with Java
import java.io.IOException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
import java.util.ArrayList;
import java.util.List;
public class VerificationResults {
private static final String API_KEY = "your_api_key";
private static final String BASE_URL = "https://wbiztool.com/api/v1/verification/results/";
public static void main(String[] args) throws IOException, InterruptedException {
// Get paginated results
List allResults = getAllResults(123, "verified");
System.out.println("Total results fetched: " + allResults.size());
// Process results
for (JsonObject result : allResults) {
System.out.println("Number: " + result.get("number").getAsString() +
", Status: " + result.get("status").getAsString() +
", Campaign: " + result.get("campaign_name").getAsString());
}
}
public static List getAllResults(Integer campaignId, String status)
throws IOException, InterruptedException {
List allResults = new ArrayList<>();
int offset = 0;
int limit = 100;
boolean hasMore = true;
HttpClient client = HttpClient.newHttpClient();
Gson gson = new Gson();
while (hasMore) {
StringBuilder urlBuilder = new StringBuilder(BASE_URL + "?limit=" + limit + "&offset=" + offset);
if (campaignId != null) {
urlBuilder.append("&campaign_id=").append(campaignId);
}
if (status != null && !status.isEmpty()) {
urlBuilder.append("&status=").append(URLEncoder.encode(status, StandardCharsets.UTF_8));
}
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(urlBuilder.toString()))
.header("Authorization", "Bearer " + API_KEY)
.GET()
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
JsonObject result = gson.fromJson(response.body(), JsonObject.class);
JsonArray results = result.getAsJsonArray("results");
for (int i = 0; i < results.size(); i++) {
allResults.add(results.get(i).getAsJsonObject());
}
hasMore = result.get("has_more").getAsBoolean();
offset += limit;
System.out.println("Fetched " + results.size() + " results (Total: " + allResults.size() + ")");
}
return allResults;
}
}
Pagination
The API supports pagination to handle large datasets efficiently:
- Use
limit
to specify how many results to return per request - Use
offset
to skip results (for pagination) - Check
has_more
to determine if more pages are available - Maximum limit is 1000 results per request
Filtering Options
campaign_id
- Get results for a specific verification campaignstatus=pending
- Get only numbers that are still being verifiedstatus=verified
- Get only valid WhatsApp numbersstatus=invalid
- Get only invalid/non-WhatsApp numbers
Use Cases
- Export verified numbers - Get all verified numbers for marketing campaigns
- Clean contact lists - Remove invalid numbers from your database
- Progress monitoring - Track verification progress across campaigns
- Reporting & Analytics - Generate reports on verification success rates
- Integration - Sync verification results with your CRM or marketing tools