Campaigns (bulk)
Recipients and button replies
GET
/v2/campaigns/{campaignId}/recipients- Scope:
campaigns:read - Idempotency-Key:not used
- read only
Available while running and during the keep window.
Parameters
Path
| Name | Type | Constraints | Description |
|---|---|---|---|
campaignIdrequired | Typestring | Constraints— | DescriptionCampaign id. |
Query
| Name | Type | Constraints | Description |
|---|---|---|---|
limitoptional | Typestring | Constraints— | Description1–500 (default 50). |
cursoroptional | Typestring | Constraints— | DescriptionnextCursor of the previous page. |
statusoptional | Typestring | Constraints— | DescriptionQUEUED | SENDING | SENT | FAILED | SKIPPED |
replyoptional | Typestring | Constraints— | DescriptionButton reply filter: an option id, ANY or NONE. |
Headers
| Name | Type | Constraints | Description |
|---|---|---|---|
X-Request-Idoptional | Typestring | Constraints— | DescriptionOptional: your own request id, echoed back (otherwise we generate req_…). Quote it to support. |
Request
curl -X GET "https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/recipients?status=FAILED" \
-H "Authorization: Bearer $WASLA_API_KEY"const res = await fetch('https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/recipients?status=FAILED', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.WASLA_API_KEY}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);import os
import requests
headers = {"Authorization": f"Bearer {os.environ['WASLA_API_KEY']}"}
res = requests.get(
"https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/recipients?status=FAILED",
headers=headers,
timeout=30,
)
data = res.json()
if not res.ok:
raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)<?php
$ch = curl_init('https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/recipients?status=FAILED');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('WASLA_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) { throw new Exception($data['error']['code'] . ': ' . $data['error']['message']); }
print_r($data);Response
200Example
{
"data": [
{
"phone": "201001234567",
"status": "sent",
"errorCode": null,
"sentAt": "…",
"deliveredAt": "…",
"readAt": null,
"repliedAt": null,
"optedOut": false,
"buttonReply": {
"id": "yes",
"title": "مهتم",
"index": 1,
"at": "…"
}
}
],
"nextCursor": null
}Response schema
Fields of the example answer. Expand objects and arrays.
responseobject2 fields
dataarray1 items
[0]object9 fields
- phonestring "201001234567"
- statusstring "sent"
- errorCodenull null
- sentAtstring "…"
- deliveredAtstring "…"
- readAtnull null
- repliedAtnull null
- optedOutboolean false
buttonReplyobject4 fields
- idstring "yes"
- titlestring "مهتم"
- indexinteger 1
- atstring "…"
- nextCursornull null
Errors
Besides the authentication, rate-limit and validation errors every endpoint can return:
- 410CAMPAIGN_PURGEDRecipients were deleted after the campaign ended (privacy).
Try it
Send this request from your browser to the Mursilat API.
documented examplePreview — this copy of the docs isn’t on mursilat.com, so the console shows the documented example instead of calling the API.
Real requests use your real number and plan: they can send WhatsApp messages, spend quota and delete data. (read only)
Kept only in this tab’s memory: never saved, never put in the URL, sent only to mursilat.com. Reloading the page forgets it.