hotline.tg

Hotline Topics API (V1)

Topics API diseñado para la integración Hotline Telegram CRM con sistemas externos. Este documento describe los principales métodos de la interfaz.

El método principal le permite obtener información sobre la fuente del tema en el lado del grupo de backend. También existe un método para enviar un mensaje entrante a un tema mediante user_id usuario

Ejemplos de ampliación de la funcionalidad del sistema. Hotline utilizando Topics API a través de tu robot asistente se describen en un artículo separado.

Atencion: Esta página contiene fragmentos con traducción automática. Si le resulta difícil comprender esta información, intente cambiar el idioma a inglés o ruso y utilice su sistema de traducción de sitios web de confianza.

Dirección de interfaz

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

Solo procesos POST solicitudes
Por el momento, para acceder a la interfaz es necesario disponer de un Header x-api-key, que indica el token emitido servicio al cliente
Cada instancia también tiene su propia api_key, que resulta ser @hotlinetg_bot para cada instancia, y que se indica directamente en el cuerpo de las solicitudes JSON

Método 1: información disponible sobre el tema

Solicitud de ejemplo:

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

Ejemplo de respuesta para un usuario:

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

Ejemplo de respuesta para grupos:

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

Características:

Topic_status tiene 3 valores: 'cerrado', 'usuario_answered', 'support_answered' (que se muestran en el título del tema como un cuadrado negro, morado y amarillo, respectivamente)
Tipos de frontend_type: privado (usuario normal), bot, secreto, grupo, supergrupo, tema, canal
Por ahora, se proporciona información completa solo para los siguientes temas: privado, bot, secreto
Si se adjuntan varias instancias a un grupo de backend, puede usar cualquiera de ellas para obtener información sobre los temas del grupo (la instancia de un tema específico se mostrará en los campos de respuesta correspondientes).

Método 2: mensaje entrante al tema por user_id

Solicitud de ejemplo:

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

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

Ejemplo de respuesta:

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

Obteniendo acceso a Topics API

Para obtener x-api-key simbólico Para acceder a la API, o calcular el costo de integración y soporte, debes escribir a soporte. @hotlinetg_soporte.