Transfer a Dialogue to an Operator or Queue using imopenlines.bot.session.transfer

Scope: imopenlines, imbot

Who can execute the method: application user with a registered chat bot

The method imopenlines.bot.session.transfer transfers a dialogue from the chat bot in an open line to a specified operator or queue.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CHAT_ID* `integer`	The identifier of the chat whose dialogue needs to be transferred. The chat identifier can be obtained using the methods imopenlines.dialog.get or imopenlines.crm.chat.get
USER_ID `integer`	The identifier of the employee to whom the dialogue should be transferred. The user identifier can be obtained using the methods user.get or user.search
QUEUE_ID `integer`	The identifier of the queue to which the dialogue should be transferred. Pass the value of the `ID` field from the response of the method imopenlines.config.list.get. The `QUEUE` field from the response of imopenlines.config.list.get contains `USER_ID` of the queue employees and is not suitable as `QUEUE_ID`
TRANSFER_ID `string`\|`integer`	Universal transfer destination parameter. Allowed formats: `USER_ID` of the employee or the string `queue<QUEUE_ID>`. The user identifier can be obtained using the methods user.get and user.search, and the queue identifier can be obtained using the method imopenlines.config.list.get
LEAVE `boolean`	Flag indicating the presence of the chat bot in the dialogue after the transfer. Allowed values: `Y` — the bot leaves the chat immediately `N` — the bot remains until the transfer is confirmed By default, `N` is used

It is recommended to pass only one destination parameter: USER_ID, QUEUE_ID, or TRANSFER_ID. If multiple parameters are passed simultaneously, the method uses the following priority: USER_ID -> QUEUE_ID -> TRANSFER_ID. When passing TRANSFER_ID, the method converts it to USER_ID or QUEUE_ID.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"USER_ID":12,"LEAVE":"N"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.bot.session.transfer

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"USER_ID":12,"LEAVE":"N","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.bot.session.transfer

try {
          const response = await $b24.callMethod('imopenlines.bot.session.transfer', {
            CHAT_ID: 112,
            USER_ID: 12,
            LEAVE: 'N',
          });
        
          const { result } = response.getData();
          console.log('Session transferred:', result);
        } catch (error) {
          console.error('Error transferring session:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.bot.session.transfer',
                    [
                        'CHAT_ID' => 112,
                        'USER_ID' => 12,
                        'LEAVE' => 'N',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Session transferred: ' . var_export($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error transferring session: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imopenlines.bot.session.transfer',
            {
                CHAT_ID: 112,
                USER_ID: 12,
                LEAVE: 'N',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.bot.session.transfer',
            [
                'CHAT_ID' => 112,
                'USER_ID' => 12,
                'LEAVE' => 'N',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Session transferred: ' . var_export($result['result'], true);
        }

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1728626400.456,
                "finish": 1728626400.539,
                "duration": 0.083,
                "processing": 0.031,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Contains `true` if the dialogue was successfully transferred
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error": "TRANSFER_ID_EMPTY",
            "error_description": "Queue ID or User ID can't be empty"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`CHAT_ID_EMPTY`	Chat ID can't be empty	`CHAT_ID` not provided or value `<= 0`
`400`	`USER_ID_EMPTY`	User ID can't be empty	`USER_ID` provided with an empty value or value `<= 0`
`400`	`QUEUE_ID_EMPTY`	QUEUE ID can't be empty	`QUEUE_ID` provided with an empty value or value `<= 0`
`400`	`TRANSFER_ID_EMPTY`	Queue ID or User ID can't be empty	Neither `USER_ID` nor `QUEUE_ID` provided, and `TRANSFER_ID` not set
`400`	`BOT_ID_ERROR`	Bot not found	No registered chat bot found in the application
`400`	`OPERATOR_WRONG`	You cannot redirect to this operator	Transfer to the specified operator or queue is not available
`403`	`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization	Method called with session authorization for which it is prohibited

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Switch the Dialogue to an Available Operator

End the Dialogue

Transfer a Dialogue to an Operator or Queue using imopenlines.bot.session.transfer

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning