Kanallar¶

Kanal, metin veya ses olarak bir sohbetin gerçekleştiği yerdir. Bir sunucu metin, ses, kategori ve bağlantı kanallarına sahiptir. Sunucu dışında bir kanal; doğrudan mesaj, grup doğrudan mesaj veya kişisel notlar kanalıdır.

Mesaj içeriği Mesajlar sayfasında; sunucu kapsamlı listeleme, oluşturma ve yeniden sıralama ise Sunucu kanalları sayfasında tanımlanır. Doğrudan mesajları açma, listeleme ve kapatma Özel kanallar, özel bir aramayı çaldırma ve sonlandırma ise Aramalar sayfasında tanımlanır.

Bu sayfadaki tüm yollar kimlik doğrulama gerektirir. Yalnızca kullanıcı olarak işaretlenen yollar geçerli bir Bot <token> kimlik bilgisini 403 ACCESS_DENIED ile (geçersiz olanı 401 UNAUTHORIZED ile) reddeder; diğer tüm yollar bot token'ını da kabul eder. Hata gövdeleri Hatalar sayfasındaki biçimi izler.

Kanal nesnesi¶

Aşağıdaki sunucu kanalı nesnesi, TEBHOS'un Gateway olaylarında (Channel Create, Channel Update), Ready yükünde ve Kanalı değiştir yanıtında kullandığı yapıdır.

Yapı¶

locked ve is_private TEBHOS eklemeleridir.

Örnek¶

{
  "id": "1501314428688998182",
  "type": 0,
  "guild_id": "1501314428688990000",
  "name": "general",
  "topic": "Anything goes",
  "position": 3,
  "parent_id": "1501314428688991111",
  "bitrate": 0,
  "user_limit": 0,
  "voice_connection_limit": null,
  "rtc_region": null,
  "rate_limit_per_user": 0,
  "last_message_id": "1501320000000000000",
  "last_pin_timestamp": null,
  "permission_overwrites": [],
  "nsfw": false,
  "locked": false,
  "is_private": false
}

Özel kanal nesnesi¶

Doğrudan mesaj, grup doğrudan mesaj veya kişisel notlar kanalı, Özel kanallar yolları tarafından ve bir grup doğrudan mesajda Kanalı değiştir tarafından döndürülür. Başlıca alanları id, type ("DM" veya "GROUP_DM"), channel_type (1 veya 3), name, owner_id?, icon?, recipients (her biri {id, name, image_url}), last_message_id?, last_pin_timestamp ve nicks? alanlarıdır. Tam belgesi Özel kanallar sayfasındadır.

Kanal türleri¶

İzin geçersiz kılma nesnesi¶

İzin geçersiz kılma, bir kanalda tek bir rol veya tek bir üye için etkin sunucu izinlerini değiştirir. Bir izin maskesi, JSON sayısının koruyabildiği aralığı aştığından allow ve deny onluk dizelerdir. Tek tek bayraklar İzinler sayfasında tanımlanır.

Yapı¶

Bir tanımlayıcı tek bir geçersiz kılmaya karşılık gelir; bu nedenle zaten geçersiz kılması olan bir tanımlayıcı için yeni bir geçersiz kılma kaydetmek eskisinin yerine geçer. Yazma sırasında tanımlı izin kümesinin dışındaki her bit atılır ve allow ile deny alanları ortak bir bit içeren geçersiz kılma 400 BAD_REQUEST ile reddedilir.

Örnek¶

{
  "id": "1501314428688990000",
  "type": 0,
  "allow": "3072",
  "deny": "0"
}

İzin geçersiz kılma türleri¶

Kanal yavaş mod durumu nesnesi¶

Yapı¶

Örnek¶

{
  "rate_limit_per_user": 10,
  "retry_after_ms": 0,
  "next_send_allowed_at": null,
  "can_bypass": false
}

RTC bölgesi nesnesi¶

RTC bölgesi, dağıtımın işlettiği tek bir ses yönlendirme hedefini adlandırır. Tanımlayıcısı, bir sunucu ses kanalının rtc_region içinde sakladığı değerdir.

Yapı¶

Örnek¶

{
  "id": "eu-central",
  "name": "Frankfurt",
  "emoji": ""
}

Kanalı al¶

GET /channels/{channel_id}

Çağıranın görebildiği bir sunucu kanalını döndürür. VIEW_CHANNEL gerektirir. Bot token'larını kabul eder.

Mevcut olmayan bir kanal, çağıranın üyesi olmadığı bir sunucu ve bir özel kanal 404 NOT_FOUND döndürür. VIEW_CHANNEL izni olmayan bir üye 403 FORBIDDEN alır. Doğrudan mesajları okumak için Özel kanallar yollarını kullanın.

