Bulk Jobs API

Track the status of your bulk messaging campaigns.

List Bulk Jobs

Endpoint: GET /messages/bulk-jobs

Get Job Status

Endpoint: GET /messages/bulk-jobs/:id

Code Examples

Node.js

const axios = require('axios');

const checkStatus = async (jobId) => {
  try {
    const response = await axios.get(`https://api.whatsspot.in/messages/bulk-jobs/${jobId}`, {
      headers: { 'x-api-key': 'YOUR_API_TOKEN' }
    });
    console.log(`Status: ${response.data.status}`);
    console.log(`Sent: ${response.data.sentCount}, Failed: ${response.data.failedCount}`);
  } catch (error) {
    console.error(error);
  }
};

checkStatus('job_abc123');

Python

import requests

job_id = "job_abc123"
url = f"https://api.whatsspot.in/messages/bulk-jobs/{job_id}"
headers = {"x-api-key": "YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "success": true,
  "data": {
    "id": "job_abc123",
    "status": "COMPLETED",
    "totalContacts": 50,
    "sentCount": 48,
    "failedCount": 2,
    "createdAt": "2023-10-27T10:00:00Z"
  }
}