Public API v2¶

Disponibile dal piano Plus

Public API v2 è disponibile per gli utenti dei piani Plus e Pro.

Public API v2 fornisce accesso programmatico alle principali funzioni di Hotline per l'integrazione con CRM, servizi interni, analisi e strumenti di automazione.

La documentazione interattiva aggiornata, l'elenco completo dei metodi, i modelli dati e gli esempi di richieste sono disponibili nell'interfaccia Scalar di Hotline API.

L'interfaccia Scalar consente di:

consultare i metodi attuali e i modelli di richiesta e risposta
autorizzarsi tramite Instance-Id e Instance-Token
eseguire richieste di test dal browser
visualizzare esempi per Shell, Python e Node.js

Utilizza una connessione di test per verificare i metodi e non eseguire operazioni di modifica o massive su una connessione di produzione senza prima controllare i parametri.

Apri Hotline API v2

Funzionalità principali¶

I metodi API sono raggruppati in base ai principali oggetti e scenari di Hotline:

Instance — ottenere informazioni sulla connessione e sui profili Telegram associati; avviare, arrestare e riavviare una connessione
Dialog — cercare e ottenere dialoghi, creare nuovi dialoghi e modificarne lo stato
Message — inviare messaggi ai dialoghi e al gruppo backend e ottenere informazioni sui messaggi
Say — creare, visualizzare, rinominare ed eliminare risposte rapide e inviarle ai dialoghi
Mark — gestire etichette, parametri e assegnazioni ai dialoghi
Sending — gestire modelli, invii, destinatari, stati e report
Export — avviare esportazioni di dati, verificarne lo stato e scaricare i report completati

L'insieme dei metodi è in continua evoluzione. Durante la progettazione di un'integrazione, consulta sempre la documentazione API aggiornata.

Indirizzo e autorizzazione¶

Indirizzo base di Public API v2:

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

Tutte le richieste utilizzano HTTP Basic:

Campo HTTP Basic	Dati della connessione Hotline
`Username`	`Instance-Id`
`Password`	`Instance-Token`

Apri la connessione desiderata nel bot di configurazione @hotlinetg_bot. Nei suoi dettagli:

Instance ID viene utilizzato come Instance-Id
API key viene utilizzato come Instance-Token

Esempio di richiesta delle informazioni sulla connessione:

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

Mantieni segreto Instance-Token

Non pubblicare Instance-Token nel codice, nei log o in repository pubblici. Conservalo in variabili d'ambiente o in un secret store.

Dopo il reset di API key nel bot di configurazione, il token precedente smette di funzionare. Aggiorna le credenziali in tutte le integrazioni della connessione.