Yol parametreleri¶

Yanıt gövdesi¶

Hız sınırı¶

channel:read kovasında her kullanıcı ve kanal için 10 saniyede 100 istek.

curl https://tebhos.com/api/v1/channels/1501314428688998182 \
  -H "Authorization: Bot $TEBHOS_BOT_TOKEN"

Kanal yavaş mod durumunu al¶

GET /channels/{channel_id}/slowmode

Bir sunucu kanalı için çağıranın kanal yavaş mod durumu nesnesini döndürür. VIEW_CHANNEL gerektirir. Bot token'larını kabul eder. Bir özel kanal 404 NOT_FOUND döndürür.

Hız sınırı¶

channel:read kovasında her kullanıcı ve kanal için 10 saniyede 100 istek.

RTC bölgelerini listele¶

GET /channels/{channel_id}/rtc-regions

Çağıranın seçebileceği RTC bölgesi nesnelerini ada göre artan sırada döndürür. Yalnızca kullanıcı. VIEW_CHANNEL gerektirir.

Yalnızca kanalın sunucusunda çağıranın kullanabildiği bölgeler döndürülür; bazı bölgeler operatör tarafından kısıtlanabilir (ör. Premium hesaplara veya belirli sunuculara). Dizi boş olabilir.

Hız sınırı¶

channel:read kovasında her kullanıcı ve kanal için 10 saniyede 100 istek.

Kanalı değiştir¶

PATCH /channels/{channel_id}

Bir sunucu kanalını veya grup doğrudan mesajı değiştirir. Yalnızca kullanıcı.

Davranışı kayıtlı kanal türü belirler: grup doğrudan mesaj grup doğrudan mesaj gövdesini izler, bire bir doğrudan mesaj 403 FORBIDDEN döndürür ve her sunucu kanalı sunucu kanalı gövdesini izler.

Hız sınırı¶

channel:update kovasında her kullanıcı ve kanal için 10 saniyede 20 istek.

Sunucu kanalı gövdesi¶

O kanalda VIEW_CHANNEL ve MANAGE_CHANNELS gerektirir. permission_overwrites göndermek ayrıca MANAGE_ROLES gerektirir. Bir ses kanalında rtc_region göndermek ayrıca UPDATE_RTC_REGION gerektirir.

Her alan isteğe bağlıdır; gönderilmeyen alan mevcut değerini korur.

position 400 BAD_REQUEST ile reddedilir; kanalları Sunucu kanalları üzerinden yeniden sıralayın. nsfw, nsfw_override, content_warning_level ve content_warning_text kabul edilir ve yok sayılır.

Sunucu sahibi olmayan ve ADMINISTRATOR iznine sahip olmayan bir çağıran, o kanalda kendisinde olmayan bir izin bitine izin veremez ve böyle bir bit için reddi kaldıramaz; istek 403 FORBIDDEN ile başarısız olur.

Çağıranın seçemeyeceği boş olmayan bir rtc_region 400 INVALID_OR_RESTRICTED_RTC_REGION döndürür.

Bit hızı sınırları¶

Kabul edilen ses bit hızı çağırana ve sunucuya bağlıdır:

Geçerli üst sınır, çağıranınkiyle sunucununkinden büyük olanıdır. Kabul edilen en düşük bit hızı 8000'dir (8 kbps); daha düşük bir değer 400 INVALID_FORM_BODY döndürür. 1000'in altındaki bir değer kbps olarak okunur ve kontrol edilip kaydedilmeden önce 1000 ile çarpılır. Üst sınırın üzerindeki bir değer 403 BITRATE_REQUIRES_UPGRADE döndürür; üst sınır zaten 384 kbps ise 400 BITRATE_EXCEEDS_LIMIT döndürür. Kanalın mevcut bit hızını tekrarlayan bir istek üst sınıra göre kontrol edilmez; bu nedenle bit hızı çağıranın üst sınırının üzerinde olan bir kanalı yeniden adlandırmak yine de başarılı olur.

Kaydedilen ve döndürülen birim her zaman saniyede bittir. Bu kuraldan önce kbps değeriyle (ör. 64) kaydedilmiş kanallar saniyede bit olarak (64000) döndürülür.

Yanıt¶

Güncellenmiş kanal nesnesiyle (uyumluluk anahtarları ve bir message dizesiyle birlikte) 200.

Yan etkiler¶

