ابدء

توفر واجهة برمجة تطبيقات WhatsApp Web طريقة بسيطة وقوية لدمج WhatsApp في تطبيقاتك.

للبدء، ستحتاج إلى بيانات اعتماد::
  • رمز الوصول: مفتاح آمن يستخدم لمصادقة طلبات API.
  • معرف مثيل واتس اب: معرف فريد مرتبط بجلسة حساب WhatsApp الخاص بك.

ليس لديك أوراق اعتماد حتى الآن؟ اشترك هنا للحصول على رمز الوصول ومعرف المثيل.

المسارات الأساسية:
https://wonotify.com/api/...
https://wonotify.com/whatsapp_api/...
يتم دعم كلا المسارين الأساسيين ويعيدان نفس الاستجابة.

المثيلات

إنشاء مثيل
POST

قم بإنشاء معرف مثيل جديد للاتصال بـ WhatsApp Web.

نقطة نهاية API:
https://wonotify.com/api/create_instance?access_token=6881c11f741a1
حدود:
ParameterTypeRequiredDescription
access_tokenstringYesYour API access token
مثال:
curl -X POST 'https://wonotify.com/api/create_instance?access_token=6881c11f741a1'
مثيل إعادة التشغيل
POST

قم بتسجيل الخروج من WhatsApp web وقم بإجراء فحص جديد.

نقطة نهاية API:
https://wonotify.com/api/reboot?instance_id=609ACF283XXXX&access_token=6881c11f741a1
حدود:
ParameterTypeRequiredDescription
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token
إعادة تعيين المثيل
POST

سيؤدي هذا إلى تسجيل الخروج من WhatsApp web وتغيير معرف المثيل وحذف جميع بيانات المثيل القديم.

نقطة نهاية API:
https://wonotify.com/api/reset_instance?instance_id=609ACF283XXXX&access_token=6881c11f741a1
إعادة الاتصال
POST

أعد بدء الاتصال من التطبيق إلى WhatsApp web عند فقدان الاتصال.

نقطة نهاية API:
https://wonotify.com/api/reconnect?instance_id=609ACF283XXXX&access_token=6881c11f741a1
مثيل تسجيل الخروج
POST

تسجيل الخروج من مثيل WhatsApp Web.

نقطة نهاية API:
https://wonotify.com/api/logout?instance_id=609ACF283XXXX&access_token=EMCUH3NQQK8YXXXX

تسجيل دخول واتساب

احصل على رمز الاستجابة السريعة
POST

عرض رمز الاستجابة السريعة لتسجيل الدخول إلى WhatsApp web. يمكنك الحصول على النتائج التي تم إرجاعها عبر Webhook.

نقطة نهاية API:
https://wonotify.com/api/get_qrcode?instance_id=609ACF283XXXX&access_token=6881c11f741a1
حدود:
ParameterTypeRequiredDescription
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token

المراسلة

إرسال رسالة نصية
POST

إرسال رسالة نصية إلى رقم الهاتف من خلال التطبيق.

الطريقة الأولى: الحصول على الطلب:
https://wonotify.com/api/send?number=84933313xxx&type=text&message=test+message&instance_id=609ACF283XXXX&access_token=6881c11f741a1
الطريقة الثانية: طلب النشر:
https://wonotify.com/api/send
ما بعد هيكل الجسم:
Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "text",
  "message": "test message",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}
حدود:
ParameterTypeRequiredDescription
numberstringYesPhone number (without +)
typestringYesMessage type: "text"
messagestringYesText message content
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token
إرسال الوسائط والملفات
POST

أرسل وسائط أو ملفًا برسالة إلى رقم هاتف من خلال التطبيق.

الطريقة الأولى: الحصول على الطلب:
https://wonotify.com/api/send?number=84933313xxx&type=media&message=test+message&media_url=https%3A%2F%2Fi.pravatar.cc&filename=file_test.jpg&instance_id=609ACF283XXXX&access_token=6881c11f741a1
الطريقة الثانية: طلب النشر:
https://wonotify.com/api/send
ما بعد هيكل الجسم:
Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "media",
  "message": "test message",
  "media_url": "https://i.pravatar.cc",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}
حدود:
ParameterTypeRequiredDescription
numberstringYesPhone number (without +)
typestringYesMessage type: "media"
messagestringYesCaption for the media
media_urlstringYesURL of the media file
filenamestringNoFilename (for documents: file_test.pdf)
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token
إرسال زر/قائمة القالب
POST

أرسل رسالة نموذجية إلى رقم هاتف من خلال التطبيق.

