Запустить обратный звонок voximplant.callback.start

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: telephony

Кто может выполнять метод: пользователь с правом Исходящий звонок — Выполнение

Метод voximplant.callback.start запускает обратный звонок между сотрудником и клиентом.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

FROM_LINE*
string

Идентификатор исходящей линии, с которой запускается обратный звонок.

Список доступных линий можно получить методом voximplant.line.get

TO_NUMBER*
string

Номер клиента, на который нужно позвонить

TEXT_TO_PRONOUNCE*
string

Текст, который система произнесет сотруднику перед соединением с клиентом

VOICE
string

Идентификатор голоса для синтеза речи.

Если не передан, используется голос по умолчанию для языка портала.

Список доступных голосов можно получить методом voximplant.tts.voices.get

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FROM_LINE":"reg151083","TO_NUMBER":"79991234567","TEXT_TO_PRONOUNCE":"Вам поступил запрос на обратный звонок","VOICE":"ruinternalfemale"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.callback.start
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FROM_LINE":"reg151083","TO_NUMBER":"79991234567","TEXT_TO_PRONOUNCE":"Вам поступил запрос на обратный звонок","VOICE":"ruinternalfemale","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.callback.start
        
try
        {
            const response = await $b24.callMethod(
                'voximplant.callback.start',
                {
                    FROM_LINE: 'reg151083',
                    TO_NUMBER: '79991234567',
                    TEXT_TO_PRONOUNCE: 'Вам поступил запрос на обратный звонок',
                    VOICE: 'ruinternalfemale'
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.callback.start',
                    [
                        'FROM_LINE' => 'reg151083',
                        'TO_NUMBER' => '79991234567',
                        'TEXT_TO_PRONOUNCE' => 'Вам поступил запрос на обратный звонок',
                        'VOICE' => 'ruinternalfemale',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'voximplant.callback.start',
            {
                FROM_LINE: 'reg151083',
                TO_NUMBER: '79991234567',
                TEXT_TO_PRONOUNCE: 'Вам поступил запрос на обратный звонок',
                VOICE: 'ruinternalfemale'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'voximplant.callback.start',
            [
                'FROM_LINE' => 'reg151083',
                'TO_NUMBER' => '79991234567',
                'TEXT_TO_PRONOUNCE' => 'Вам поступил запрос на обратный звонок',
                'VOICE' => 'ruinternalfemale',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "RESULT": true,
                "CALL_ID": "callback.72f42b118e019a4cc47629ff60525f43.1773736077"
            },
            "time": {
                "start": 1773736066,
                "finish": 1773736067.708955,
                "duration": 1.7089550495147705,
                "processing": 1,
                "date_start": "2026-03-17T11:27:46+03:00",
                "date_finish": "2026-03-17T11:27:47+03:00",
                "operating_reset_at": 1773736666,
                "operating": 0.9574570655822754
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
object

Объект с результатом запуска обратного звонка

RESULT
boolean

Признак успешного запуска.

true — обратный звонок успешно запущен

CALL_ID
string

Идентификатор звонка

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

{
            "error": "ERROR_CORE",
            "error_description": "Could not find line reg000000"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_CORE

Could not find line <LINE_ID>

Линия с указанным идентификатором не найдена

ERROR_CORE

Could not find config for number <LINE_ID>

Не найдена конфигурация для указанной линии

ERROR_CORE

Phone number is not correct

Некорректный номер в TO_NUMBER

ACCESS_DENIED

Access denied

Недостаточно прав на выполнение исходящих звонков

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение