hotline.tg

Hotline Topics API (V1)

Topics API auf Integration ausgelegt Hotline Telegram CRM mit externen Systemen. Dieses Dokument beschreibt die Hauptmethoden der Schnittstelle.

Mit der Hauptmethode können Sie Informationen über die Quelle des Themas auf Seiten der Backend-Gruppe erhalten. Es gibt auch eine Methode zum Senden einer eingehenden Nachricht an ein Thema per user_id benutzer.

Beispiele für die Erweiterung der Funktionalität des Systems Hotline mit Topics API über Ihren Assistenten-Bot werden in einem separaten Artikel beschrieben.

Hinweis: Diese Seite enthält Fragmente mit automatischer Übersetzung. Wenn Sie Schwierigkeiten haben, diese Informationen zu verstehen, versuchen Sie, die Sprache auf Englisch oder Russisch umzustellen und das Übersetzungssystem Ihrer vertrauenswürdigen Website zu verwenden.

Schnittstellenadresse

https://n8n.production.hotline.tg/webhook/topic_action

Nur Prozesse POST Anfragen
Um auf die Schnittstelle zuzugreifen, ist derzeit ein Header erforderlich x-api-key, was den ausgegebenen Token angibt Unterstützungsdienst
Jede Instanz hat auch ihre eigene api_key, was sich auch herausstellt @hotlinetg_bot für jede Instanz, und die direkt im Hauptteil der JSON-Anfragen angegeben wird

Methode 1: Verfügbare Informationen zum Thema

Anfragebeispiel:

{
    "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"
}

Beispielantwort für einen Benutzer:

{
    "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"
}

Beispielantwort für Gruppen:

{
    "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"
}

Features:

Topic_status hat 3 Werte: „closed“, „user_answered“, „support_answered“ (im Thementitel als schwarzes, violettes bzw. gelbes Quadrat angezeigt)
Arten von frontend_type: privat (normaler Benutzer), Bot, Geheimnis, Gruppe, Supergruppe, Thema, Kanal
Vollständige Informationen werden vorerst nur zu den folgenden Themen bereitgestellt: Privat, Bot, Geheimnis
Wenn einer Backend-Gruppe mehrere Instanzen zugeordnet sind, können Sie jede davon verwenden, um Informationen zu den Themen in der Gruppe zu erhalten (die Instanz eines bestimmten Themas wird in den entsprechenden Antwortfeldern angezeigt).

Methode 2: Eingehende Nachricht zum Thema von user_id

Anfragebeispiel:

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

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

Antwortbeispiel:

{
    "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"
}

Zugriff erhalten auf Topics API

Um x-api-key tocena Um auf die API zuzugreifen oder die Kosten für Integration und Support zu berechnen, müssen Sie an den Support schreiben @hotlinetg_support.