curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/roster?limit=25'
{
"members": [
{
"id": "01910000-0000-7000-8000-000000000001",
"user_id": "01910000-0000-7000-8000-000000000002",
"display_name": "Пример",
"position_name": "Куратор модерации",
"status": "active"
}
]
}
Состав
Получить состав сервера
Возвращает страницу состава выбранного сервера.
GET
/
api
/
partner
/
v1
/
servers
/
{server_id}
/
roster
curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/roster?limit=25'
{
"members": [
{
"id": "01910000-0000-7000-8000-000000000001",
"user_id": "01910000-0000-7000-8000-000000000002",
"display_name": "Пример",
"position_name": "Куратор модерации",
"status": "active"
}
]
}
Возвращает страницу состава выбранного сервера. Требуется право чтения состава и доступ бота к серверу. Для следующей страницы передайте полученный next_cursor в параметре cursor.
См. формат ошибок и правила повторов.
Доступ
roster:read.
Партнёрский Bearer-токен. Подробнее в разделе «Авторизация».
Параметры
Уникальный номер сервера из GET /api/partner/v1/servers или UUID сервера. Сервер должен входить в выданный боту доступ.
Успешный ответ
HTTP200. Запрос выполнен успешно.
Сотрудники текущей страницы состава.
Курсор следующей страницы. Пустое значение или отсутствие поля означает, что следующей страницы нет.
Ошибки
| HTTP | Значение |
|---|---|
400 | Некорректный лимит, курсор или параметры запроса. |
401 | Токен отсутствует, недействителен, отозван или не разрешён для этого IP-адреса. |
403 | Недостаточно прав у бота или указанного модератора; сервер или функция не входят в выданный доступ. |
429 | Превышен лимит запросов. Дождитесь интервала, указанного в заголовке Retry-After. |
503 | Сервис временно недоступен. Повторите запрос позднее. |
Пример
В примере использованы условные идентификаторы.curl --request GET \
--header "Authorization: Bearer $PARTNER_TOKEN" \
'https://test.crm.arzguard.com/api/partner/v1/servers/102/roster?limit=25'
{
"members": [
{
"id": "01910000-0000-7000-8000-000000000001",
"user_id": "01910000-0000-7000-8000-000000000002",
"display_name": "Пример",
"position_name": "Куратор модерации",
"status": "active"
}
]
}