voximplant.callback.start
Запустить обратный звонок
Описание
Метод 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.voximplant.callback.start(
from_line='reg151083',
to_number='79991234567',
text_to_pronounce='Вам поступил запрос на обратный звонок',
voice='ruinternalfemale',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// 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
{
"error": "ERROR_CORE",
"error_description": "Could not find line reg000000"
}
| Код | Описание | Значение |
|---|---|---|
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 |
Недостаточно прав на выполнение исходящих звонков |

