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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type CallbackStartResult = {
  RESULT: boolean
  CALL_ID: string
}

try {
  const response = await $b24.actions.v2.call.make<CallbackStartResult>({
    method: 'voximplant.callback.start',
    params: {
      FROM_LINE: 'reg151083',
      TO_NUMBER: '79991234567',
      TEXT_TO_PRONOUNCE: 'You have received a callback request',
      VOICE: 'ruinternalfemale',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.CALL_ID, result.RESULT)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function startCallback() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'voximplant.callback.start',
        params: {
          FROM_LINE: 'reg151083',
          TO_NUMBER: '79991234567',
          TEXT_TO_PRONOUNCE: 'You have received a callback request',
          VOICE: 'ruinternalfemale',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.CALL_ID, result.RESULT)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', startCallback)
</script>
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "voximplant.callback.start", b24.Params{
	"FROM_LINE":         "reg151083",
	"TO_NUMBER":         "79991234567",
	"TEXT_TO_PRONOUNCE": "Вам поступил запрос на обратный звонок",
	"VOICE":             "ruinternalfemale",
})
if err != nil {
	return fmt.Errorf("voximplant.callback.start: %w", err)
}

var item struct {
	Result bool   `json:"RESULT"`
	CallID string `json:"CALL_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result, item.CallID)

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

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

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

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