Reference 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 one message with its reference.

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

Send the parameters in the URL (query parameters).

Parameters

Parameter Required Description
id YES The reference of the message (the id returned when the message was sent).
api_key YES Your API key.

Example request

curl --location --request GET 'https://telcomw.com/api-v2/delivery/reference?id=reference_id&api_key=your_api_key'
curl --location --request GET "https://telcomw.com/api-v2/delivery/reference?id=reference_id&api_key=your_api_key"
<?php

$ch = curl_init('https://telcomw.com/api-v2/delivery/reference?id=reference_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/reference',
  params: {
    'id': 'reference_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': 'reference_id',
    'api_key': 'your_api_key'
}

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

Response

The response is JSON.

{
  "msg": "Message 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",
    "message_batch": "mrj6tfmtzguk"
  }
}

Fields explained

FieldDescription
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.message_batchThe batch id the message belongs to. Use it with the batch delivery report.