Get Campaign

Retrieve the full details of a single SMS campaign by its ID.

Endpoint

GET /sms/campaigns/:id

Returns: 200 OK

Headers

Header	Value	Required
Authorization	Bearer <your-api-key>	Yes

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The campaign ID.

Response

{
  "id": "0192a1b2-c3d4-7e5f-9000-abcdef123456",
  "name": "Summer Sale 2026",
  "description": "Sale announcement to KSA list",
  "content": "Acme Store: 50% off everything this weekend! Shop now: {{link}}",
  "from": "ACME",
  "country": "SA",
  "status": "Draft",
  "num_segments": 1,
  "scheduled_at": null,
  "sent_at": null,
  "created_at": "2026-04-27T12:00:00.000Z",
  "updated_at": "2026-04-27T12:00:00.000Z"
}

Response Fields

Field	Type	Description
id	string	Unique campaign ID.
name	string | null	Internal name for the campaign.
description	string | null	Internal description for the campaign.
content	string | null	The SMS message body.
from	string | null	Registered sender name used to deliver the campaign.
country	string | null	ISO 3166-1 alpha-2 country code auto-detected from the registered sender name (e.g. SA for Saudi Arabia, EG for Egypt).
status	string	Campaign status. One of Draft, Scheduled, Queued, Sending, Sent, Paused, Failed, Cancelled.
num_segments	number	Number of SMS segments this message will use. Matches Twilio's num_segments convention.
scheduled_at	string | null	ISO 8601 datetime if the campaign is scheduled; otherwise null.
sent_at	string | null	ISO 8601 datetime when the campaign finished sending; otherwise null.
created_at	string	ISO 8601 datetime when the campaign was created.
updated_at	string	ISO 8601 datetime when the campaign was last updated.

---

Examples

cURL

curl "https://api.arsel.sa/v1/sms/campaigns/0192a1b2-c3d4-7e5f-9000-abcdef123456" \
  -H "Authorization: Bearer be_your_api_key"

JavaScript

const campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";

const response = await fetch(
  `https://api.arsel.sa/v1/sms/campaigns/${campaignId}`,
  {
    headers: { Authorization: "Bearer be_your_api_key" },
  }
);

const campaign = await response.json();
console.log(`${campaign.name}: ${campaign.status}`);

Python

import requests

campaign_id = "0192a1b2-c3d4-7e5f-9000-abcdef123456"

response = requests.get(
    f"https://api.arsel.sa/v1/sms/campaigns/{campaign_id}",
    headers={"Authorization": "Bearer be_your_api_key"},
)

campaign = response.json()
print(f"{campaign['name']}: {campaign['status']}")

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");

var campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";
var response = await client.GetAsync(
    $"https://api.arsel.sa/v1/sms/campaigns/{campaignId}"
);
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);

PHP

<?php
$campaignId = "0192a1b2-c3d4-7e5f-9000-abcdef123456";
$ch = curl_init("https://api.arsel.sa/v1/sms/campaigns/{$campaignId}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$campaign = json_decode($response, true);
echo "{$campaign['name']}: {$campaign['status']}\n";
curl_close($ch);

---

Error Responses

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid or missing API key"
}

404 Not Found

{
  "status_code": 404,
  "name": "not_found",
  "message": "Campaign not found"
}