Для AI-агентов: markdown этой страницы — /docs-content/chats/stickers/pack-get.md индекс документации — /llms.txt
Получить набор стикеров
GET /v1/chats/stickers/packs/:packId
Возвращает набор стикеров со всеми его стикерами: встроенный набор или любой пользовательский набор портала, а не только свой. Так Битрикс24 показывает набор, стикер из которого пришёл в сообщении.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
packId (path) |
number | да | ID набора — data.packs[].id из списка наборов или packId стикера из сообщения, поле data.stickers первой страницы сообщений |
packType (query) |
string | да | vendor — встроенный набор, custom — набор пользователя |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/chats/stickers/packs/14?packType=vendor" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/chats/stickers/packs/14?packType=vendor" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/stickers/packs/14?packType=vendor', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data.pack.name, '— стикеров:', data.stickers.length)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/stickers/packs/14?packType=vendor', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
console.log(data.pack.name, '— стикеров:', data.stickers.length)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data.pack |
object | Набор |
data.pack.id |
number | ID набора |
data.pack.name |
string | Название набора |
data.pack.type |
string | Вид набора: vendor или custom |
data.pack.authorId |
number | null | ID автора пользовательского набора, у встроенного — null |
data.pack.isAdded |
boolean | Набор есть в списке пользователя |
data.stickers |
array | Стикеры набора |
data.stickers[].id |
number | ID стикера |
data.stickers[].packId |
number | ID набора |
data.stickers[].packType |
string | Вид набора: vendor или custom |
data.stickers[].uri |
string | Путь к картинке на портале Битрикс24 — относительный, без домена |
data.stickers[].type |
string | Тип стикера: image |
data.stickers[].width |
number | Ширина картинки в пикселях |
data.stickers[].height |
number | Высота картинки в пикселях |
data.stickers[].sort |
number | Порядок стикера в наборе |
Пример ответа
Показаны два стикера из набора:
{
"success": true,
"data": {
"stickers": [
{ "id": 1, "uri": "/bitrix/images/im/stickers/aiHelp/1.png?v1", "type": "image", "width": 512, "height": 512, "packId": 14, "packType": "vendor", "sort": 1 },
{ "id": 2, "uri": "/bitrix/images/im/stickers/aiHelp/2.png?v1", "type": "image", "width": 512, "height": 512, "packId": 14, "packType": "vendor", "sort": 2 }
],
"pack": { "id": 14, "name": "ИИ, помогии", "type": "vendor", "authorId": null, "isAdded": true }
}
}
Пример ответа при ошибке
422 — набора с таким id и packType нет:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "PACK_NOT_AVAILABLE",
"b24Code": "PACK_NOT_AVAILABLE"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_PARAMS |
packId не положительное целое, packType не передан или не vendor / custom, передан другой параметр или параметр повторён |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов Битрикс24 |
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа im |
| 404 | ENTITY_NOT_FOUND |
Битрикс24 не нашёл объект. Код портала — в error.b24Code, если он был передан |
| 422 | BITRIX_ERROR |
error.b24Code: PACK_NOT_AVAILABLE — набора нет |
| 502 | BITRIX_UNAVAILABLE |
Битрикс24 недоступен или вернул ошибку сервера |
Полный список общих ошибок API — Ошибки.
Известные особенности
idвстроенного и пользовательского набора могут совпадать, поэтомуpackTypeобязателен.