Hotline Topics API (v1)

Topics API برای ادغام طراحی شده است Hotline Telegram CRM با سیستم های خارجی این سند روش های اصلی رابط را شرح می دهد.
روش اصلی به شما امکان می دهد اطلاعاتی در مورد منبع موضوع در سمت گروه باطن به دست آورید. همچنین روشی برای ارسال پیام دریافتی به موضوع توسط user_id کاربر.
نمونه هایی از گسترش عملکرد سیستم Hotline با Topics API از طریق ربات دستیار شما در یک مقاله جداگانه توضیح داده شده است.
هشدار: این صفحه حاوی قطعات با ترجمه خودکار است. اگر درک این اطلاعات برای شما دشوار است، سعی کنید زبان را به انگلیسی یا روسی تغییر دهید و از سیستم ترجمه وب سایت مورد اعتماد خود استفاده کنید.
آدرس رابط
https://n8n.production.hotline.tg/webhook/topic_action
  • فقط فرآیندها POST درخواست ها
  • در حال حاضر، برای دسترسی به اینترفیس، داشتن یک سربرگ ضروری است x-api-key، که نشان دهنده توکن صادر شده است خدمات پشتیبانی
  • هر نمونه نیز موارد خاص خود را دارد api_key، که معلوم می شود @hotlinetg_bot برای هر نمونه، و اینکه مستقیماً در بدنه مشخص شده است JSON درخواست‌ها
روش 1: اطلاعات موجود در مورد موضوع
درخواست نمونه:
{
    "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. انواع frontend_type: خصوصی (کاربر معمولی)، ربات، مخفی، گروه، سوپرگروه، موضوع، کانال
  3. در حال حاضر اطلاعات کامل فقط برای موضوعات زیر ارائه شده است: خصوصی، ربات، مخفی
  4. اگر چندین نمونه به یک گروه باطن پیوست شده باشد، می توانید از هر یک از آنها برای به دست آوردن اطلاعات درباره موضوعات موجود در گروه استفاده کنید (نمونه یک موضوع خاص در فیلدهای پاسخ مربوطه نشان داده می شود)
روش 2: پیام ورودی به موضوع توسط 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.