Public API v2¶

Plus tarifesinden itibaren kullanılabilir

Public API v2, Plus ve Pro tarifelerindeki kullanıcılar tarafından kullanılabilir.

Public API v2; CRM sistemleri, dahili servisler, analiz ve otomasyon araçlarıyla entegrasyon için Hotline'ın temel özelliklerine programatik erişim sağlar.

Güncel etkileşimli dokümantasyon, yöntemlerin tamamı, veri modelleri ve istek örnekleri Hotline API Scalar arayüzünde bulunur.

Scalar arayüzü şunları sağlar:

güncel yöntemleri ve istek ve yanıt modellerini görüntüleme
Instance-Id ve Instance-Token ile yetkilendirme
tarayıcıdan test istekleri çalıştırma
Shell, Python ve Node.js için istek örneklerini görüntüleme

Yöntemleri doğrulamak için bir test bağlantısı kullanın ve parametreleri önceden kontrol etmeden üretim bağlantısında değişiklik yapan veya toplu işlemler çalıştırmayın.

Hotline API v2'yi aç

Temel özellikler¶

API yöntemleri Hotline'ın temel nesnelerine ve senaryolarına göre gruplandırılmıştır:

Instance — bağlantı ve ilişkili Telegram profilleri hakkında bilgi alma; bağlantıyı başlatma, durdurma ve yeniden başlatma
Dialog — diyalogları arama ve alma, yeni diyaloglar oluşturma ve durumlarını değiştirme
Message — diyaloglara ve arka uç grubuna mesaj gönderme ve mesaj bilgilerini alma
Say — hızlı yanıtlar oluşturma, görüntüleme, yeniden adlandırma ve silme, hızlı yanıtları diyaloglara gönderme
Mark — etiketleri, parametrelerini ve diyalog atamalarını yönetme
Sending — şablonları, gönderimleri, alıcıları, gönderim durumlarını ve raporları yönetme
Export — veri dışa aktarımlarını başlatma, durumlarını kontrol etme ve tamamlanan raporları indirme

Yöntem kümesi sürekli gelişmektedir. Bir entegrasyon tasarlarken her zaman güncel API dokümantasyonuna başvurun.

Adres ve yetkilendirme¶

Public API v2 temel adresi:

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

Tüm API istekleri HTTP Basic kullanır:

HTTP Basic alanı	Hotline bağlantı verileri
`Username`	`Instance-Id`
`Password`	`Instance-Token`

Kurulum botu @hotlinetg_bot içinde gerekli bağlantıyı açın. Bağlantı ayrıntılarında:

Instance ID, Instance-Id olarak kullanılır
API key, Instance-Token olarak kullanılır

Bağlantı bilgileri için örnek istek:

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

Instance-Token değerini gizli tutun

Instance-Token değerini kodda, loglarda veya açık repository'lerde yayınlamayın. Ortam değişkenlerinde veya bir secret store içinde saklayın.

Kurulum botunda API key sıfırlandıktan sonra önceki token çalışmaz. Bu bağlantının tüm entegrasyonlarındaki credentials değerlerini güncelleyin.