Перейти к содержимому

List Bot Subscribers

GET
/v1/bots/{bot_id}/subscribers
curl --request GET \
--url https://api.cloud.agentums.ru/v1/bots/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscribers \
--header 'Authorization: Bearer <token>'

Кому бот вправе написать первым — то есть до кого поручение реально доедет.

Отдельный список, а не флажок в составе группы, и разница не косметическая. Состав группы отвечает на вопрос «кто здесь», подписка — на вопрос «кому дойдёт». Второе не следует из первого: Telegram запрещает боту начинать разговор, поэтому участник группы, не открывший личку, для уведомлений недостижим, — и владельцу надо видеть именно этот разрыв.

bot_id
required
Bot Id
string format: uuid

Successful Response

Media typeapplication/json
BotSubscriberListOut
object
items
Items
Array<object>
BotSubscriberOut

Исполнитель, открывший личку с ботом, — то есть тот, до кого уведомление доедет.

blocked показывать ОБЯЗАТЕЛЬНО. Без него владелец видит человека в списке и считает, что поручения к нему уходят; на деле Telegram отвечает 403, и «поручил и забыл» превращается в «поручил в пустоту». Это единственное состояние экрана, о котором нельзя промолчать.

object
blocked
Blocked
boolean
display_name
Display Name
string
""
source
Source
string
default: member
subscribed_at
Subscribed At
string
""
tg_user_id
required
Tg User Id
integer
username
Username
string
""
Example
{
"items": [
{
"blocked": false,
"display_name": "",
"source": "member",
"subscribed_at": "",
"username": ""
}
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}