Public API v2¶

Disponible desde el plan Plus

Public API v2 está disponible para usuarios de los planes Plus y Pro.

Public API v2 proporciona acceso programático a las funciones principales de Hotline para integraciones con CRM, servicios internos, analítica y herramientas de automatización.

La documentación interactiva actualizada, el conjunto completo de métodos, los modelos de datos y los ejemplos de solicitudes están disponibles en la interfaz Scalar de Hotline API.

La interfaz Scalar permite:

consultar los métodos actuales y los modelos de solicitudes y respuestas
autorizarse mediante Instance-Id e Instance-Token
ejecutar solicitudes de prueba desde el navegador
ver ejemplos para Shell, Python y Node.js

Utiliza una conexión de prueba para verificar los métodos y no ejecutes operaciones de modificación o masivas en una conexión de producción sin comprobar primero los parámetros.

Abrir Hotline API v2

Funciones principales¶

Los métodos de la API se agrupan por los principales objetos y escenarios de Hotline:

Instance — obtener información de la conexión y de los perfiles de Telegram asociados; iniciar, detener y reiniciar una conexión
Dialog — buscar y obtener diálogos, crear nuevos diálogos y cambiar su estado
Message — enviar mensajes a diálogos y al grupo backend, y obtener información de mensajes
Say — crear, consultar, renombrar y eliminar respuestas rápidas, y enviarlas a diálogos
Mark — gestionar marcas, sus parámetros y sus asignaciones a diálogos
Sending — gestionar plantillas, envíos, destinatarios, estados e informes
Export — iniciar exportaciones de datos, comprobar su estado y descargar informes terminados

El conjunto de métodos evoluciona continuamente. Al diseñar una integración, consulta siempre la documentación actual de la API.

Dirección y autorización¶

Dirección base de Public API v2:

https://api.production.hotline.tg/api/v2/

Todas las solicitudes utilizan HTTP Basic:

Campo HTTP Basic	Datos de la conexión Hotline
`Username`	`Instance-Id`
`Password`	`Instance-Token`

Abre la conexión necesaria en el bot de configuración @hotlinetg_bot. En sus datos:

Instance ID se utiliza como Instance-Id
API key se utiliza como Instance-Token

Ejemplo de solicitud de información de la conexión:

curl --user "$INSTANCE_ID:$INSTANCE_TOKEN" \
  https://api.production.hotline.tg/api/v2/instance

Mantén Instance-Token en secreto

No publiques Instance-Token en código, registros ni repositorios públicos. Guárdalo en variables de entorno o en un almacén de secretos.

Después de restablecer API key en el bot de configuración, el token anterior deja de funcionar. Actualiza las credenciales en todas las integraciones de esa conexión.