For AI agents: markdown of this page — /docs-content-en/chats/stickers/pack-get.md documentation index — /llms.txt

Get a sticker pack

GET /v1/chats/stickers/packs/:packId

Returns a sticker pack with all its stickers: a built-in pack or any user pack in the Bitrix24 account, not only your own. This is how Bitrix24 shows the pack of a sticker that arrived in a message.

Parameters

Parameter Type Required Description
ParameterpackId (path) Typenumber Requiredyes DescriptionPack ID — data.packs[].id from the list of packs or the packId of a sticker from a message (the data.stickers field of the first page of messages)
ParameterpackType (query) Typestring Requiredyes Descriptionvendor — a built-in pack, custom — a user pack

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/chats/stickers/packs/14?packType=vendor', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.pack.name, '— stickers:', data.stickers.length)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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, '— stickers:', data.stickers.length)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.pack Typeobject DescriptionThe pack
Fielddata.pack.id Typenumber DescriptionPack ID
Fielddata.pack.name Typestring DescriptionPack name
Fielddata.pack.type Typestring DescriptionPack type: vendor or custom
Fielddata.pack.authorId Typenumber | null DescriptionID of the author of a user pack; null for a built-in pack
Fielddata.pack.isAdded Typeboolean DescriptionThe pack is in the user's list
Fielddata.stickers Typearray DescriptionStickers of the pack
Fielddata.stickers[].id Typenumber DescriptionSticker ID
Fielddata.stickers[].packId Typenumber DescriptionPack ID
Fielddata.stickers[].packType Typestring DescriptionPack type: vendor or custom
Fielddata.stickers[].uri Typestring DescriptionPath to the image in the Bitrix24 account — relative, without the domain
Fielddata.stickers[].type Typestring DescriptionSticker type: image
Fielddata.stickers[].width Typenumber DescriptionImage width in pixels
Fielddata.stickers[].height Typenumber DescriptionImage height in pixels
Fielddata.stickers[].sort Typenumber DescriptionSticker order in the pack

Response example

Two stickers of the pack are shown:

JSON 
{
  "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": "AI Help", "type": "vendor", "authorId": null, "isAdded": true }
  }
}

Error response example

422 — there is no pack with this id and packType:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "PACK_NOT_AVAILABLE",
    "b24Code": "PACK_NOT_AVAILABLE"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionpackId is not a positive integer, packType is missing or is not vendor / custom, another parameter was passed, or a parameter was repeated
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the im scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 did not find the object; the portal code is in error.b24Code if supplied
HTTP422 CodeBITRIX_ERROR Descriptionerror.b24Code: PACK_NOT_AVAILABLE — the pack does not exist
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable or returned a server error

Full list of common API errors — Errors.

Known specifics

  • A built-in pack and a user pack may have the same id, so packType is required.

See also