hotline.tg

Hotline Topics API (V1)

Topics API progettato per l'integrazione Hotline Telegram CRM con sistemi esterni. Questo documento descrive i principali metodi dell'interfaccia.

Il metodo main ti consente di ottenere informazioni sulla fonte dell'argomento sul lato del gruppo backend. Esiste anche un metodo per inviare un messaggio in arrivo a un argomento tramite user_id utente.

Esempi di espansione delle funzionalità del sistema Hotline con Topics API tramite il tuo assistente bot sono descritti in un articolo separato.

Nota: Questa pagina contiene frammenti con traduzione automatica. Se hai difficoltà a comprendere queste informazioni, prova a cambiare la lingua in inglese o russo e utilizza il tuo sistema di traduzione di siti web di fiducia.

Indirizzo dell'interfaccia

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

Solo processi POST richieste
Al momento per accedere all'interfaccia è necessario avere un Header x-api-key, che indica il token emesso servizio di assistenza
Ogni istanza ha anche la sua api_key, che risulta essere @hotlinetg_bot per ogni istanza, e che viene indicato direttamente nel corpo delle richieste JSON

Metodo 1: informazioni disponibili sull'argomento

Richiesta di esempio:

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

Risposta di esempio per un utente:

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

Risposta di esempio per i gruppi:

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

Caratteristiche:

Topic_status ha 3 valori: 'chiuso','user_answered','support_answered' (mostrati nel titolo dell'argomento rispettivamente come un quadrato nero, viola e giallo)
Tipi di frontend_type: privato (utente normale), bot, segreto, gruppo, supergruppo, argomento, canale
Per ora viene fornita l'informativa completa solo per i seguenti argomenti: private, bot, secret
Se più istanze sono collegate a un gruppo backend, è possibile utilizzarne una qualsiasi per ottenere informazioni sugli argomenti nel gruppo (l'istanza di un argomento specifico verrà visualizzata nei campi di risposta corrispondenti)

Metodo 2: messaggio in arrivo all'argomento tramite user_id

Richiesta di esempio:

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

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

Esempio di risposta:

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

Ottenere l'accesso a Topics API

Per ottenere x-api-key gettone per accedere alle API, o calcolare il costo di integrazione e supporto, è necessario scrivere al supporto @hotlinetg_support.