الحملات (إرسال جماعي)
إنشاء وتشغيل حملة
/v2/campaigns- الصلاحية:
campaigns:write - Idempotency-Key:إجباري
- بيبعت رسايل
المحتوى: نص، صورة/فيديو/صوت/ملف (media.url)، موقع، جهة اتصال، زرار رابط، أزرار، قائمة. المستلمين في الطلب (لحد 10,000 بمتغيرات) أو contactListId أو audience.
البارامترات
الهيدرز
| الاسم | النوع | القيود | الوصف |
|---|---|---|---|
Idempotency-Keyإجباري | النوعstring | القيود≤ 191 حرف | الوصفid فريد من عندك للعملية دي (حد أقصى 191 حرف ASCII). لو كررت بنفس المفتاح ونفس الـ body بيرجعلك أول رد ومعاه Idempotent-Replayed: true — عمرها ما تتنفذ مرتين. بيتحفظ 24 ساعة. |
X-Request-Idاختياري | النوعstring | القيود— | الوصفاختياري: id الطلب بتاعك وبيرجعلك (غير كده بنعمل req_…). اديه للدعم لو احتجت. |
الـ Body
| الاسم | النوع | القيود | الوصف |
|---|---|---|---|
numberIdإجباري | النوعstring | القيود— | الوصفالرقم اللي هتشتغل عليه (الـ id من GET /v2/numbers). المفتاح المقصور على أرقام معينة يستخدمها هي بس. |
nameإجباري | النوعstring | القيود≤ 120 حرف | الوصفاسم الحملة للتقارير (حد أقصى 120). |
contentإجباري | النوعobject | القيود— | الوصفالمحتوى: { type, … } بنص أو image / video / audio / document (media.url) أو location أو contact أو cta_url أو buttons أو list. استخدم {متغير|بديل} و [[صيغة|تانية]] عشان النصوص تختلف. |
recipientsاختياري | النوعobject[] | القيود≤ 10000 عنصر | الوصفالجمهور مباشرة (حد أقصى 10,000). أو استخدم contactListId / audience بدلها. |
recipients[].phoneاختياري | النوعstring | القيود— | الوصفرقم المستلم، دولي. الأرقام الغلط واللي لغت اشتراكها بتتخطى ومش بيتبعتلها. |
recipients[].variablesاختياري | النوعobject | القيود— | الوصفقيم الـ {متغيرات} في المحتوى، مثلًا { "name": "منى" }. |
contactListIdاختياري | النوعstring | القيود— | الوصفابعت لقائمة جهات اتصال محفوظة بدل الأرقام المباشرة. |
audienceاختياري | النوعobject | القيود— | الوصفاختار جهات الاتصال بالقوايم والتاجز. |
audience.listIdsاختياري | النوعarray | القيود— | الوصفقوايم جهات الاتصال اللي تدخل. |
audience.tagsاختياري | النوعarray | القيود— | الوصفجهات الاتصال اللي عليها أي تاج من دول. |
audience.excludeTagsاختياري | النوعarray | القيود— | الوصفتخطى جهات الاتصال اللي عليها أي تاج من دول. |
optInConfirmedإجباري | النوعboolean | القيودلازم true | الوصفلازم true: بتأكد إن كل المستلمين وافقوا يستقبلوا منك. إجباري في كل حملة. |
speedاختياري | النوعstring | القيودواحد من: SAFE · NORMAL · FAST | الوصفسرعة الإرسال (الافتراضي NORMAL). SAFE الأبطأ وأحسن اختيار للأرقام الجديدة؛ وكل السرعات جوه حدود حماية الرقم. |
scheduleAtاختياري | النوعstring (date-time) | القيود— | الوصفابدأ بعدين (ISO 8601). ساعات الهدوء بتتطبق برضه. |
startاختياري | النوعboolean | القيودالافتراضي true | الوصفfalse بيعمل مسودة؛ ابدأها بعدين بـ POST /v2/campaigns/{id}/start. المسودات اللي ما بدأتش بتتمسح بعد 30 يوم. |
الطلب
curl -X POST "https://mursilat.com/api/v2/campaigns" \
-H "Authorization: Bearer $WASLA_API_KEY" \
-H "Idempotency-Key: order-1042-confirm" \
-H "Content-Type: application/json" \
-d '{
"numberId": "cm1abcd2345efgh6789ijkl",
"name": "عرض الجمعة",
"content": {
"type": "cta_url",
"body": {
"text": "أهلاً {name|عميلنا} 👋 خصم 20% لحد الجمعة"
},
"cta": {
"title": "شوف العرض",
"url": "https://example.com/offer?ref={name}"
}
},
"recipients": [
{
"phone": "201001234567",
"variables": {
"name": "منى"
}
},
{
"phone": "966501234567"
}
],
"optInConfirmed": true,
"speed": "SAFE"
}'const res = await fetch('https://mursilat.com/api/v2/campaigns', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.WASLA_API_KEY}`,
'Idempotency-Key': 'order-1042-confirm',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"numberId": "cm1abcd2345efgh6789ijkl",
"name": "عرض الجمعة",
"content": {
"type": "cta_url",
"body": {
"text": "أهلاً {name|عميلنا} 👋 خصم 20% لحد الجمعة"
},
"cta": {
"title": "شوف العرض",
"url": "https://example.com/offer?ref={name}"
}
},
"recipients": [
{
"phone": "201001234567",
"variables": {
"name": "منى"
}
},
{
"phone": "966501234567"
}
],
"optInConfirmed": true,
"speed": "SAFE"
}),
});
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']}", "Idempotency-Key": "order-1042-confirm"}
res = requests.post(
"https://mursilat.com/api/v2/campaigns",
headers=headers,
json={
"numberId": "cm1abcd2345efgh6789ijkl",
"name": "عرض الجمعة",
"content": {
"type": "cta_url",
"body": {
"text": "أهلاً {name|عميلنا} 👋 خصم 20% لحد الجمعة"
},
"cta": {
"title": "شوف العرض",
"url": "https://example.com/offer?ref={name}"
}
},
"recipients": [
{
"phone": "201001234567",
"variables": {
"name": "منى"
}
},
{
"phone": "966501234567"
}
],
"optInConfirmed": True,
"speed": "SAFE"
},
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');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('WASLA_API_KEY'),
'Idempotency-Key: order-1042-confirm',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'numberId' => 'cm1abcd2345efgh6789ijkl',
'name' => 'عرض الجمعة',
'content' => [
'type' => 'cta_url',
'body' => [
'text' => 'أهلاً {name|عميلنا} 👋 خصم 20% لحد الجمعة'
],
'cta' => [
'title' => 'شوف العرض',
'url' => 'https://example.com/offer?ref={name}'
]
],
'recipients' => [
[
'phone' => '201001234567',
'variables' => [
'name' => 'منى'
]
],
[
'phone' => '966501234567'
]
],
'optInConfirmed' => true,
'speed' => 'SAFE'
], JSON_UNESCAPED_UNICODE),
]);
$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);{
"numberId": "cm1abcd2345efgh6789ijkl",
"name": "عرض الجمعة",
"content": {
"type": "cta_url",
"body": {
"text": "أهلاً {name|عميلنا} 👋 خصم 20% لحد الجمعة"
},
"cta": {
"title": "شوف العرض",
"url": "https://example.com/offer?ref={name}"
}
},
"recipients": [
{
"phone": "201001234567",
"variables": {
"name": "منى"
}
},
{
"phone": "966501234567"
}
],
"optInConfirmed": true,
"speed": "SAFE"
}الرد
201مثال
{
"id": "cm2camp0001xyz",
"numberId": "cm1abcd2345efgh6789ijkl",
"name": "عرض الجمعة",
"status": "scheduled",
"contentType": "cta_url",
"createdVia": "api",
"speed": "SAFE",
"scheduledAt": null,
"startedAt": "2026-10-13T09:00:00.000Z",
"pausedAt": null,
"completedAt": null,
"pause": null,
"progress": {
"total": 500,
"queued": 380,
"sent": 120,
"delivered": 115,
"read": 70,
"replied": 9,
"failed": 0,
"skipped": 3,
"optOuts": 1,
"percent": 24
},
"replies": null,
"eta": {
"remaining": 380,
"perDayCap": 200,
"remainingToday": 80,
"estimatedMinutesToday": 34,
"extraDays": 2,
"note": "Estimate from the number warm-up caps and pacing."
},
"purged": false,
"purgedAt": null,
"createdAt": "2026-10-13T08:55:00.000Z",
"updatedAt": "2026-10-13T09:30:00.000Z",
"recipientsUpload": {
"total": 2,
"invalid": 0,
"notOnWhatsApp": 0,
"unchecked": 0
}
}شكل الرد
حقول الرد في المثال. افتح الكائنات والقوايم.
responseobject20 حقل
- idstring "cm2camp0001xyz"
- numberIdstring "cm1abcd2345efgh6789ijkl"
- namestring "عرض الجمعة"
- statusstring "scheduled"
- contentTypestring "cta_url"
- createdViastring "api"
- speedstring "SAFE"
- scheduledAtnull null
- startedAtstring "2026-10-13T09:00:00.000Z"
- pausedAtnull null
- completedAtnull null
- pausenull null
progressobject10 حقل
- totalinteger 500
- queuedinteger 380
- sentinteger 120
- deliveredinteger 115
- readinteger 70
- repliedinteger 9
- failedinteger 0
- skippedinteger 3
- optOutsinteger 1
- percentinteger 24
- repliesnull null
etaobject6 حقل
- remaininginteger 380
- perDayCapinteger 200
- remainingTodayinteger 80
- estimatedMinutesTodayinteger 34
- extraDaysinteger 2
- notestring "Estimate from the number warm-up caps and pacing."
- purgedboolean false
- purgedAtnull null
- createdAtstring "2026-10-13T08:55:00.000Z"
- updatedAtstring "2026-10-13T09:30:00.000Z"
recipientsUploadobject4 حقل
- totalinteger 2
- invalidinteger 0
- notOnWhatsAppinteger 0
- uncheckedinteger 0
الأخطاء
غير أخطاء المصادقة وحدود الطلبات والتحقق اللي ممكن ترجع من أي endpoint:
- 422CAMPAIGN_OPT_IN_REQUIREDأكّد إن المستلمين موافقين يستلموا رسايلك.
- 400CAMPAIGN_CONTENT_INVALIDمحتوى الحملة غلط.
- 400CAMPAIGN_RECIPIENTS_REQUIREDحدد مستلمين أو contactListId أو audience (واحد بس).
- 422CAMPAIGN_TOO_MANY_RECIPIENTSلحد 10,000 مستلم في الطلب.
- 422CAMPAIGN_NO_RECIPIENTSمفيش مستلمين صالحين.
- 400URL_SHORTENERروابط الاختصار ممنوعة.
- 403FEATURE_NOT_IN_PLANباقتك مش فيها الميزة دي.
حماية الرقم والسلوك
الحملات لأكتر من 50 رقم جديد محتاجة {متغير} أو [[spintax]] عشان النصوص تختلف.
حماية الرقم بتنظم سرعة الحملة (السرعة المختارة جوه حدود التسخين)، وبتستنى في ساعات الهدوء (الافتراضي 10 بالليل لـ 9 الصبح)، وبتتخطى الأرقام الغلط واللي لغت اشتراكها.
بتوقف الحملة لوحدها لو التسليم قليل (أقل من 80% في آخر ساعة) أو الإلغاءات كتير (أكتر من 3 من كل 100) أو واتساب حد السرعة — ساعة، وبعدها 24 ساعة. بيوصلك campaign.status بالسبب؛ وإيقاف المنصة مينفعش يتشال بدري (CAMPAIGN_RESUME_BLOCKED).
جرّب
ابعت الطلب ده من متصفحك لـ API مرسلات.
مثال موثّقمعاينة — النسخة دي من التوثيق مش على mursilat.com، فالكونسول بيعرض المثال الموثّق بدل ما يكلم الـ API.
متخزن في ذاكرة التبويب ده بس: عمره ما بيتحفظ ولا بيتحط في الرابط، وبيتبعت لـ mursilat.com بس. لو عملت reload بيتنسي.