Sunucuya kanal nesnesinin tamamıyla Channel Update gönderir ve bir CHANNEL_UPDATE sunucu denetim kaydı girdisi yazar. Bir kategorinin geçersiz kılmaları değiştiğinde, geçersiz kılmaları kategorinin önceki geçersiz kılmalarıyla tamamen eşleşen her alt kanal yeni geçersiz kılmaları ve kendi Channel Update olayını alır. rtc_region değiştirmek kanalın etkin ses bağlantılarını yeni bölgeye taşır; geçersiz kılmaları değiştirmek ise bağlı üyelerin ses izinlerini yeniden değerlendirir.

Grup doğrudan mesaj gövdesi¶

Çağıran mevcut alıcılardan biri olmalıdır; aksi hâlde istek 403 FORBIDDEN döndürür.

Grup simgesi bu yolla ayarlanmaz; Grup doğrudan mesaj simgesi yükle yolunu kullanın.

Yanıt¶

Özel kanal nesnesiyle 200. Hiçbir şeyi değiştirmeyen bir istek mevcut nesneyi döndürür.

Yan etkiler¶

Ad değişikliği, Message Create ile iletilen bir CHANNEL_NAME_CHANGE (4) sistem mesajı oluşturur. Her alıcı, güncellenmiş kanalı bir DM_CHANNEL_UPDATED gönderiminde (Dispatch) alır.

Kanal kilidini aç/kapat¶

PATCH /channels/{channel_id}/lock

Bir sunucu kanalının locked durumunu değiştirir. Yalnızca kullanıcı. VIEW_CHANNEL ve MANAGE_CHANNELS gerektirir. Gövde yoktur; her çağrı mevcut değeri tersine çevirir.

Kanal kilitliyken Mesaj oluştur, yöneticiler dahil her çağıran için 403 FORBIDDEN döndürür.

Yanıt¶

Bir message dizesi içeren JSON gövdesiyle 200. Sunucuya Channel Update gönderir.

Kanalı sil¶

DELETE /channels/{channel_id}

Bir sunucu kanalını siler. Yalnızca kullanıcı. VIEW_CHANNEL ve MANAGE_CHANNELS gerektirir.

Özel kanallar bu yolla silinmez: bir doğrudan mesajı Özel kanallar ile kapatın, bir grup doğrudan mesajdan ise kendi kullanıcı kimliğinizle Grup doğrudan mesaj alıcısını kaldır yolunu kullanarak ayrılın. Bir özel kanal 404 NOT_FOUND döndürür.

Yanıt¶

Bir message dizesi içeren JSON gövdesiyle 200.

Yan etkiler¶

Sunucuya {id, type, guild_id} ile Channel Delete gönderir ve bir CHANNEL_DELETE sunucu denetim kaydı girdisi yazar. Silinen kanal sunucunun sistem, kurallar veya AFK kanalıysa TEBHOS o sunucu ayarını temizler ve Guild Update gönderir.

Hız sınırı¶

channel:delete kovasında her kullanıcı ve kanal için 10 saniyede 20 istek.

Grup doğrudan mesaj simgesi yükle¶

Grup simgesini ayarlamak iki adımlı bir yüklemedir. Mevcut alıcılardan herhangi biri simgeyi değiştirebilir.

Simge yükleme URL'si iste¶

POST /channels/{channel_id}/icon/upload-url

{upload_url, storage_key, url, expires_in} döndürür. Dosyayı expires_in saniye (300) içinde upload_url adresine PUT ile gönderin.

Simgeyi onayla¶

POST /channels/{channel_id}/icon/confirm

Herkese açık simge URL'siyle {icon} döndürür. Simge değiştiğinde TEBHOS bir CHANNEL_ICON_CHANGE (5) sistem mesajı oluşturur ve her alıcıya bir DM_CHANNEL_UPDATED gönderimi yapar. Her iki yol da yalnızca kullanıcıya açıktır ve çağıran grubun alıcısı değilse 403 FORBIDDEN döndürür.

Grup doğrudan mesaj alıcısı ekle¶

PUT /channels/{channel_id}/recipients/{user_id}

Bir kullanıcıyı grup doğrudan mesaja ekler ve 204 döndürür. Yalnızca kullanıcı.

• Çağıran mevcut alıcılardan biri olmalıdır; aksi hâlde 403 FORBIDDEN.
• Kanal bir grup doğrudan mesaj olmalıdır; aksi hâlde 400 BAD_REQUEST.
• Bir grup, sahibi dahil en fazla 50 üye barındırır; dolu bir grup 400 BAD_REQUEST döndürür.
• Hedefin grup doğrudan mesaj gizlilik ayarı çağıranı kabul etmelidir; aksi hâlde 403 MISSING_ACCESS.

Yan etkiler¶

