Send a message

POST /v1/chats/:dialogId/messages

Sends a text message to the given dialog. The text supports BB codes for formatting; you can add a keyboard and attachments to the message.

Parameters

The me alias. Instead of a numeric user ID you can pass the string me: the dialog opens with the current key owner. Learn more in Chats and messages.

The v2 mode. format=v2 sends the message. The body stays flat — the same fields as below — and data carries the object { id, uuidMap, failureMap } instead of a number. The mode accepts only the fields in the table below, including those marked "the v2 mode only". Any other body field, uppercase forms (MESSAGE, REPLY_ID) and query parameters other than format are rejected with 400 INVALID_PARAMS, which names the field without repeating its value. In the v2 mode message must be a string. The message must have content: non-empty text. Whitespace-only text is accepted only with a non-empty attach. Without message, a non-empty attach, stickerParams or block is required. Otherwise the route returns 400 MESSAGE_REQUIRED before any call to the Bitrix24 account. Forwarding goes through POST /v1/chats/:dialogId/forward: in the v2 mode the forwardIds field is rejected with an error that points to that endpoint, and botId with one that points to sending as a bot.

Request body fields

Message layout

• Text formatting — BB codes: bold, italic, links, color
• Keyboard — interactive buttons under the message
• Attachments — cards, tables, images, files

The message text is limited to 20000 Unicode code points. The complete outgoing string is counted, including markup, URLs and mentions, without truncation or trimming. For example, 😀 is one code point, while a compound emoji may occupy several. The request is rejected before any call to Bitrix24.

Without format=v2, matching text aliases message, MESSAGE, Message and fields.message are accepted, including other case variants. Their values must agree. A conflict returns 400 INVALID_PARAMS. An object is never converted to text. The v2 mode keeps its flat body whitelist: case variants and fields are not accepted.

Examples

In the examples, dialogId is 42 — the recipient's numeric user ID.

curl — personal key

curl -X POST https://vibecode.bitrix24.com/v1/chats/42/messages \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Invoice issued. Please await confirmation."
  }'

curl — OAuth application

curl -X POST https://vibecode.bitrix24.com/v1/chats/42/messages \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Invoice issued. Please await confirmation."
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/42/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Invoice issued. Please await confirmation.',
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/42/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Invoice issued. Please await confirmation.',
  }),
})

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

curl — the v2 mode

curl -X POST "https://vibecode.bitrix24.com/v1/chats/42/messages?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Invoice issued. Please await confirmation.",
    "urlPreview": false
  }'

Response fields

Response example

The regular mode:

{
  "success": true,
  "data": 36889
}

The v2 mode — format=v2:

{
  "success": true,
  "data": {
    "id": 36889,
    "uuidMap": [],
    "failureMap": []
  }
}

Error response example

400 — no message text was passed:

{
  "success": false,
  "error": {
    "code": "MESSAGE_REQUIRED",
    "message": "Message is empty. Put the message text in the \"message\" field (or send an \"attach\" block)."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

The Bitrix24 refusal code. The Bitrix24 refusal code arrives in error.b24Code. In a 404 ENTITY_NOT_FOUND response this field is present only in the v2 mode.

See also

• Messages
• Edit a message
• Delete a message