عنوان URL الأساسي
/api/v1
.
المصادقة
يحتاج كل طلب إلى مفتاح API في رأسAuthorization
:
إنشاء مفتاح
تحتاج إلى دور المالك أو المسؤول لإدارة مفاتيح API.- انتقل إلى الإعدادات → مفاتيح API في تطبيق Flowella .
- انقر على إنشاء مفتاح وأعطه اسمًا يسهل تذكره.
- انسخ المفتاح مرة واحدة — فهو يظهر فقط عند إنشائه.
التحقق من المفتاح
اضغط على نقطة نهاية ping لتأكيد صحة المفتاح:200 OK
مع{ "ok": true, "organizationId": "…" }
أنك قد تمت مصادقتك.
الأخطاء
تظهر جميع الأخطاء في غلاف ثابت:| حالة HTTP | متى ستراها |
|---|---|
400 | |
| فشل التحقق من الصحة، أو نص غير صحيح، أو رفض من Meta | |
401 | |
| مفتاح API مفقود أو غير صالح | |
402 | |
| الدفع مطلوب — اشتراكك لا يغطي هذه العملية | |
403 | |
| ممنوع — على سبيل المثال، الإرسال إلى جهة اتصال قامت بإلغاء الاشتراك، أو Meta | |
| غير متصل | |
404 | |
| القناة أو المورد المطلوب غير موجود | |
429 | |
| معدل محدود — إبطاء |
error.code
ثابت وآمن للتشغيل برمجياً. أماerror.message
فهو قابل للقراءة البشرية وقد يتغير.
حدود المعدل
مفاتيح API محدودة السرعة لكل مؤسسة. إذا تجاوزت الحد، فستحصل على خطأ “429
” مع الرمز “RATE_LIMITED
” والرسالة “Too many requests
”. تراجع وحاول مرة أخرى مع تأخير أسي.
إذا كنت تقوم بإرسال كميات كبيرة، فافضل **POST /api/v1/templates/send
** مع المعلمة “throttlePerHour
” — حيث يفرض “Flowella
” التقييد من جانب الخادم، لذا لا تحتاج إلى تنظيم الطلبات بنفسك.
ترقيم الصفحات
تستخدم نقاط نهاية القائمة (/conversations
،/contacts
،/templates
) ترقيم الصفحات بالمؤشر:
- مرر
limit(1–100، الافتراضي 25) وcursorاختياري. - تحتوي الاستجابة على
items، وعندما يكون هناك المزيد من النتائج،nextCursor. - مرر
nextCursorمرة أخرى كمعلمةcursorلجلب الصفحة التالية. - عندما يكون
nextCursorمفقودًا، فهذا يعني أنك وصلت إلى النهاية.
التاريخ والوقت
جميع الطوابع الزمنية هي سلاسل ISO 8601 بتوقيت UTC (على سبيل المثال2025-01-15T14:30:00.000Z
). عندما تقبل واجهة برمجة التطبيقات (API) التواريخ، يتم تحويل كل من التواريخ فقط (2025-01-15
) و ISO 8601 الكاملة إلى صيغة محددة من جانب الخادم.
أرقام الهواتف
قم بتمرير أرقام الهواتف بتنسيق E.164 (+15551234567
) حيثما أمكن ذلك. سيقوم Flowella
بتوحيد الاختلافات الشائعة من جانب الخادم، ولكن تنسيق E.164 هو الأكثر أمانًا.
القنوات
تقبل العديد من نقاط النهاية معرف القناة (whatsappChannelId
). إذا كان لدى مؤسستك قناة واحدة وقمت بحذفها، فسيستخدم Flowella
قناتك الافتراضية. إذا كان لديك عدة قنوات، فقم بتمرير المعرف بشكل صريح لتجنب الإرسال من المرسل الخاطئ.
للاطلاع على نمط URL الكامل وتبديل القنوات، انظر القنوات المتعددة.

