Verification Status API

End Point: https://wbiztool.com/api/v1/verification/status/

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)
• campaign_id (Integer) - The campaign ID returned from the verification create API

Fields in Response

• status (String) - "success" if request processed successfully
• campaign_id (Integer) - ID of the verification campaign
• campaign_name (String) - Name of the verification campaign
• overall_status (String) - Overall status: "pending", "processing", or "completed"
• progress (Object) - Progress information with total, pending, verified, invalid counts and completion percentage
• results (Array) - Array of verification results with number, status, and timestamps
• created_at (String) - Campaign creation timestamp
• last_updated (String) - Last update timestamp

Example

The following example shows how to check the status of a verification campaign.

curl -X GET "https://wbiztool.com/api/v1/verification/status/?campaign_id=123" \
-H "Authorization: Bearer your_api_key"

// Response
{
    "status": "success",
    "campaign_id": 123,
    "campaign_name": "Customer Numbers Verification",
    "overall_status": "processing",
    "progress": {
        "total": 3,
        "pending": 1,
        "verified": 2,
        "invalid": 0,
        "completed_percentage": 66.67
    },
    "results": [
        {
            "number": "919876543210",
            "status": "verified",
            "checked_at": "2024-01-15T10:30:00Z",
            "created_at": "2024-01-15T10:00:00Z"
        },
        {
            "number": "911234567890",
            "status": "verified",
            "checked_at": "2024-01-15T10:31:00Z",
            "created_at": "2024-01-15T10:00:00Z"
        },
        {
            "number": "919999888877",
            "status": "pending",
            "checked_at": null,
            "created_at": "2024-01-15T10:00:00Z"
        }
    ],
    "created_at": "2024-01-15T10:00:00Z",
    "last_updated": "2024-01-15T10:31:00Z"
}

import requests

# Your API key
api_key = "your_api_key"

# Campaign ID to check
campaign_id = 123

# API endpoint
url = f"https://wbiztool.com/api/v1/verification/status/?campaign_id={campaign_id}"

# Request headers
headers = {
    "Authorization": f"Bearer {api_key}"
}

# Make the request
response = requests.get(url, headers=headers)
result = response.json()

print("Overall Status:", result.get("overall_status"))
print("Progress:", result.get("progress"))

# Check individual results
for item in result.get("results", []):
    print(f"Number: {item['number']}, Status: {item['status']}")

const axios = require('axios');

const apiKey = "your_api_key";
const campaignId = 123;
const url = `https://wbiztool.com/api/v1/verification/status/?campaign_id=${campaignId}`;

const headers = {
    "Authorization": `Bearer ${apiKey}`
};

axios.get(url, { headers })
    .then(response => {
        const result = response.data;
        console.log("Overall Status:", result.overall_status);
        console.log("Progress:", result.progress);
        
        // Display individual results
        result.results.forEach(item => {
            console.log(`Number: ${item.number}, Status: ${item.status}`);
        });
    })
    .catch(error => {
        console.error("Error:", error.response.data);
    });

import java.io.IOException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;

public class VerificationStatus {
    public static void main(String[] args) throws IOException, InterruptedException {
        String apiKey = "your_api_key";
        int campaignId = 123;
        String url = "https://wbiztool.com/api/v1/verification/status/?campaign_id=" + campaignId;
        
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer " + apiKey)
                .GET()
                .build();
        
        HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
        
        Gson gson = new Gson();
        JsonObject result = gson.fromJson(response.body(), JsonObject.class);
        
        System.out.println("Overall Status: " + result.get("overall_status").getAsString());
        System.out.println("Campaign Name: " + result.get("campaign_name").getAsString());
        
        JsonObject progress = result.getAsJsonObject("progress");
        System.out.println("Total: " + progress.get("total").getAsInt());
        System.out.println("Verified: " + progress.get("verified").getAsInt());
        System.out.println("Pending: " + progress.get("pending").getAsInt());
        System.out.println("Completion: " + progress.get("completed_percentage").getAsDouble() + "%");
    }
}

Status Values

• pending - Number verification is queued but not yet started
• verified - Number is a valid WhatsApp number
• invalid - Number is not a valid WhatsApp number or group

Overall Status Values

• pending - All numbers are still waiting to be processed
• processing - Some numbers have been processed, others are still pending
• completed - All numbers have been processed