Для AI-агентов: markdown этой страницы — /docs-content/openlines/quick-replies/update.md индекс документации — /llms.txt

Изменить быстрый ответ

PATCH /v1/openline-configs/:lineId/quick-replies/:id

Заменяет текст быстрого ответа открытой линии и при необходимости переносит его в другой раздел или убирает из раздела.

Параметры

Параметр Тип Обяз. Описание
ПараметрlineId (path) Типinteger Обяз.да ОписаниеID открытой линии. Список: GET /v1/openline-configs
Параметрid (path) Типinteger Обяз.да ОписаниеID быстрого ответа этой линии. Список: data.replies[].id в ответе GET /v1/openline-configs/:lineId/quick-replies

Поля запроса (body)

Тело передаётся плоско, без обёртки fields.

Поле Тип Обяз. Описание
Полеtext Типstring Обяз.да ОписаниеНовый текст ответа целиком. Строка из одних пробелов не принимается
ПолеsectionId Типinteger Обяз.нет ОписаниеID раздела этой же линии из data.sections ответа GET /v1/openline-configs/:lineId/quick-replies. Без поля раздел ответа не меняется, 0 убирает ответ из раздела

Примеры

curl — личный ключ

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies/7277" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Здравствуйте, оператор ответит в течение минуты",
    "sectionId": 123
  }'

curl — OAuth-приложение

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies/7277" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Здравствуйте, оператор ответит в течение минуты",
    "sectionId": 123
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies/7277', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    text: 'Здравствуйте, оператор ответит в течение минуты',
    sectionId: 123,
  }),
})
const { data } = await res.json()
console.log(data.name, data.sectionId)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openline-configs/3/quick-replies/7277', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    text: 'Здравствуйте, оператор ответит в течение минуты',
    sectionId: 123,
  }),
})
const { data } = await res.json()
console.log(data.name, data.sectionId)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеБыстрый ответ после правки. Те же поля, что у записи data.replies[] в списке быстрых ответов
Полеdata.id Типinteger ОписаниеID ответа, совпадает с id из пути
Полеdata.name Типstring ОписаниеНазвание ответа — первые 100 символов нового text
Полеdata.text Типstring ОписаниеТекст ответа после правки
Полеdata.sectionId Типinteger ОписаниеID раздела после правки. 0 — ответ без раздела
Полеdata.canEdit Типboolean ОписаниеМожет ли пользователь ключа изменить ответ
Полеdata.rating Типnumber | string ОписаниеРейтинг ответа

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 7277,
    "name": "Здравствуйте, оператор ответит в течение минуты",
    "text": "Здравствуйте, оператор ответит в течение минуты",
    "sectionId": 123,
    "canEdit": true,
    "rating": 1
  }
}

Пример ответа при ошибке

404 — в линии из пути нет ответа с таким id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Quick reply not found in this line"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодMISSING_REQUIRED_FIELDS Описаниеtext не передан, пустой или состоит из пробелов
HTTP400 КодINVALID_PARAMS ОписаниеlineId или id не положительное целое число
HTTP400 КодINVALID_PARAMS ОписаниеsectionId не целое неотрицательное число
HTTP400 КодINVALID_PARAMS ОписаниеsectionId не 0, не совпадает с текущим разделом ответа и его нет среди data.sections этой линии. Ответ не меняется
HTTP400 КодINVALID_PARAMS ОписаниеТело запроса не JSON-объект
HTTP400 КодINVALID_JSON_BODY ОписаниеТело запроса не разбирается как JSON
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет действующей авторизации в Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа imopenlines
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме «только чтение»
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя ключа нет права просматривать быстрые ответы линии
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал пользователю ключа в доступе при сохранении
HTTP404 КодENTITY_NOT_FOUND ОписаниеСообщение Quick reply not found in this line: ответа с таким id нет в линии из пути, в том числе если он принадлежит другой линии
HTTP404 КодENTITY_NOT_FOUND ОписаниеСообщение Record not found: открытой линии с таким lineId нет
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку. Текст — в message
HTTP429 КодRATE_LIMITED ОписаниеПревышен собственный лимит метода. Общий потолок платформы — 120 запросов в минуту на портал, он делится между репликами платформы, поэтому код может прийти раньше 120-го запроса. Действующее значение — в заголовке x-ratelimit-limit
HTTP502 КодOPENLINE_OPERATOR_FAILED ОписаниеБитрикс24 вернул ответ неожиданной формы
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя. Правка могла сохраниться: перед повтором проверьте список ответов

Полный список общих ошибок API — Ошибки.

Смотрите также