Eklenen kullanıcı Channel Create alır, her alıcı {channel_id, user} ile Channel Recipient Add alır ve bir RECIPIENT_ADD (1) sistem mesajı oluşturulur.

Hız sınırı¶

channel:update kovasında her kullanıcı ve kanal için 10 saniyede 20 istek; buna ek olarak user:group_dm:recipient:add kovasında her kullanıcı için saatte 10 istek.

Grup doğrudan mesaj alıcısını kaldır¶

DELETE /channels/{channel_id}/recipients/{user_id}

Bir kullanıcıyı grup doğrudan mesajdan çıkarır ve 204 döndürür. Yalnızca kullanıcı. Çağıran mevcut alıcılardan biri olmalıdır; aksi hâlde 403 FORBIDDEN. Kendi kullanıcı kimliğinizi göndermek gruptan ayrılmanızı sağlar.

Yan etkiler¶

Çıkarılan kullanıcı Channel Delete alır. Alıcı kalmışsa bunlar {channel_id, user} ile Channel Recipient Remove alır ve bir RECIPIENT_REMOVE (2) sistem mesajı oluşturulur. Son alıcıyı çıkarmak kanalı siler.

Hız sınırı¶

channel:update kovasında her kullanıcı ve kanal için 10 saniyede 20 istek.

Kanal izin geçersiz kılmalarını listele¶

GET /channels/{channel_id}/permissions

Kanalın geçersiz kılmalarını döndürür. VIEW_CHANNEL ve MANAGE_ROLES gerektirir. Bot token'larını kabul eder.

Her girdide id (snowflake değil, yapay bir tanımlayıcı), target_type (0 rol, 1 üye), target_id, channel_id, category_id (null), allow, deny, created_at ve updated_at bulunur.

Kanal izin geçersiz kılmasını ayarla¶

PUT /channels/{channel_id}/permissions/{overwrite_id}

Bir sunucu kanalında veya kategorisinde tek bir izin geçersiz kılmasını oluşturur ya da değiştirir ve 204 döndürür. O kanalda VIEW_CHANNEL ve MANAGE_ROLES gerektirir. Bot token'larını kabul eder.

Yol parametreleri¶

JSON gövdesi¶

Sunucu sahibi olmayan ve ADMINISTRATOR iznine sahip olmayan bir çağıran, kanalda kendisinde olmayan bir bite izin veremez ve böyle bir bit için reddi kaldıramaz (403 FORBIDDEN).

Yan etkiler¶

Sunucuya kanalın tamamıyla Channel Update gönderir. Hedef bir kategori olduğunda, geçersiz kılmaları kategorinin önceki geçersiz kılmalarıyla tamamen eşleşen her alt öğe yeni geçersiz kılmaları ve kendi Channel Update olayını alır. Bağlı üyelerin ses izinleri yeniden değerlendirilir.

Hız sınırı¶

channel:update kovasında her kullanıcı ve kanal için 10 saniyede 20 istek.

curl -X PUT https://tebhos.com/api/v1/channels/1501314428688998182/permissions/1501314428688990000 \
  -H "Authorization: Bot $TEBHOS_BOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type": 0, "allow": "0", "deny": "1024"}'

Kanal izin geçersiz kılmasını sil¶

DELETE /channels/{channel_id}/permissions/{overwrite_id}

Tek bir izin geçersiz kılmasını siler. VIEW_CHANNEL ve MANAGE_ROLES gerektirir. Bot token'larını kabul eder. Bir message dizesi içeren JSON gövdesiyle 200 döndürür.

Kayıtlı geçersiz kılması olmayan bir tanımlayıcı 404 NOT_FOUND döndürür. Kaldırılan ret bitlerine Kanal izin geçersiz kılmasını ayarla ile aynı verme kuralı uygulanır. Yan etkiler ve hız sınırı, geçersiz kılma ayarlamayla aynıdır.

Kanal izinlerini kategoriyle eşitle¶

POST /channels/{channel_id}/permissions/sync-category

Kanalın geçersiz kılmalarını üst kategorisinin geçersiz kılmalarının birebir kopyasıyla değiştirir. Yalnızca kullanıcı. VIEW_CHANNEL ve MANAGE_ROLES gerektirir. Üst kategorisi olmayan bir kanal 400 BAD_REQUEST döndürür.

Ortaya çıkan listeyi Kanal izin geçersiz kılmalarını listele ile aynı yapıda döndürür ve Channel Update gönderir.

Yazıyor göstergesi¶

POST /channels/{channel_id}/typing, Mesajlar altında belgelenmiştir.

Kanal davetleri¶

Bir kanalın davetleri Davetler altında listelenir ve oluşturulur.