Gateway¶
Bu uç nokta, bir botun bağlandığı Gateway URL'sini önerilen shard sayısı ve oturum başlatma değerleriyle birlikte döndürür. WebSocket protokolünün kendisi Gateway'e genel bakış sayfasında anlatılır.
Kimlik bilgisi olarak bir bot token'ı kullanılır. Kullanıcı istemcileri bu yolu çağırmaz: endpoints.gateway değerini örnek (instance) keşfinden okur ve oturum token'larını Identify içinde gönderir.
Gateway bilgi nesnesi¶
Her alan her zaman bulunur.
Yapı¶
| Alan | Tür | Açıklama |
|---|---|---|
| url | string | Gateway'in ws veya wss URL'si. Genel Gateway URL'si yapılandırılmış bir kurulumda örnek keşfindeki endpoints.gateway ile aynı değerdir |
| shards | integer | Önerilen shard sayısı, her zaman 1 |
| session_start_limit | oturum başlatma sınırı nesnesi | Sabit oturum başlatma değerleri |
TEBHOS sorgu dizesi eklemez. Bağlantı parametrelerini istemci kendisi ekler, örneğin ?v=1&encoding=json. İstemci, yayımlanan bir ws değerini wss olarak yeniden yazmamalıdır (MUST NOT).
Örnek¶
{
"url": "wss://tebhos.com/ws",
"shards": 1,
"session_start_limit": {
"total": 1000,
"remaining": 999,
"reset_after": 14400000,
"max_concurrency": 1
}
}
Oturum başlatma sınırı nesnesi¶
Bunlar canlı kullanım sayaçları değil, sabit uyumluluk değerleridir.
Yapı¶
| Alan | Tür | Açıklama |
|---|---|---|
| total | integer | Bildirilen izin verilen oturum başlatma sayısı, her zaman 1000 |
| remaining | integer | Bildirilen kalan oturum başlatma sayısı, her zaman 999 |
| reset_after | integer | Milisaniye cinsinden bildirilen sıfırlama aralığı, her zaman 14400000 (dört saat) |
| max_concurrency | integer | Bildirilen eşzamanlı Identify kovası sayısı, her zaman 1 |
Gateway'in gerçekte uyguladığı sınırlar Gateway sınırları ve hız sınırları sayfasında açıklanır. Burada bildirilmezler.
Kalan bir oturum başlatma hakkı kabulü garanti etmez
Bu değerler kapasite ayırmaz. Gateway kendi sınırları nedeniyle bir bağlantıyı yine de reddedebilir veya kapatabilir.
Gateway bilgisini al¶
GET /gateway/bot
Bir Gateway bilgi nesnesi döndürür.
Bu yol Authorization: Bot <token> gerektirir. TEBHOS token'ı eksiksiz doğrular (uygulama var olmalı, bir bot hesabı bulunmalı ve gizli anahtar eşleşmelidir); bu nedenle başarılı bir yanıt token'ın geçerli olduğunu da doğrular. Kullanıcı oturum token'ı, hatalı biçimli bir değer veya iptal edilmiş bir bot token'ı dahil başka her kimlik bilgisi 401 döndürür.
Yanıt¶
| Durum | Gövde | Koşul |
|---|---|---|
| 200 | Gateway bilgi nesnesi | Bot token'ı geçerli |
| 401 | hata yanıtı | Kimlik bilgisi eksik, bot token'ı değil veya doğrulanamıyor (UNAUTHORIZED, mesaj invalid_token) |
| 429 | hata yanıtı | Yol kovası veya genel sınır isteği reddetti |
Hız sınırı¶
gateway:bot_info kovasında her istemci için dakikada 60 istek. İstemci, Authorization başlığıyla tanımlanır.
Örnek¶
TEBHOS'ta desteklenmez
Kimlik doğrulamasız bir GET /gateway yolu yoktur. Bunun yerine endpoints.gateway değeri örnek keşfinden okunur.