Initiate an Auto-Call with the Voice Automation Rule voximplant.infocall.startwithtext

Scope: telephony, call

Who can execute the method: a user with Outgoing Call — Execute access permission

The method voximplant.infocall.startwithtext initiates an auto-call and plays the specified text to the recipient using speech synthesis.

Method Parameters

Required parameters are marked with *

Name `type`	Description
FROM_LINE* `string`	Identifier of the outgoing line from which the call is initiated. A list of available lines can be obtained using the voximplant.line.get method.
TO_NUMBER* `string`	The number to which the call should be made.
TEXT_TO_PRONOUNCE* `string`	The text that will be spoken to the recipient.
VOICE `string`	Identifier of the voice for speech synthesis. If not provided, the default voice for the portal's language will be used. A list of available voices can be obtained using the voximplant.tts.voices.get method.

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 '{"FROM_LINE":"reg151083","TO_NUMBER":"+19991234567","TEXT_TO_PRONOUNCE":"Good afternoon. This is a reminder for your appointment."}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.infocall.startwithtext

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FROM_LINE":"reg151083","TO_NUMBER":"+19991234567","TEXT_TO_PRONOUNCE":"Good afternoon. This is a reminder for your appointment.","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.infocall.startwithtext

try
        {
            const response = await $b24.callMethod(
                'voximplant.infocall.startwithtext',
                {
                    FROM_LINE: 'reg151083',
                    TO_NUMBER: '+19991234567',
                    TEXT_TO_PRONOUNCE: 'Good afternoon. This is a reminder for your appointment.'
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.infocall.startwithtext',
                    [
                        'FROM_LINE' => 'reg151083',
                        'TO_NUMBER' => '+19991234567',
                        'TEXT_TO_PRONOUNCE' => 'Good afternoon. This is a reminder for your appointment.',
                    ]
                );
        
            $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.startwithtext',
            {
                FROM_LINE: 'reg151083',
                TO_NUMBER: '+19991234567',
                TEXT_TO_PRONOUNCE: 'Good afternoon. This is a reminder for your appointment.'
            },
            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.startwithtext',
            [
                'FROM_LINE' => 'reg151083',
                'TO_NUMBER' => '+19991234567',
                'TEXT_TO_PRONOUNCE' => 'Good afternoon. This is a reminder for your appointment.',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "RESULT": true,
                "CALL_ID": "infocall.4aa8f8e35bb6ece352fec0537b58ac42.1773740701"
            },
            "time": {
                "start": 1773740709,
                "finish": 1773740710.094622,
                "duration": 1.0946218967437744,
                "processing": 1,
                "date_start": "2026-03-17T12:45:09+01:00",
                "date_finish": "2026-03-17T12:45:10+01:00",
                "operating_reset_at": 1773741309,
                "operating": 0.14156007766723633
            }
        }

Returned Data

Name `type`	Description
result `object`	Object containing the result of the auto-call initiation.
RESULT `boolean`	Indicator of successful initiation. `true` — auto-call successfully initiated.
CALL_ID `string`	Identifier of the call.
time `time`	Information about the request execution time.

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_CORE",
            "error_description": "Infocall limit for this month is exceeded"
        }

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

Code	Description	Value
`ERROR_CORE`	`Making infocall using LINK_BASE_NUMBER is not allowed`	Auto-call cannot be initiated through a service line.
`ERROR_CORE`	`Could not find config for number <LINE_ID>`	Configuration for the specified line not found.
`ERROR_CORE`	`Infocall limit for this month is exceeded`	Monthly limit for auto-calls exceeded.
`ERROR_CORE`	`Phone number is not correct`	Invalid number in `TO_NUMBER`.
`ERROR_CORE`	`Infocall failure`	Error while initiating the auto-call.
`ACCESS_DENIED`	`Access denied`	Insufficient permissions to make outgoing calls.

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

Make an Auto-Call with MP3 Playback

Get a List of Available Voices for Text-to-Speech

Initiate an Auto-Call with the Voice Automation Rule voximplant.infocall.startwithtext

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