مرجع حقول جسم الطلب
هذا الجدول يصف حقول JSON لطلب إرسال مستلمين إلى مُجمّع API.
| الحقل | النوع | إلزامي | الوصف |
|---|---|---|---|
medium | نص (string) | نعم | قناة الإرسال لهذا الطلب: sms أو email أو whatsapp (مستقلة عن التبويب الافتراضي في البوابة) |
recipients | مصفوفة (array) | نعم | قائمة جهات الاتصال المراد دعوتها |
recipients[].email | نص (string) | شرطي | إلزامي عندما يكون medium هو email. اختياري لـ sms و whatsapp. حد أقصى 255 حرفًا. القيمة الفارغة مقبولة؛ القيمة غير الصالحة ترفض ذلك المستلم. |
recipients[].phone | نص (string) | شرطي | إلزامي عندما يكون medium هو sms أو whatsapp. اختياري لـ email. حد أقصى 32 حرفًا. sms يتطلب جوالًا سعوديًا (+966 ثم 9 أرقام). whatsapp والجوال الاختياري مع email يتطلبان صيغة دولية E.164 (مثل +966…). القيمة الفارغة مقبولة؛ القيمة غير الصالحة ترفض ذلك المستلم. |
recipients[].first_name | نص (string) | لا | الاسم الأول (اختياري، حد أقصى 100 حرف) |
recipients[].last_name | نص (string) | لا | اسم العائلة (اختياري، حد أقصى 100 حرف) |
recipients[].variables | كائن (object) | لا | متغيرات السياق الاختيارية (حتى 20 مفتاحًا). المفاتيح: a-z و 0-9 و _ وتبدأ بحرف (مثل request_number). القيم: نص حتى 255 حرفًا؛ القيم الأطول تُرفض (422). المفاتيح المحجوزة (email و phone و name و h و collect و return و embed_preview و lang و locale وغيرها) تُرفض. |
حدود الطلب
medium: إلزامي؛ قيمة واحدة منsmsأوemailأوwhatsappلكل طلب.- الحد الأقصى للمستلمين في طلب واحد: 5000 عنصر في
recipients. - الحقول الإلزامية لكل مستلم: حقل الاتصال حسب
medium—emailلقناةemail؛phoneلقناتيsmsوwhatsapp. الحقل الآخر اختياري. الأسماء اختيارية دائمًا.
متغيرات السياق
متغيرات السياق تصف الحالة وليس الشخص. هوية العميل تعتمد على الجوال أولًا ثم البريد. قيم الدعوة تُحفظ على الدعوة ثم تُنسخ إلى الرد عند الإرسال.
من يعرف Qualtrics يمكنه اعتبارها embedded data؛ اسم الميزة لدينا هو متغيرات السياق.
INFO
قناة API يجب أن تكون نشطة في التطبيق. محتوى الدعوة (SMS / بريد / واتساب) والجدولة يُعدّان من إعدادات المُجمّع في البوابة وليس من هذا الطلب.