واجهة برمجة التطبيقات (API) للروبوت مبنية على REST. يمكنك استدعاء واجهات البرمجة الخاصة بنا من خلال طلب HTTP قياسي مع مفتاح API الخاص بك الذي يتم وضعه في معلمة الاستعلام. بعد ذلك، ستُرجع WOZTELL استجابة مشفرة بصيغة JSON، تحتوي على البيانات المقابلة التي يمكن أن تحدد ما إذا كانت العمليات المتعلقة قد اكتملت.

قبل البدء، يمكنك أولاً تنزيل مجموعة Postman لـ واجهة برمجة التطبيقات للروبوت و البيئة بتنسيق JSON.

إذا كان متصفحك لا يمكنه تنزيل ملفات JSON بعد النقر على الرابط...

يرجى النقر بزر الماوس الأيمن و"فحص" لفتح أدوات المطور. اختر "المصدر" ثم انقر بزر الماوس الأيمن لتنزيل الملف المصدر باستخدام "حفظ باسم..."

إرسال الردود

لإرسال ردود بالنيابة عن روبوت الدردشة الخاص بك إلى عضو محدد في WOZTELL.

إنشاء قالب في JSON

WOZTELL يسمح لك بإنشاء وإدارة قالب الرسائل على المنصة. عند إرسال الردود باستخدام Bot API ، هناك طريقة ملائمة للحصول على محتوى القالب بصيغة JSON.

1. ضمن "الموارد"، اختر "الردود".

2. اختر "+ رد جديد".

3. افتح التبويب. اختر "إضافة منصة" ثم اختر "WhatsApp Cloud". سيتيح لك ذلك تطبيق أنواع الرسائل الخاصة بـ WhatsApp Cloud.

4. اختر "قالب الرسالة" من أنواع الرسائل.

5. اختر "التكامل" ذات الصلة ثم اضغط على "تحديث قالب الرسالة".

6. اختر "قالب الرسالة" الذي ترغب في استخدامه. ثم اختر "سياسة اللغة" و"اللغة" ذات الصلة.

7. املأ المكونات المطلوبة في القالب، مثل الصور والمعلمات. اضغط على "تأكيد" للخروج من هذه النافذة.

8. في الاستجابة، قم بالتبديل إلى "متقدم" للحصول على محتوى القالب بصيغة JSON.

طلب

التفويضات: accessToken(bot:sendResponses, bot:admin)

معلمات الاستعلام:

نموذج جسم الطلب: application/json

طلب عينة:

• POST https://bot.api.woztell.com/sendResponses
• نوع المحتوى: application/json

{
  "channelId": "5fe729b3094223123123",
  "recipientId": "85291239123",
  "response": [
    {
      "type": "TEMPLATE",
      "elementName": "testing",
      "languageCode": "zh_CN",
      "components": [
        {
          "type": "header",
          "parameters": [
            {
              "type": "video",
              "video": {
                "id": "caf8bc1a-fbc0-4dc3-9d08-434sdf6df"
              }
            }
          ]
        },
        {
          "type": "button",
          "sub_type": "quick_reply",
          "index": "0",
          "parameters": [
            {
              "type": "payload",
              "payload": "123"
            }
          ]
        }
      ]
    }
  ]
}

الاستجابة

هيكل استجابة الجسم: application/json

استجابة مخطط الهيكل: application/json

نموذج استجابة:

• رمز الحالة: ٢٠٠
• نوع المحتوى: application/json


{
  "ok": 1,
  "member": "5ece50f3bf385b25c4e08db5",
  "sendResult": {
    "ok": 1,
    "member": "5ece50f3bf385b25c4e08db5",
    "result": [
      {
        "result": {

          "type": "IMAGE",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZphigfAglySd38a9T4jAE"
        },
        "chatId": "5ece50f3bfa915g5c4e08db5"
      },
      {
        "result": {

 "IMAGE",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZafi5th8lySd38a9T4jAE"
        },
        "chatId": "5ece50f3bfa915g5c4e08db6"
      }
    ]
  }
}

• Status Code: 500
• Content type: application/json

{
  "ok": 0,
  "err": "User is not authorized."
}

إعادة توجيه العضو إلى عقدة

إذا لم يُقدَّم مُعرِّف العضو، فسيبحث النظام عن عضو يحمل مُعرِّف المستلم المُقدَّم.

كائن ميتا

this.agendaMeta

Example:

return new Promise((resolve, reject) => {
  // ...
  const name = this.agendaMeta.name // "Sanuker"
  const orderId = this.agendaMeta.orderId // "5ecf6be76fcfda6b139d802c"
  // ...
})

الطلب

POST https://bot.api.woztell.com/redirectMemberToNode

التفويضات: accessToken(bot:redirectMemberToNode, bot:admin, api:admin)

معاملات الاستعلام:

مخطط جسم الطلب: application/json

طلب عينة

نوع المحتوى: application/json

{
  "channelId": "5ece50e72efaabd58ef55027",
  "memberId": "5ece50f3bf385b25c4e08db5",
  "recipientId": null,
  "redirect": {
    "tree": "5ecf6cfba3b6643c33a64079",
    "nodeCompositeId": "j4Bivxm0GWhnNV1m",
    "runPreAction": true,
    "sendResponse": true,
    "runPostAction": true
  },
  "meta": {
    "name": "Sanuker",
    "orderId": "5ecf6be76fcfda6b139d802c"
  }
}

الاستجابة

مخطط جسم الاستجابة: application/json

نموذج إجابة

{
  "ok": 1,
  "member": "5ece50f3bf385b25c4e08db5",
  "sendResult": {
    "ok": 1,
    "member": "5ece50f3bf385b25c4e08db5",
    "result": [
      {
        "ok": 1,
        "messageEvent": {
          "from": 85291239123,
          "to": 85232193219,
          "data": {
            "url": "https://miro.medium.com/max/1200/1*mk1-6aYaf_Bes1E3Imhc0A.jpeg"
          },
          "type": "IMAGE",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZafi5th8lySd38a9T4jAE"
        }
      }
    ]
  }
}

استجابة عينة

• رمز الحالة: 500
• المحتوى: application/json

{
  "ok": 0,
  "err_code": 108,
  "err": "معرف القناة مطلوب."
}

رموز الأخطاء

سيقوم WOZTELL بإرجاع رموز الأخطاء المقابلة إلى الجهة الطالبة عندما يحدث خطأ.