Осуществить автозвонок с проигрыванием MP3-файла voximplant.infocall.startwithsound

Scope: telephony, call

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

Метод voximplant.infocall.startwithsound запускает автозвонок и воспроизводит MP3-файл по URL.

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

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

Название
тип

Описание

FROM_LINE*
string

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

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

TO_NUMBER*
string

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

URL*
string

Ссылка на MP3-файл, который нужно проиграть во время звонка

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FROM_LINE":"reg151083","TO_NUMBER":"79991234567","URL":"https://example.com/sound/notice.mp3"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.infocall.startwithsound
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FROM_LINE":"reg151083","TO_NUMBER":"79991234567","URL":"https://example.com/sound/notice.mp3","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.infocall.startwithsound
        
try
        {
            const response = await $b24.callMethod(
                'voximplant.infocall.startwithsound',
                {
                    FROM_LINE: 'reg151083',
                    TO_NUMBER: '79991234567',
                    URL: 'https://example.com/sound/notice.mp3'
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.infocall.startwithsound',
                    [
                        'FROM_LINE' => 'reg151083',
                        'TO_NUMBER' => '79991234567',
                        'URL' => 'https://example.com/sound/notice.mp3',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'voximplant.infocall.startwithsound',
            {
                FROM_LINE: 'reg151083',
                TO_NUMBER: '79991234567',
                URL: 'https://example.com/sound/notice.mp3'
            },
            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.infocall.startwithsound',
            [
                'FROM_LINE' => 'reg151083',
                'TO_NUMBER' => '79991234567',
                'URL' => 'https://example.com/sound/notice.mp3',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "RESULT": true,
                "CALL_ID": "infocall.e51f04feaf1b58fb5dc6ee9d03d98fea.1773740145"
            },
            "time": {
                "start": 1773740189,
                "finish": 1773740189.20988,
                "duration": 0.20988011360168457,
                "processing": 0,
                "date_start": "2026-03-17T12:36:29+03:00",
                "date_finish": "2026-03-17T12:36:29+03:00",
                "operating_reset_at": 1773740789,
                "operating": 0.13379693031311035
            }
        }

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

Название
тип

Описание

result
object

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

RESULT
boolean

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

true — автозвонок успешно запущен

CALL_ID
string

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

time
time

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

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

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

{
            "error": "ERROR_CORE",
            "error_description": "Could not find config for number reg000000"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ERROR_CORE

Making infocall using LINK_BASE_NUMBER is not allowed

Нельзя запускать автозвонок через служебную линию

ERROR_CORE

Could not find config for number <LINE_ID>

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

ERROR_CORE

Infocall limit for this month is exceeded

Превышен месячный лимит автозвонков

ERROR_CORE

Phone number is not correct

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

ERROR_CORE

Infocall failure

Ошибка при запуске автозвонка

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

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

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

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

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

Предыдущая
Запустить обратный звонок
Следующая
Осуществить автозвонок голосовым роботом