Для AI-агентов: markdown этой страницы — /docs-content/notifications/confirm.md индекс документации — /llms.txt
Нажать кнопку уведомления
POST /v1/notifications/:id/confirm
Нажимает кнопку уведомления-запроса от имени владельца токена: выполняет действие кнопки, например принимает приглашение или подтверждает запрос, и удаляет уведомление.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id (path) |
number | да | Идентификатор уведомления — поле data.notifications[].id в ленте уведомлений GET /v1/notifications. Положительное целое число |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
value |
string, number | да | Значение нажатой кнопки из поля data.notifications[].notifyButtons ленты уведомлений — часть COMMAND_PARAMS кнопки после символа |. Для "38959|Y" это Y. Пустая строка, 0 и "0" не принимаются |
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/38959/confirm" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "value": "Y" }'
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/notifications/38959/confirm" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "value": "Y" }'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/38959/confirm', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ value: 'Y' }),
})
const { data } = await res.json()
console.log(data.resultMessage[0])
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/notifications/38959/confirm', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({ value: 'Y' }),
})
const { data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | true при успешном выполнении |
data.resultMessage |
string[] | Сообщения о результате. Текст формирует Битрикс24 — экранируйте его перед выводом в интерфейсе |
Пример ответа
HTTP 200:
{
"success": true,
"data": {
"resultMessage": ["Приглашение принято"]
}
}
Пример ответа при ошибке
422 — у уведомления нет кнопок или его нет у владельца токена:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "Notification is absent, unavailable to the token owner, or cannot perform this action.",
"b24Code": "NOTIFICATION_ACTION_FAILED"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_PARAMS |
id в пути — не положительное целое число |
| 400 | INVALID_PARAMS |
value не передан, передан не строкой и не числом, пустой или равен 0 / "0" |
| 400 | INVALID_PARAMS |
Передано другое поле тела или параметр строки запроса либо тело не является объектом JSON. Поле названо в сообщении. Проверяется до обращения к Битрикс24 |
| 400 | FST_ERR_CTP_EMPTY_JSON_BODY |
Передан заголовок Content-Type: application/json, а тело пустое |
| 422 | BITRIX_ERROR |
Уведомления нет, оно недоступно владельцу токена или не выполняет такое действие — в том числе уведомление без кнопок. Код портала NOTIFICATION_ACTION_FAILED — в поле error.b24Code |
| 502 | BITRIX_UNAVAILABLE |
Битрикс24 вернул ответ без списка сообщений о результате |
| 403 | SCOPE_DENIED |
У ключа нет скоупа im |
| 403 | WRITE_BLOCKED_READONLY_KEY |
Ключ в режиме «только чтение». Проверяется до обращения к Битрикс24 |
| 403 | BITRIX_ACCESS_DENIED |
Битрикс24 отказал в доступе |
| 401 | TOKEN_MISSING |
У ключа нет настроенных токенов |
| 401 | MISSING_API_KEY |
Не передан заголовок X-Api-Key |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Поле
notifyButtonsв ленте — строка JSON. Разберите строку, прежде чем читатьCOMMAND_PARAMSкнопок. - После нажатия уведомления в ленте нет, и повторное нажатие отвечает
422 BITRIX_ERROR. - У уведомления без кнопок поле
notifyButtonsв ленте отсутствует, и нажатие отвечает422 BITRIX_ERROR. Уведомление при этом остаётся в ленте. - Кнопка нажимается от имени владельца токена. По личному ключу — владельца ключа. По ключу OAuth-приложения с заголовком
Authorization: Bearer— пользователя, чья это сессия.