الحملات (إرسال جماعي)
المستلمين وردود الأزرار
GET
/v2/campaigns/{campaignId}/recipients- الصلاحية:
campaigns:read - Idempotency-Key:مش مستخدم
- قراءة بس
متاحة وقت التشغيل وخلال فترة الحفظ.
البارامترات
المسار
| الاسم | النوع | القيود | الوصف |
|---|---|---|---|
campaignIdإجباري | النوعstring | القيود— | الوصفid الحملة. |
الاستعلام (Query)
| الاسم | النوع | القيود | الوصف |
|---|---|---|---|
limitاختياري | النوعstring | القيود— | الوصفمن 1 لـ 500 (الافتراضي 50). |
cursorاختياري | النوعstring | القيود— | الوصفnextCursor من الصفحة اللي قبلها. |
statusاختياري | النوعstring | القيود— | الوصفQUEUED | SENDING | SENT | FAILED | SKIPPED |
replyاختياري | النوعstring | القيود— | الوصففلتر رد الأزرار: id اختيار أو ANY أو NONE. |
الهيدرز
| الاسم | النوع | القيود | الوصف |
|---|---|---|---|
X-Request-Idاختياري | النوعstring | القيود— | الوصفاختياري: id الطلب بتاعك وبيرجعلك (غير كده بنعمل req_…). اديه للدعم لو احتجت. |
الطلب
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);الرد
200مثال
{
"data": [
{
"phone": "201001234567",
"status": "sent",
"errorCode": null,
"sentAt": "…",
"deliveredAt": "…",
"readAt": null,
"repliedAt": null,
"optedOut": false,
"buttonReply": {
"id": "yes",
"title": "مهتم",
"index": 1,
"at": "…"
}
}
],
"nextCursor": null
}شكل الرد
حقول الرد في المثال. افتح الكائنات والقوايم.
responseobject2 حقل
dataarray1 عنصر
[0]object9 حقل
- phonestring "201001234567"
- statusstring "sent"
- errorCodenull null
- sentAtstring "…"
- deliveredAtstring "…"
- readAtnull null
- repliedAtnull null
- optedOutboolean false
buttonReplyobject4 حقل
- idstring "yes"
- titlestring "مهتم"
- indexinteger 1
- atstring "…"
- nextCursornull null
الأخطاء
غير أخطاء المصادقة وحدود الطلبات والتحقق اللي ممكن ترجع من أي endpoint:
- 410CAMPAIGN_PURGEDالمستلمين اتمسحوا بعد ما الحملة خلصت (خصوصية).
جرّب
ابعت الطلب ده من متصفحك لـ API مرسلات.
مثال موثّقمعاينة — النسخة دي من التوثيق مش على mursilat.com، فالكونسول بيعرض المثال الموثّق بدل ما يكلم الـ API.
الطلبات الحقيقية بتستخدم رقمك وباقتك الحقيقيين: ممكن تبعت رسايل واتساب وتصرف من رصيدك وتمسح بيانات. (قراءة بس)
متخزن في ذاكرة التبويب ده بس: عمره ما بيتحفظ ولا بيتحط في الرابط، وبيتبعت لـ mursilat.com بس. لو عملت reload بيتنسي.