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

Пометить клиента спамером

POST /v1/openlines/operator/spam

Помечает клиента Открытой линии спамером и закрывает текущую сессию его чата, завершая диалог с ним.

Действие выполняется от имени сотрудника, к которому привязан ключ, — см. От чьего имени выполняется действие.

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

Поле Тип Обяз. Описание
ПолеchatId Типnumber | string Обяз.да ОписаниеИдентификатор чата Открытой линии — положительное целое. Строка принимается, если состоит только из цифр и не начинается с нуля. См. Идентификатор чата

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/operator/spam \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chatId": 5253}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/operator/spam \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"chatId": 5253}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/operator/spam', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ chatId: 5253 }),
})

const body = await res.json()
if (!body.success) throw new Error(`${body.error.code}: ${body.error.message}`)
console.log('Клиент помечен спамером, чат:', body.data.chatId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/operator/spam', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ chatId: 5253 }),
})

const body = await res.json()
if (!body.success) throw new Error(`${body.error.code}: ${body.error.message}`)
console.log('Клиент помечен спамером, чат:', body.data.chatId)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata.chatId Типnumber ОписаниеИдентификатор чата из запроса. Строка из запроса возвращается числом
Полеdata.spammed Типboolean ОписаниеВсегда true

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

JSON 
{
  "success": true,
  "data": {
    "chatId": 5253,
    "spammed": true
  }
}

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

404 — чата с таким идентификатором нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Open Line chat not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_CHAT_ID ОписаниеchatId не передан, не положительное целое, строка не из одних цифр или с ведущим нулём, либо число больше 9007199254740991
HTTP404 КодENTITY_NOT_FOUND ОписаниеЧата с таким chatId нет
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отказал в действии. Код отказа, если Битрикс24 его вернул, приходит в error.b24Code
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ сотрудника, от имени которого идёт вызов, нет прав на действие
HTTP502 КодOPENLINE_OPERATOR_FAILED ОписаниеБитрикс24 ответил без ошибки, но действие не подтвердил
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа imopenlines
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан
HTTP401 КодTOKEN_MISSING ОписаниеУ личного ключа нет доступа к порталу Битрикс24, у ключа приложения не передан токен сессии в Authorization
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или соединение с ним оборвалось до полного ответа

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

Известные особенности

  • Ответ не доказывает, что был открытый диалог. На чате, сессия которого уже закрыта, и при повторном вызове метод возвращает тот же ответ со spammed: true, а новая сессия не создаётся. Закрыл ли вызов сессию, проверяйте в POST /v1/openlines/sessions/search: у закрытой этим методом сессии поля status и closeReason равны spam.

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