Documentation | Check WA

DO QUERY

POST: https://checkwa.online/api/v1/check.php

With country code and number in different parameters:

{
  "user": "YOUR-USERNAME", // Username
  "apikey": "YOUR-API-KEY", // Api key
  "token": "193e123x2", // Unique ID for indentify response (optional)
  "callback": "https://www.callbackurl.com/", // Callback URL for response (optional)
  "num": "666666666", // Number without country code
  "cod": "34" // Country code
}

With country code and number in same parameter:

{
  "user": "YOUR-USERNAME", // Username
  "apikey": "YOUR-API-KEY", // Api key
  "token": "193e123x2", // Unique ID for indentify response (optional)
  "callback": "https://www.callbackurl.com/", // Callback URL for response (optional)
  "number": "34666666666" // Number with country code
}

RESPONSE

(application/json)

{
  "code": "1", // Response code (1 = uses whatsapp, 0 = don’t uses whatsapp)
  "token": "193e123x2", // Unique ID for indetify response
  "callback": "https://www.callbackurl.com/" // Your calllback URL for response
}

RESPONSE IN CALLBACK URL

(application/json)

Example for response when number uses WhatsApp:

{
  "code": "1", // 1 = Uses WhatsApp, 0 = Don’t uses WhatsApp
  "num": "34666666666", // Number (with country code)
  "token": "193e123x2"
}

Example for response when number don’t uses WhatsApp:

{
  "code": "0",
  "num": "34666666667",
  "token": "193e123x2"
}

RESPONSE CODES IN YOUR CALL

0: Don’t uses whatsapp
1: Uses whatsapp
3: Username or API KEY wrong
4: Unknow action
5: Number format incorrect
6: Credit limit exceeded
7: Too many numbers in queue
(6): Number queued if use callback url, or rejected if don’t use callback url

BULK QUERY

POST: https://checkwa.online/api/v1/bulk.php

{
  "user": "YOUR-USERNAME",
  "apikey": "YOUR-API-KEY",
  "numbers": ["972542654444","97239602767","972545271265"]
}

CHECK CREDIT

POST: https://checkwa.online/api/v1/credit.php

{
  "user": "YOUR-USERNAME",
  "apikey": "YOUR-API-KEY"
}

GET SERVICES (ASYNC)

POST: https://checkwa.online/api/v1/services.php

{
  "user": "YOUR-USERNAME",
  "apikey": "YOUR-API-KEY"
}

Response:

{
  "success": true,
  "services": [
    {
      "id": 1,
      "name": "Active WA Check",
      "category": "active",
      "price_per_10k": 5.00,
      "type_code": "ACTIVE_1"
    }
  ]
}

CREATE JOB (ASYNC)

POST: https://checkwa.online/api/v1/create_job.php

Requires a minimum of 2000 numbers.

{
  "user": "YOUR-USERNAME",
  "apikey": "YOUR-API-KEY",
  "service_id": 1,
  "numbers": ["34600112233", "34611223344", "... at least 2000 numbers"]
}

Response:

{
  "success": true,
  "message": "Job created successfully",
  "job_id": 125,
  "remaining_credits": 495.00
}

CHECK JOB STATUS (ASYNC)

POST: https://checkwa.online/api/v1/job_status.php

{
  "user": "YOUR-USERNAME",
  "apikey": "YOUR-API-KEY",
  "job_id": 125
}

Response (When Pending/Processing):

{
  "success": true,
  "job_id": 125,
  "service_name": "Active WA Check",
  "status": "processing",
  "total_numbers": 2500,
  "created_at": "2023-10-01 10:00:00",
  "updated_at": "2023-10-01 10:05:00"
}

Response (When Completed):

{
  "success": true,
  "job_id": 125,
  "service_name": "Active WA Check",
  "status": "completed",
  "total_numbers": 2500,
  "created_at": "2023-10-01 10:00:00",
  "updated_at": "2023-10-01 10:15:00",
  "activated_count": 2100,
  "unregistered_count": 400,
  "result_url": "https://checkwa.online/results/result_125_1696144500.zip"
}

REQUERIMENTS FOR CALLBACK URL

Headers

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: x-test-header, Origin, X-Requested-With, Content-Type, Accept

Your server must have a valid SSL certificate. (These parameters are mandatory, otherwise we will not be able to send the results)

Example file endpoint: https://w2.checkwa.com/return.zip

API Documentation

Contents