تصدير الاستبيانات عبر API

أنشئ روابط استبيان مخصصة لقائمة مستلمين في طلب واحد. على عكس إرسال الاستبيانات عبر API، يُرجع التصدير روابط مُشفّرة فورًا في الاستجابة (بدون إرسال SMS أو بريد أو واتساب).

قبل البدء

1. الحصول على رمز الوصول الخارجي من الملف الشخصي.
2. انسخ معرف المُجمّع من شاشة تفاصيل مُجمّع API (Collect → API → Details).
3. تأكد أن مُجمّع API نشط وأن الاستبيان منشور.

1. نقطة API

استبدل {collector_uuid} بـ معرف المُجمّع من شاشة التفاصيل.

نقطة النهاية

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

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

Content-Type

Content-Type: application/json

المصادقة

X-External-Access-Token: {your_token}

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

JSON

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

TIP

first_name و last_name و variables (متغيرات السياق) اختيارية. يجب أن يكون email و phone صالحين لكل عنصر. لا يوجد حقل medium في التصدير.

4. الاستجابة (Response)

مثال على حمولة نجاح (عقد المنتج):

JSON

{
  "success": true,
  "message": "اكتمل التصدير.",
  "data": {
    "accepted_count": 1,
    "rejected_count": 1,
    "recipients": [
      {
        "email": "john1@example.com",
        "phone": "+966501234567",
        "first_name": "John",
        "last_name": "Doe",
        "survey_link": "https://cxm.akwad.sa/w/9mtmcor2?h=x_jW87z6qzw",
        "status": "accepted"
      },
      {
        "email": "jane2@example.com",
        "phone": "+966509876543",
        "first_name": null,
        "last_name": null,
        "survey_link": null,
        "status": "rejected",
        "error": "Recipient already has an active invite."
      }
    ]
  }
}

INFO

كل مستلم مقبول يحصل على رابط استبيان فريد مُشفّر في survey_link. استخدم هذه الروابط في أنظمتك؛ لا يرسل الـ API رسائل نيابةً عنك.

مرجع الحقول

• حقول طلب التصدير - جدول جسم الطلب
• استجابات التصدير - رموز HTTP وأمثلة JSON (بما فيها تعارض البريد/الهاتف)

---

← الحصول على رمز الوصول · حقول طلب التصدير →