[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-bots\u002Fopenlines\u002Fauto-message":3,"docs-tabs-bots\u002Fopenlines\u002Fauto-message":6},{"content":4,"lastmod":5},"## Send an automatic line message\n\n`POST \u002Fv1\u002Fbots\u002F:botId\u002Fopenlines\u002Fsession\u002Fauto-message`\n\nThe bot sends either the welcome message from the Open Channel settings or a system message with the given text to the Open Channel conversation. To reply to the customer on behalf of the bot, use a different method: [Send message](\u002Fdocs\u002Fbots\u002Fmessages\u002Fsend).\n\n## Parameters\n\n| Parameter | Type | Required | Default | Description |\n|----------|-----|:-----:|-----------|----------|\n| `botId` (path) | integer | yes | — | ID of a bot registered with this key. List: [`GET \u002Fv1\u002Fbots`](\u002Fdocs\u002Fbots\u002Fmanagement\u002Flist) |\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|----------|\n| `chatId` | integer \\| string | yes | Open Channel chat ID: a positive integer, a string of digits or the `chat\u003CN>` form. Source: the `data.chat.id` field of a [bot event](\u002Fdocs\u002Fbots\u002Fevents\u002Fbot-events) or `sessions[].chatId` in [`POST \u002Fv1\u002Fopenlines\u002Fsessions\u002Fsearch`](\u002Fdocs\u002Fopenlines\u002Fsessions\u002Fsearch). Instead of `chatId`, you can pass `dialogId` or `CHAT_ID` |\n| `dialogId` | string | no | The same chat, only in the `chat\u003CN>` form, for example `chat2043`. A number without the prefix is not accepted here |\n| `CHAT_ID` | integer \\| string | no | Alternative name for `chatId` with the same formats |\n| `type` | string | yes | Automatic message type: `WELCOME` is the welcome message from the Open Channel settings, `DEFAULT` is a system message with the text from `message` |\n| `message` | string | no | Message text. Required with `type: \"DEFAULT\"`, and in that case an empty string and the string `\"0\"` are not accepted |\n\nOf `chatId`, `dialogId` and `CHAT_ID`, the first field that is set is used, checked in exactly this order. A field set to `null` counts as not set. An invalid value in the first set field returns `400 INVALID_CHAT_ID`, and the remaining fields are not checked in that case.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbots\u002F621\u002Fopenlines\u002Fsession\u002Fauto-message \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"chatId\": 2043,\n    \"type\": \"DEFAULT\",\n    \"message\": \"Thank you for reaching out! We will reply within 10 minutes.\"\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbots\u002F621\u002Fopenlines\u002Fsession\u002Fauto-message \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"chatId\": 2043,\n    \"type\": \"DEFAULT\",\n    \"message\": \"Thank you for reaching out! We will reply within 10 minutes.\"\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbots\u002F621\u002Fopenlines\u002Fsession\u002Fauto-message',\n  {\n    method: 'POST',\n    headers: {\n      'X-Api-Key': 'YOUR_API_KEY',\n      'Content-Type': 'application\u002Fjson',\n    },\n    body: JSON.stringify({\n      chatId: 2043,\n      type: 'DEFAULT',\n      message: 'Thank you for reaching out! We will reply within 10 minutes.',\n    }),\n  }\n)\n\nconst { success, data, error } = await res.json()\nconsole.log(success ? data.accepted : error.code)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbots\u002F621\u002Fopenlines\u002Fsession\u002Fauto-message',\n  {\n    method: 'POST',\n    headers: {\n      'X-Api-Key': 'YOUR_APP_KEY',\n      'Authorization': 'Bearer USER_SESSION_TOKEN',\n      'Content-Type': 'application\u002Fjson',\n    },\n    body: JSON.stringify({\n      chatId: 2043,\n      type: 'DEFAULT',\n      message: 'Thank you for reaching out! We will reply within 10 minutes.',\n    }),\n  }\n)\n\nconst { success, data, error } = await res.json()\nconsole.log(success ? data.accepted : error.code)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` when Bitrix24 confirmed the call |\n| `data.chatId` | integer | ID of the chat the action was applied to. Returned as a number even if the request passed the `chat\u003CN>` form |\n| `data.accepted` | boolean | Always `true`: Bitrix24 accepted the call. The field does not confirm delivery of the message to the customer |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"chatId\": 2043,\n    \"accepted\": true\n  }\n}\n```\n\n## Error response example\n\n400 — `type: \"DEFAULT\"` was passed without message text:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"MISSING_REQUIRED_FIELDS\",\n    \"message\": \"DEFAULT requires a non-empty message other than \\\"0\\\"\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_BOT_ID` | `botId` in the path is not a positive integer |\n| 400 | `INVALID_PARAMS` | The request body is not a JSON object, for example an array or a string |\n| 400 | `INVALID_PARAMS` | `type` is neither `WELCOME` nor `DEFAULT` |\n| 400 | `INVALID_PARAMS` | With `type: \"WELCOME\"`, the `message` field is not a string |\n| 400 | `INVALID_CHAT_ID` | None of the `chatId`, `dialogId`, `CHAT_ID` fields was passed, the value is invalid, or `dialogId` was passed without the `chat` prefix. A body that cannot be parsed as JSON is treated as empty and also gets this code. `message` says where to get the chat ID |\n| 400 | `MISSING_REQUIRED_FIELDS` | With `type: \"DEFAULT\"`, `message` is missing, is not a string, or is an empty string or `\"0\"` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |\n| 401 | `TOKEN_MISSING` | The key has no portal tokens. For an application key, the user session token was not passed |\n| 403 | `SCOPE_DENIED` | The key lacks the `imbot` or `imopenlines` scope — both are required |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in read-only mode |\n| 403 | `BOT_ACCESS_DENIED` | The bot was registered by another key. To regain control, see [Restoring access to a bot](\u002Fdocs\u002Fbots\u002Fownership-recovery) |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to the chat |\n| 404 | `BOT_NOT_FOUND` | There is no bot with this `botId` on the portal — register it via `POST \u002Fv1\u002Fbots` |\n| 404 | `ENTITY_NOT_FOUND` | Bitrix24 reported that the record was not found |\n| 409 | `BOT_ID_REPLACED` | The bot was registered again after the portal address changed. The new ID is in `error.details.botId` |\n| 409 | `BOT_RECOVERY_IN_PROGRESS` | The bot is being restored automatically after the portal address changed. Retry after the delay given in the `Retry-After` header |\n| 410 | `BOT_DISABLED` | The bot is disabled. To bring the bot back, see [Bot disabled](\u002Fdocs\u002Fbots\u002Ftroubleshooting#bot-disabled-bot_disabled) |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the call. The Bitrix24 code is in `error.b24Code` |\n| 429 | `RATE_LIMITED` | The shared platform ceiling of 30 requests per minute per portal was exceeded. The ceiling is shared by the four bot actions in an Open Channel and the `POST \u002Fv1\u002Fopenlines\u002Foperator\u002Fanswer` and `POST \u002Fv1\u002Fopenlines\u002Foperator\u002Ffinish` calls, and is split between platform replicas, so the code can arrive before the 30th request. The effective value is in the `x-ratelimit-limit` header. The time until a retry is in `error.message`. A request rejected with `400` because of an error in the body also counts against the limit |\n| 429 | `RATE_LIMITED` | Bitrix24 throttled requests to the portal. Retry after the delay given in the `Retry-After` header |\n| 429 | `QUEUE_OVERFLOW` | The request queue to the portal is full. Retry after the delay given in the `Retry-After` header |\n| 429 | `QUEUE_TIMEOUT` | The request did not get its turn in the portal queue and was not sent to Bitrix24. Retry after the delay given in the `Retry-After` header |\n| 502 | `OPENLINE_BOT_SESSION_FAILED` | Bitrix24 did not confirm the call: the call result is not `true` |\n| 502 | `BITRIX_UNAVAILABLE` | The Bitrix24 portal is unavailable |\n| 503 | `BITRIX_TIMEOUT` | The Bitrix24 portal did not respond in time |\n| 503 | `user_self_deletion_pending` | The key owner's account on the portal is pending deletion |\n\nFull list of common API errors: [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**`accepted: true` does not mean the message was sent.** A `200` response with `accepted: true` also arrives when the message was not added to the chat, for example if there is no chat with this `chatId`.\n\n## See also\n\n- [Open Channel bot](\u002Fdocs\u002Fbots\u002Fopenlines)\n- [Hand to an operator](\u002Fdocs\u002Fbots\u002Fopenlines\u002Foperator)\n- [Transfer a session](\u002Fdocs\u002Fbots\u002Fopenlines\u002Ftransfer)\n- [Finish a session](\u002Fdocs\u002Fbots\u002Fopenlines\u002Ffinish)\n- [Send message](\u002Fdocs\u002Fbots\u002Fmessages\u002Fsend)\n","2026-10-19",{},1795000414494]