إرسال الاستبيانات عبر API Collector

بعد إنشاء قناة API للاستبيان في التطبيق (إدارة الاستبيانات → التوزيع → API)، استخدم النقطة أدناه لإرسال قائمة مستلمين. يجب أن تكون القناة نشطة وأن تكون قوالب الرسائل والجدولة مضبوطة من واجهة التطبيق.

1. نقطة API

استبدل {collector_uuid} بـ معرف المُجمّع من شاشة التفاصيل (Collect → API → Details → معرف المُجمّع).

نقطة النهاية

POST https://api-cxm.akwad.sa/api/v1/collectors/api/{collector_uuid}

2. الترويسات (Headers)

Content-Type

Content-Type: application/json

المصادقة

X-External-Access-Token: {your_token}

3. جسم الطلب (Request body)

JSON

{
  "medium": "sms",
  "recipients": [
    {
      "email": "john1@example.com",
      "phone": "+966501234567",
      "first_name": "John",
      "last_name": "Doe",
      "variables": {
        "request_number": "REQ-88421"
      }
    },
    {
      "phone": "+966509876543"
    }
  ]
}

TIP

medium يجب أن يكون sms أو email أو whatsapp. كل مستلم يحتاج حقل الاتصال حسب القناة: email عندما يكون medium هو email؛ phone عندما يكون sms أو whatsapp. الحقل الآخر و first_name و last_name و variables (متغيرات السياق) اختيارية. القيمة الفارغة في الحقل الاختياري مقبولة؛ القيمة غير الصالحة ترفض ذلك المستلم.

مرجع الحقول

لجدول الحقول وحدود الطلب، راجع مرجع حقول جسم الطلب.

لرموز HTTP وأمثلة JSON للاستجابة، راجع استجابات الإرسال.

---

← الحصول على رمز الوصول · مرجع الحقول →