لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/bots/commands.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Commands

Register bot slash commands, update and delete them, answer invocations. Users invoke commands via / in chat. Commands also fire through the COMMAND field in keyboard buttons — both ways generate the same ONIMBOTV2COMMANDADD event.

Scope: imbot | Base URL: https://vibecode.bitrix24.com/v1 | Authorization: X-Api-Key

Register a command

POST /v1/bots/:botId/commands

Registers a new bot slash command. Vibecode accepts a flat format and automatically wraps it in fields for Bitrix24.

The Bitrix24 format with a non-empty fields wrapper is accepted too: such a body is forwarded to Bitrix24 unchanged, its fields are not checked against the table below, and no warning is returned. The values [], null, false, 0 and "" do not count as a wrapper — the body is read as flat. This happens, for example, when PHP turns an empty array into JSON: json_encode([]) gives []. An empty object {} does count as a wrapper, and top-level fields are then not applied.

Request fields (body)

Parameter Type Required Default Description
Parametercommand Typestring Requiredyes Default— DescriptionCommand text without / (for example, help)
Parametertitle Typestring/object Requiredno Default— DescriptionTitle. A string or a multilingual object { "en": "Help", "de": "Hilfe" }
Parameterparams Typestring/object Requiredno Default— DescriptionParameter description. A string or an object { "en": "topic", "de": "Thema" }
Parametercommon Typestring Requiredno Default"N" Description"Y" — available in all chats, "N" — only in a private chat with the bot and in chats that include the bot
Parameterhidden Typestring Requiredno Default"N" Description"Y" — hide from the command list
ParameterextranetSupport Typestring Requiredno Default"N" Description"Y" — available to extranet users

The table lists every accepted field. A field with any other name is dropped and the request still succeeds: the response includes a warning object with the code UNSUPPORTED_FIELDS_DROPPED and the list of dropped names. Pass the descriptive text of the command in title and the argument hint in params.

Examples

curl — personal key

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "command": "help",
    "title": { "en": "Help", "de": "Hilfe" },
    "params": { "en": "topic", "de": "Thema" },
    "common": "Y"
  }'

curl — OAuth application

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/bots/42/commands \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "command": "help",
    "title": { "en": "Help", "de": "Hilfe" },
    "params": { "en": "topic", "de": "Thema" },
    "common": "Y"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/commands', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'help',
    title: { en: 'Help', de: 'Hilfe' },
    params: { en: 'topic', de: 'Thema' },
    common: 'Y',
  }),
})

const { success, data } = await res.json()
console.log('Command ID:', data.command.id)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/commands', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    command: 'help',
    title: { en: 'Help', de: 'Hilfe' },
    params: { en: 'topic', de: 'Thema' },
    common: 'Y',
  }),
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fielddata.command.id Typenumber DescriptionID of the registered command
Fielddata.command.botId Typenumber DescriptionBot ID
Fielddata.command.command Typestring DescriptionCommand text (with /)
Fielddata.command.common Typeboolean DescriptionAvailable in all chats
Fielddata.command.hidden Typeboolean DescriptionHidden from the list
Fielddata.command.extranetSupport Typeboolean DescriptionAvailable to extranet users
Fieldwarning.code Typestring DescriptionUNSUPPORTED_FIELDS_DROPPED. Returned when the request body contained a field outside the "Request fields" table
Fieldwarning.message Typestring DescriptionText listing the dropped fields
Fieldwarning.droppedFields Typearray DescriptionNames of the dropped fields

Response example

The request body contained only accepted fields:

JSON 
{
  "success": true,
  "data": {
    "command": {
      "id": 117,
      "botId": 1327,
      "command": "/help",
      "common": true,
      "hidden": false,
      "extranetSupport": false
    }
  }
}

The request body contained a description field — the command was registered and the field was dropped:

JSON 
{
  "success": true,
  "data": {
    "command": {
      "id": 117,
      "botId": 1327,
      "command": "/help",
      "common": true,
      "hidden": false,
      "extranetSupport": false
    }
  },
  "warning": {
    "code": "UNSUPPORTED_FIELDS_DROPPED",
    "message": "Bitrix24 imbot.v2.Command.register does not accept these fields; they were dropped: description.",
    "droppedFields": ["description"]
  }
}

Error response example

422 — Bitrix24 error:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Command 'help' already registered"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_BOT_ID DescriptionbotId is not a number
HTTP404 CodeBOT_NOT_FOUND DescriptionNo bot found with this ID
HTTP403 CodeBOT_ACCESS_DENIED DescriptionThe bot belongs to a different API key
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 error (error text in message)
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the imbot scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only — see access rights
HTTP410 CodeBOT_DISABLED DescriptionThe bot is disabled and does not process API calls. How to restore it — Bot disabled
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

Idempotency: a repeat call with the same command for the same bot returns the existing command unchanged. To update it, use PATCH.

Multilingual: title and params accept either a string or an object with language keys, for example en, de, ru. A plain string is stored as the English translation, so use an object to set the other languages: { "en": "Help", "de": "Hilfe" }.

Event: when a user invokes the command, the ONIMBOTV2COMMANDADD event fires.

See also