Действия оператора и своя пауза

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

Битрикс24 API: imopenlines.operator.* Скоуп: imopenlines

От чьего имени выполняется действие

Параметра «сотрудник» у этих методов нет. Действие и пауза относятся к сотруднику, от имени которого идёт вызов:

Права на действие проверяются по этому сотруднику. Все методы, кроме чтения паузы, требуют ключа с разрешённой записью.

Идентификатор чата

Методы принимают chatId — числовой идентификатор чата Открытой линии, например 5255. Это не dialogId вида chat5255 и не sessionId. Один чат проходит через несколько сессий, и действие применяется к текущей сессии чата.

Где взять chatId:

• Поле chatId в ответе POST /v1/openlines/sessions/search.
• POST /v1/openlines/sessions/open — по коду клиента в коннекторе.
• GET /v1/openlines/crm/chats — по карточке CRM.

Типовой сценарий

1. Найти чат клиента: POST /v1/openlines/sessions/search по линии или POST /v1/openlines/sessions/open по коду клиента.
2. Взять диалог себе: POST /v1/openlines/sessions/start. Сотрудник, от имени которого идёт вызов, становится оператором сессии.
3. Передать диалог коллеге или в очередь линии: POST /v1/openlines/operator/transfer.
4. Завершить диалог, который ведёт другой оператор: POST /v1/openlines/operator/finish-another.

Пропустить диалог

POST /v1/openlines/operator/skip

Отказывается от диалога Открытой линии, предложенного сотруднику: диалог возвращается в очередь линии.

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

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

Примеры

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

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

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

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

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

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

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

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

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

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

Поля ответа

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

{
  "success": true,
  "data": {
    "chatId": 5255,
    "skipped": true
  }
}

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

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

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

Ошибки

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

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

• Действия оператора и своя пауза
• Передать диалог
• Поиск сессий
• Открытые линии