Skip to main content
GET
/
api
/
v1
/
campaign
/
report
/
sms
/
{messageId}
Get SMS Message Report
curl --request GET \
  --url https://api.example.com/api/v1/campaign/report/sms/{messageId}
import requests

url = "https://api.example.com/api/v1/campaign/report/sms/{messageId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/campaign/report/sms/{messageId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/campaign/report/sms/{messageId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/campaign/report/sms/{messageId}"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/campaign/report/sms/{messageId}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaign/report/sms/{messageId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "status": true,
  "message": "Successfully fetched",
  "data": {
    "accountId": "652e5068c33fe15059e5s020",
    "messageId": "66e120d1b9ee33b6ba00fsd7",
    "campaignId": "66e120d1b9eht5059e5e01d",
    "status": "DELIVERED",
    "statusAt": "2024-09-11T04:47:16.000Z",
    "destination": "919090909090",
    "remark": ""
  }
}
{
  "status": false,
  "message": "Report data not found"
}
{
  "status": false,
  "message": "No token provided"
}

Path Params

messageId
string
required
Enter the message ID that you received when sending the campaign.

Response

status
boolean
Indicates whether the call was successful. true if successful, false if not.
message
string
success or error response message
data
array_object
The contents of uploaded file
{
  "status": true,
  "message": "Successfully fetched",
  "data": {
    "accountId": "652e5068c33fe15059e5s020",
    "messageId": "66e120d1b9ee33b6ba00fsd7",
    "campaignId": "66e120d1b9eht5059e5e01d",
    "status": "DELIVERED",
    "statusAt": "2024-09-11T04:47:16.000Z",
    "destination": "919090909090",
    "remark": ""
  }
}
{
  "status": false,
  "message": "Report data not found"
}
{
  "status": false,
  "message": "No token provided"
}