Public API v2¶

Public API v2 fournit un accès programmatique aux principales fonctions de Hotline pour l'intégration avec les CRM, les services internes, les outils d'analyse et d'automatisation.

La documentation interactive à jour, l'ensemble complet des méthodes, les modèles de données et les exemples de requêtes sont disponibles dans l'interface Scalar de Hotline API.

L'interface Scalar permet de :

• consulter les méthodes actuelles et les modèles de requêtes et de réponses
• s'autoriser avec Instance-Id et Instance-Token
• exécuter des requêtes de test depuis le navigateur
• afficher des exemples pour Shell, Python et Node.js

Utilisez une connexion de test pour vérifier les méthodes et n'exécutez pas d'opérations de modification ou en masse sur une connexion de production sans vérifier d'abord les paramètres.

Ouvrir Hotline API v2

Fonctionnalités principales¶

Les méthodes de l'API sont regroupées selon les principaux objets et scénarios de Hotline :

• Instance — obtenir les informations de la connexion et des profils Telegram associés ; démarrer, arrêter et redémarrer une connexion
• Dialog — rechercher et obtenir des dialogues, créer de nouveaux dialogues et modifier leur statut
• Message — envoyer des messages aux dialogues et au groupe backend, et obtenir les informations des messages
• Say — créer, consulter, renommer et supprimer des réponses rapides, puis les envoyer dans les dialogues
• Mark — gérer les marques, leurs paramètres et leurs affectations aux dialogues
• Sending — gérer les modèles, les envois, les destinataires, les états et les rapports
• Export — lancer des exports de données, vérifier leur état et télécharger les rapports terminés

L'ensemble des méthodes évolue en permanence. Lors de la conception d'une intégration, consultez toujours la documentation actuelle de l'API.

Adresse et autorisation¶

Adresse de base de Public API v2 :

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

Toutes les requêtes utilisent HTTP Basic :

Ouvrez la connexion souhaitée dans le bot de configuration @hotlinetg_bot. Dans ses informations :

• Instance ID est utilisé comme Instance-Id
• API key est utilisé comme Instance-Token

Exemple de requête d'informations sur la connexion :

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