Documentation
New REST documentation is now available. Detailed descriptions, more listed examples and a convenient search feature.
Go

voximplant.infocall.startwithtext

Scope: catalog Permissions to execute: for all

This method performs the call to the specified number with automatic voiceover of specified text is available the user with granted access permission for the Outbound call - Action - Any.

To obtain access to the method, application should request the access permission for the Call. The right is specified during installation of the application.

Function parameters

ParameterDescription
FROM_LINE ID of the line, from which the call will be made. The list of available lines can be retrieved by the voximplant.line.get method.
TO_NUMBER Number to be called.
TEXT_TO_PRONOUNCE Text for voiceover.
VOICE Voice to be used for voiceover of this text (optional). List of voices can be retrieved by the voximplant.tts.voices.get method.

Example

BX24.callMethod(
	'voximplant.infocall.startwithtext',
	{
		"FROM_LINE": "reg1332",
		"TO_NUMBER": "7911xxxxxxx",
		"PRONOUNCE": "Good afternoon. Your request is completed",
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.info(result.data());
	}
);


© «Bitrix24», 2001-2024