Batch delivery report

Legacy APIs - SMS
Starting a new integration? This is a legacy API. It stays available for existing integrations, but new integrations should use the SMS V3 APIs.

Get the delivery report of every message in a batch (one bulk send).

GEThttps://telcomw.com/api-v2/delivery/batch

Send the parameters in the URL (query parameters).

Parameters

Parameter Required Description
id YES The batch id of the messages.
api_key YES Your API key.

Example request

curl --location --request GET 'https://telcomw.com/api-v2/delivery/batch?id=BATCH_ID&api_key=YOUR_API_KEY'
curl --location --request GET "https://telcomw.com/api-v2/delivery/batch?id=BATCH_ID&api_key=YOUR_API_KEY"
<?php

$ch = curl_init('https://telcomw.com/api-v2/delivery/batch?id=BATCH_ID&api_key=YOUR_API_KEY');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
const axios = require('axios');

axios.request({
  method: 'get',
  url: 'https://telcomw.com/api-v2/delivery/batch',
  params: {
    'id': 'BATCH_ID',
    'api_key': 'YOUR_API_KEY'
  }
}).then((res) => console.log(res.data))
  .catch((err) => console.error(err.response ? err.response.data : err.message));
import requests

params = {
    'id': 'BATCH_ID',
    'api_key': 'YOUR_API_KEY'
}

response = requests.request('GET', 'https://telcomw.com/api-v2/delivery/batch', params=params)
print(response.json())

Response

The response is JSON.

{
  "msg": "Batch details retrieved successfully",
  "type": "success",
  "code": "200",
  "data": [
    {
      "to": "265992026866",
      "from": "WGIT",
      "text": "Your message",
      "status": 4,
      "state": "Delivered",
      "sent_at": "2024-11-12 12:07:54",
      "delivered_at": "2024-11-12 10:13:07"
    },
    {
      "to": "265884113450",
      "from": "WGIT",
      "text": "Your message",
      "status": 4,
      "state": "Delivered",
      "sent_at": "2024-11-12 12:07:54",
      "delivered_at": null
    }
  ]
}

Fields explained

FieldDescription
data[].toThe phone number the message was sent to.
data[].fromThe sender ID.
data[].textThe message.
data[].statusThe status of the message as a number: 3 pending, 4 delivered, 6 failed.
data[].stateThe same in words: Pending, Delivered or Failed.
data[].sent_atWhen the message was sent.
data[].delivered_atWhen the message was delivered, null until it is delivered.