ZaminDocs

Metodlar

Bot API'da hozir 38 ta metod bor. Har biri https://api.zamin.app/bot<TOKEN>/<metod> manzilida, GET yoki POST bilan.

Bot haqida

MetodVazifasiNatija
getMe GETBotning o'zi haqidagi ma'lumot. Tokenni tekshirishning eng oddiy usuli.User
logOut GETTelegram bilan moslik uchun. Hech narsa qilmaydi, true qaytaradi.true
close GETTelegram bilan moslik uchun. Hech narsa qilmaydi, true qaytaradi.true

Xabarlar

MetodVazifasiNatija
sendMessage POSTShaxsiy chat, guruh yoki kanalga matnli xabar yuboradi (ixtiyoriy klaviatura bilan).Message
editMessageText POSTBotning o'z matnli xabarini (yoki kanal postini) tahrirlaydi.Message
editMessageReplyMarkup POSTBot xabaridagi inline klaviaturani almashtiradi yoki olib tashlaydi.Message
deleteMessage POSTXabarni hamma uchun o'chiradi: shaxsiy chat, guruh (huquq bilan) yoki kanal.true

Fayllar

MetodVazifasiNatija
sendPhoto POSTRasm yuboradi (multipart yoki file_id).Message
sendDocument POSTIstalgan faylni hujjat sifatida yuboradi.Message
sendVideo POSTVideo yuboradi (MP4, MOV, WebM).Message
sendAudio POSTAudio fayl yuboradi (MP3, M4A, OGG, WAV, FLAC …).Message
getFile POSTfile_id bo'yicha yuklab olish yo'lini (file_path) qaytaradi.File

Tugmalar

MetodVazifasiNatija
answerCallbackQuery POSTInline tugma bosilishiga javob beradi: qisqa xabar, oyna yoki havola.true

Bot profili

MetodVazifasiNatija
setMyCommands POSTIlovada ko'rsatiladigan buyruqlar ro'yxatini o'rnatadi.true
getMyCommands GETJoriy buyruqlar ro'yxatini qaytaradi.Array of BotCommand
deleteMyCommands GETBuyruqlar ro'yxatini tozalaydi.true
setMyDescription POST"Bu bot nima qila oladi?" matnini o'rnatadi.true
getMyDescription GETJoriy tavsifni qaytaradi.{description: String}
setMyShortDescription POSTQisqa ma'lumot ("about") matnini o'rnatadi.true
getMyShortDescription GETJoriy qisqa ma'lumotni qaytaradi.{short_description: String}
setMyName POSTBotning ko'rinadigan nomini o'zgartiradi.true
getMyName GETBotning joriy nomini qaytaradi.{name: String}

Yangilanishlar

MetodVazifasiNatija
getUpdates POSTYangilanishlarni long polling bilan oladi.Array of Update
setWebhook POSTYangilanishlarni HTTPS manzilingizga yuborishni yoqadi.true
deleteWebhook POSTWebhookni o'chiradi (keyin getUpdates ishlatish mumkin).true
getWebhookInfo GETWebhook holati: manzil, navbat, oxirgi xato.WebhookInfo

Chatlar

MetodVazifasiNatija
getChat POSTChat haqida ma'lumot: shaxsiy chat, guruh yoki kanal.Chat
getChatAdministrators POSTGuruh yoki kanalning egasi va adminlari (botlar ham).Array of ChatMember
getChatMember POSTGuruhdagi bitta odamning holati (ega, admin, a'zo, jim qilingan, chiqqan, chetlatilgan); kanalda — faqat bot, ega va adminlar.ChatMember
getChatMemberCount POSTGuruh a'zolari (botlar bilan) yoki kanal obunachilari soni.Integer
leaveChat POSTBot guruh yoki kanaldan o'zi chiqadi.true

Guruh boshqaruvi

MetodVazifasiNatija
banChatMember POSTOdamni guruhdan chetlatadi va qaytib kirishini taqiqlaydi (muddatsiz).true
unbanChatMember POSTBanni olib tashlaydi (odam yana qo'shila oladi).true
restrictChatMember POSTA'zoni jim qiladi (yoza olmaydi) — muddat bilan yoki muddatsiz; yoki cheklovni olib tashlaydi.true
pinChatMessage POSTGuruh yoki kanalda xabarni qadaydi.true
unpinChatMessage POSTQadalgan xabarni olib tashlaydi.true
setChatTitle POSTGuruh yoki kanal nomini o'zgartiradi.true
setChatDescription POSTGuruh yoki kanal tavsifini o'zgartiradi yoki tozalaydi.true