نقطة نهاية API:
https://wonotify.com/api/send_template?instance_id=609ACF283XXXX&access_token=6881c11f741a1
بنية الرسالة التفاعلية (مستحسن):
Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "interactive",
  "message": {
    "text": "This is an Interactive message!",
    "title": "Test Title",
    "subtitle": "subtitle",
    "footer": "test footer",
    "interactiveButtons": [
      {
        "name": "quick_reply",
        "buttonParamsJson": "{\"display_text\":\"Test\",\"id\":\"685250bce39ca\"}"
      },
      {
        "name": "cta_url",
        "buttonParamsJson": "{\"display_text\":\"Click me!\",\"url\":\"https://baceoin.com\"}"
      },
      {
        "name": "cta_call",
        "buttonParamsJson": "{\"display_text\":\"Call Us\",\"phone_number\":\"+1234567890\"}"
      },
      {
        "name": "cta_copy",
        "buttonParamsJson": "{\"display_text\":\"Copy Code\",\"copy_code\":\"PROMO2024\"}"
      }
    ]
  }
}
تنسيق القالب القديم (مهجور):
Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "template",
  "message": {
    "text": "This is a template message!",
    "footer": "test footer",
    "templateButtons": [
      {
        "index": 1,
        "quickReplyButton": {
          "displayText": "Test",
          "id": "685250bce39ca"
        }
      }
    ]
  }
}
قائمة هيكل الرسالة:
Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "list",
  "message": {
    "text": "hello",
    "footer": "test footer",
    "title": "test title",
    "buttonText": "bay",
    "sections": [
      {
        "title": "hello",
        "rows": [
          {
            "title": "hello",
            "rowId": "685410595972e",
            "description": "hello"
          }
        ]
      }
    ]
  }
}

المجموعات

إرسال نص المجموعة
POST

إرسال رسالة نصية إلى مجموعة WhatsApp.

الطريقة الأولى: الحصول على الطلب:
https://wonotify.com/api/send_group?group_id=120363023285171234@g.us&type=text&message=group+message&instance_id=609ACF283XXXX&access_token=6881c11f741a1
الطريقة الثانية: طلب النشر:
https://wonotify.com/api/send_group
ما بعد هيكل الجسم:
Content-Type: application/json
{
  "group_id": "120363023285171234@g.us",
  "type": "text",
  "message": "group message",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}
حدود:
ParameterTypeRequiredDescription
group_idstringYesWhatsApp group ID (ends with @g.us)
typestringYesMessage type: "text"
messagestringYesText message content
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token
إرسال وسائط المجموعة
POST

أرسل الوسائط أو الملفات مع تسمية توضيحية إلى مجموعة WhatsApp.

الطريقة الأولى: الحصول على الطلب:
https://wonotify.com/api/send_group?group_id=120363023285171234@g.us&type=media&message=group+message&media_url=https%3A%2F%2Fi.pravatar.cc&filename=file_test.jpg&instance_id=609ACF283XXXX&access_token=6881c11f741a1
الطريقة الثانية: طلب النشر:
https://wonotify.com/api/send_group
ما بعد هيكل الجسم:
Content-Type: application/json
{
  "group_id": "120363023285171234@g.us",
  "type": "media",
  "message": "group message",
  "media_url": "https://i.pravatar.cc",
  "filename": "file_test.jpg",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}
حدود:
ParameterTypeRequiredDescription
group_idstringYesWhatsApp group ID (ends with @g.us)
typestringYesMessage type: "media"
messagestringYesCaption for the media
media_urlstringYesURL of the media file
filenamestringNoFilename (for documents: file_test.pdf)
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token

خطافات الويب

تعيين تلقي Webhook
POST

احصل على جميع قيم الإرجاع من WhatsApp. مثل حالة الاتصال، الرسالة الواردة، الرسالة الصادرة، غير متصل، تغيير البطارية، ...

نقطة نهاية API:
https://wonotify.com/api/set_webhook?webhook_url=https%3A%2F%2Fwebhook.site%2F1b25464d6833784f96eef4xxxxxxxxxx&enable=true&instance_id=609ACF283XXXX&access_token=6881c11f741a1
حدود:
ParameterTypeRequiredDescription
webhook_urlstringYesYour webhook URL (URL encoded)
enablebooleanYesEnable/disable webhook (true/false)
instance_idstringYesWhatsApp instance ID
access_tokenstringYesYour API access token
أحداث الويب هوك:
  • message: رسالة واردة جديدة
  • message_status: حالة تسليم الرسالة
  • presence: حالة المستخدم متصل/غير متصل