زامن جهات الاتصال، وأجب عن الرسائل والتعليقات، واقرأ إحصاءات التدفقات الحالية. إنشاء التدفقات وتعديلها غير متاحين عبر هذا API.
المصادقة
أنشئ تكاملًا بالصفحات والصلاحيات المطلوبة في لوحة التحكم. أرسل المفتاح بصيغة Bearer في ترويسة Authorization. تنتهي صلاحيته بعد سنة ويمكن تغييره أو إلغاؤه من اللوحة.
أرسل message نصية حتى 1000 حرف. في حالة uncertain افحص البريد الوارد قبل إعادة الإرسال.
curl -X POST 'https://highfollower.com/api/v1/pages/12/conversations/CONVERSATION_KEY/replies' \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"message":"Hello! How can we help?"}'
حالة المحادثة ووسوم جهات الاتصال
لتغيير حالة المحادثة أرسل status بقيمة open أو done. لاستبدال وسوم جهة الاتصال أرسل مصفوفة tag_ids؛ المصفوفة الفارغة تزيل جميع الوسوم.
Webhook مخصص
اضبط العنوان والأحداث وأرسل حدثًا تجريبيًا. تتضمن الحمولة id وtype وapi_version وoccurred_at وplatform_page_id وplatform وdata. أحداث الرسائل والتعليقات تشمل الوارد والصادر. يشير حدث synced إلى ضرورة تحديث القائمة من API.
التحقق من مصدر webhook
تحقق من HMAC-SHA256(secret, timestamp + "." + raw_body) قبل تحليل JSON. تبدأ X-HighFollower-Signature بـsha256=. تحقق من X-HighFollower-Timestamp ضمن خمس دقائق واحفظ id لمنع معالجة الحدث مرتين.
مثال للتحقق من التوقيع — Python
import hashlib, hmac, json, time
def verify_webhook(raw_body, headers, secret):
timestamp = headers["X-HighFollower-Timestamp"]
if abs(time.time() - int(timestamp)) > 300:
raise ValueError("Expired webhook")
digest = hmac.new(
secret.encode(), timestamp.encode() + b"." + raw_body,
hashlib.sha256,
).hexdigest()
if not hmac.compare_digest(
"sha256=" + digest, headers["X-HighFollower-Signature"]
):
raise ValueError("Invalid signature")
return json.loads(raw_body)
# Deduplicate the verified payload["id"] in your database.
# Return 2xx after durably accepting the event.
إعادة المحاولة وسجل التسليم
الاستجابة 2xx تؤكد الاستلام. تُعاد أخطاء الشبكة و408 و425 و429 و5xx حتى ثماني محاولات؛ تفشل الاستجابات الأخرى بما فيها إعادة التوجيه. فترات الانتظار 1 و5 و15 و60 و180 و360 و720 دقيقة إضافة إلى تأخير الطابور. يبقى معرّف الحدث ثابتًا. يُحفظ السجل 30 يومًا. تغيير العنوان أو مفتاح التوقيع يلغي عمليات التسليم القديمة المعلّقة.
الحدود والأخطاء
حدود الطلبات
يتوفر API والويب هوك في Growth مع 3 اتصالات نشطة وفي Pro مع 10. تشمل فترة Growth التجريبية هذه الميزات أيضاً. لكل تكامل 120 طلبًا في الدقيقة. الردود تتطلب صفحة نشطة باتصال صالح ورصيد. عند الخطأ 429، انتظر المدة المحددة في Retry-After.
أخطاء API
الأخطاء: 401 مفتاح غير صالح أو منتهي؛ 403 صلاحية غير كافية أو صفحة غير نشطة للإرسال؛ 404 مورد مفقود أو خارج النطاق؛ 409 تعارض معرّف الطلب؛ 422 مدخل غير صالح؛ 429 حد الطلبات. تستخدم حدود الخطة error=plan_limit_reached.