Operator actions and my pause

Actions on an Open Channel dialog on behalf of the employee the key belongs to: skip a dialog, transfer it, mark the client as spam, finish another operator's dialog. This section also covers reading, starting and stopping your own operator pause.

Bitrix24 API: imopenlines.operator.* Scope: imopenlines

On whose behalf the action runs

These methods take no employee parameter. The action and the pause apply to the employee the call runs as:

Permissions for the action are checked against this employee. Every method except reading the pause requires a key with write access.

Chat ID

The methods take chatId, the numeric ID of the Open Channel chat, for example 5255. It is not a dialogId such as chat5255 and not a sessionId. One chat goes through several sessions, and the action applies to the chat's current session.

Where to get chatId:

• The chatId field in the POST /v1/openlines/sessions/search response.
• POST /v1/openlines/sessions/open — by the client's code in the connector.
• GET /v1/openlines/crm/chats — by a CRM card.

Typical scenario

1. Find the client's chat: POST /v1/openlines/sessions/search by channel, or POST /v1/openlines/sessions/open by the client's code.
2. Take the dialog yourself: POST /v1/openlines/sessions/start. The employee the call runs as becomes the session operator.
3. Transfer the dialog to a colleague or to the channel queue: POST /v1/openlines/operator/transfer.
4. Finish a dialog that another operator is handling: POST /v1/openlines/operator/finish-another.

Skip a dialog

POST /v1/openlines/operator/skip

Declines an Open Channel dialog offered to the employee: the dialog returns to the channel queue.

The action runs on behalf of the employee the key belongs to — see On whose behalf the action runs.

Request fields (body)

Examples

curl — personal key

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

curl — OAuth application

curl -X POST https://vibecode.bitrix24.com/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 — personal key

const res = await fetch('https://vibecode.bitrix24.com/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('Dialog skipped:', body.data.chatId)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/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('Dialog skipped:', body.data.chatId)

Response fields

Response example

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

Error response example

404 — no chat with this identifier:

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

Errors

Full list of common API errors — Errors.

See also

• Operator actions and my pause
• Transfer a dialog
• Session search
• Open Channels