## Transfer a dialog

`POST /v1/openlines/operator/transfer`

Transfers the current session of an Open Channel chat to another employee or to the channel queue.

The action runs on behalf of the employee the key belongs to — see [On whose behalf the action runs](/docs/openlines/operator#on-whose-behalf-the-action-runs).

## Request fields (body)

| Field | Type | Required | Description |
|------|-----|:-----:|----------|
| `chatId` | number \| string | yes | Open Channel chat identifier, a positive integer. A string is accepted if it consists of digits only and does not start with zero. See [Chat ID](/docs/openlines/operator#chat-id) |
| `userId` | number \| string | no | ID of the employee the dialog is transferred to. List: [`GET /v1/users`](/docs/entities/users/list) |
| `queueId` | number \| string | no | ID of the channel whose queue receives the dialog. List: [`GET /v1/openline-configs`](/docs/openlines/config/list) |
| `transferId` | number \| string | no | The target as a single value: a `queue<id>` string targets a channel queue, for example `queue59`. A number or a digit string targets an employee by ID |

Pass exactly one of `userId`, `queueId` and `transferId`.

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl -X POST https://vibecode.bitrix24.com/v1/openlines/operator/transfer \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": 5255,
    "userId": 1295
  }'
```

### JavaScript — personal key

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

const { success, data, error } = await res.json()
if (!success) throw new Error(`${error.code}: ${error.message}`)
console.log('Transferred:', data.transferred)
```

### JavaScript — OAuth application

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

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | `true` on a successful transfer |
| `data.chatId` | number | Chat identifier from the request. A string from the request is returned as a number |
| `data.transferred` | boolean | Always `true` |

## Response example

```json
{
  "success": true,
  "data": {
    "chatId": 5255,
    "transferred": true
  }
}
```

## Error response example

400 — more than one target passed:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Pass exactly one target: userId, queueId or transferId"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_CHAT_ID` | `chatId` is missing, is not a positive integer, is a string with non-digit characters or a leading zero, or is greater than 9007199254740991 |
| 400 | `INVALID_PARAMS` | No target passed, more than one target passed, or the target value is neither a positive integer nor a `queue<id>` string |
| 404 | `ENTITY_NOT_FOUND` | No chat with this `chatId` |
| 422 | `BITRIX_ERROR` | Bitrix24 refused the transfer. Its code is returned in `error.b24Code`. `OPERATOR_WRONG` with the text `You can not redirect to this operator` is returned in two cases: the target is the employee the call runs as, or there is no chat with this `chatId` |
| 403 | `BITRIX_ACCESS_DENIED` | The employee the call runs as has no permission for the action |
| 502 | `OPENLINE_OPERATOR_FAILED` | Bitrix24 neither confirmed the transfer nor returned an error |
| 403 | `SCOPE_DENIED` | The key has no `imopenlines` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | The key is not recognized |
| 401 | `TOKEN_MISSING` | A personal key has no access to the Bitrix24 portal, or an application key was sent without a session token in `Authorization` |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or the connection to it broke before the response was complete |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

- **A transfer to an employee keeps the session.** The session identifier stays the same while its operator changes, and the `queueTransfers` counter in the [session list](/docs/openlines/sessions/search) increases by one.
- **A transfer to a queue opens a new session.** After a transfer by `queueId` or by a `transferId` of the form `queue<id>`, the chat continues in a new session with the status `new` and no operator. Find its identifier in the [session list](/docs/openlines/sessions/search) by `chatId`.

## See also

- [Operator actions and my pause](/docs/openlines/operator)
- [Reassignment history](/docs/openlines/sessions/transfers)
- [Session search](/docs/openlines/sessions/search)
- [Open Channel configurations](/docs/openlines/config)
