Hotline Topics API (V1)

Topics API مصممة للتكامل Hotline Telegram CRM مع الأنظمة الخارجية. يصف هذا المستند الطرق الرئيسية للواجهة.
تتيح لك الطريقة الرئيسية الحصول على معلومات حول مصدر الموضوع على جانب المجموعة الخلفية. هناك أيضًا طريقة لإرسال رسالة واردة إلى موضوع ما user_id المستخدم.
أمثلة على توسيع وظائف النظام Hotline مع Topics API من خلال الروبوت المساعد الخاص بك موصوفة في مقالة منفصلة.
عنوان الواجهة
https://n8n.hotline.tg/webhook/topic_action
  • العمليات فقط POST طلبات
  • في الوقت الحالي، للوصول إلى الواجهة، من الضروري أن يكون لديك رأس x-api-key، الذي يشير إلى الرمز المميز الذي تم إصداره خدمة الدعم
  • كل مثيل له أيضا خاصته api_key، والذي تبين أنه @hotlinetg_bot لكل مثيل، والذي تتم الإشارة إليه مباشرةً في نص طلبات JSON
الطريقة الأولى: المعلومات المتوفرة حول الموضوع
طلب مثال:

{
    "action": "info_by_topic",
    "group_id": "2101424779", # as it appers in topic public link (without -100)
    "topic_id": "$TOPIC_ID",  # as it appers in topic public link

    "instance": "$INSTANCE",
    "api_key": "$KEY"
}

مثال للإجابة للمستخدم:

{
    "result": "topic_info",
    "group_id": $GROUP_ID,
    "topic_id": $TOPIC_ID,

    "frontend_type": "private",
    "instance_name": "$INSTANCE_NAME",
    "instance_frontend_user_id": $INSTANCE_FRONTEND_USER_ID,
    "instance_id": $INSTANCE_ID,

    "chat_id": $CHAT_ID,
    "thread_id": $THREAD_ID,

    "topic_last_date": "$LAST_DATE",
    "topic_status": "$STATUS",
    "topic_title": "$TITLE",

    "user_id": $USER_ID,
    "user_name": "$NAME",
    "user_first_name": "$FNAME",
    "user_last_name": "$LNAME",
    "user_username": "$USERNAME",
    "user_lang": "None",
    "user_phone": "None"
}
مثال على الاستجابة للمجموعات:

{
    "result":"topic_info",

    "group_id": $GROUP_ID,
    "topic_id": $TOPIC_ID,

    "frontend_type": "group",
    "instance_name": "$INSTANCE_NAME",
    "instance_frontend_user_id": $INSTANCE_FRONTEND_USER_ID,
    "instance_id": $INSTANCE_ID,

    "frontend_chat_id": $CHAT_ID,

    "topic_last_date": "$LAST_DATE",
    "topic_status": "$STATUS",
    "topic_title": "$TITLE"
}

الميزات:
  1. يحتوي Topic_status على 3 قيم: "مغلق"، و"user_answered"، و"support_answered" (يظهر في عنوان الموضوع كمربع أسود وأرجواني وأصفر، على التوالي)
  2. أنواع الواجهة الأمامية: خاص (مستخدم عادي)، روبوت، سري، مجموعة، مجموعة فائقة، موضوع، قناة
  3. في الوقت الحالي، يتم توفير المعلومات الكاملة فقط للمواضيع التالية: خاص، بوت، سري
  4. إذا تم إرفاق عدة مثيلات بمجموعة خلفية واحدة، فيمكنك استخدام أي منها للحصول على معلومات حول الموضوعات الموجودة في المجموعة (سيتم عرض مثيل موضوع معين في حقول الاستجابة المقابلة)
الطريقة الثانية: إرسال رسالة واردة إلى الموضوع بواسطة user_id
طلب مثال:

{
    "action": "incoming_in_topic",
    "user_id": $USER_ID1,
    "message": "/ `test` *incoming* _message_ \n\n [@hotlinetg_support]",

    "instance": "$INSTANCE",
    "api_key": "$KEY"
}
مثال الإجابة:

{
    "result": "message_sent",
    "topic_link": "https://t.me/c/2101424779/1591",
    "message": "/ `test` *incoming* _message_ \n\n [@hotlinetg_support]",
    "chat_id": $CHAT_ID,
    "thread_id": "$THREAD_ID"
}
الوصول إلى Topics API
للحصول على x-api-key الرمز للوصول إلى واجهة برمجة التطبيقات (API)، أو لحساب تكلفة التكامل والدعم، يتعين عليك الكتابة إلى الدعم @hotlinetg_support.