VoxEngine

Functions

addEventListener

Adds a handler for the specified AppEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: AppEvents | T, callback: (event: _AppEvents[T]) => any): void

Parameters

allowWebSocketConnections

Allows accepting incoming connections to ensure WebSocket bidirectional exchange.

1
allowWebSocketConnections(): void

callConference

Makes a call to a conference via Conference module. If there is no such conference, it is created in the first method’s call. The method is designed to be called in a simple incoming scenario, then it can trigger another special scenario which contains logic of the conference. The method can trigger the Failed event in 60 sec, see the session limits for details.

1
callConference(conferenceId: string, callerid: string, displayName: string, headers?: { [header: string]: string }, scheme?: string): Call

Parameters

callPSTN

Starts an outgoing call to the specified phone number. Calls that are more expensive than 20 cents per minute and calls to Africa are blocked by default for security reasons. The method can trigger the CallEvents.Failed event in 60 sec, see the session limits for details.

1
callPSTN(number: string, callerid: string, parameters?: CallPSTNParameters): Call

Parameters

callSIP

Starts an outgoing call to the external SIP system or to another user of the same application. Supported codecs are: G.722, G.711 (u-law and a-law), Opus(https://opus-codec.org/), ILBC(https://webrtc.org/license/ilbc-freeware/), H.264, VP8(https://tools.ietf.org/html/rfc6386). The method can trigger the CallEvents.Failed event in 60 sec, see the session limits for details.

1
callSIP(to: string, parameters?: CallSIPParameters): Call

Parameters

callUser

Starts an outgoing call to the specified Voximplant user. The JavaScript scenario that uses this method and user being called should be both associated with the same Voximplant application. The method can trigger the CallEvents.Failed event in 60 sec, see the session limits for details.

1
callUser(parameters: CallUserParameters): Call

Parameters

callUserDirect

Start an outgoing call to the specified Voximplant user in peer-to-peer mode. The JavaScript scenario with this method and the destination user should be both within the same Voximplant application. Audio playback and recording does not work. P2P mode is available only for calls between SDKs. The method can trigger the CallEvents.Failed event in 60 sec, see the session limits for details. IMPORTANT: calling this method makes impossible to use the non-P2P mode for a new call and specified incomingCall. So the following methods cannot be used: Call.say, Call.sendDigits, Call.sendMediaTo, Call.stopMediaTo.

1
callUserDirect(incomingCall: Call, username: string, parameters: CallUserDirectParameters): Call

Parameters

callWhatsappUser

Starts an outgoing call to the specified WhatsApp user. This method requires a WhatsApp Business account. Read more in the WhatsApp Business-initiated calls article.

1
callWhatsappUser(parameters: CallWhatsappUserParameters): Call

Parameters

createASR

Creates a new ASR instance and starts recognition. You can attach sources later via the VoxMediaUnit sendMediaTo method. Add the following line to your scenario code to use the function:

require(Modules.ASR);

1
createASR(parameters: ASRParameters): ASR

Parameters

createConference

Creates a new Conference instance. You can attach media streams later via the Conference.sendMediaTo or VoxEngine.sendMediaBetween methods. Add the following line to your scenario code to use the function:

require(Modules.Conference);

1
createConference(parameters: ConferenceParameters): Conference

Parameters

createRecorder

Creates a new Recorder or ConferenceRecorder instance. You can attach sources later via the VoxMediaUnit sendMediaTo method. Add the following line to your scenario code to use the function:

require(Modules.Recorder);

1
createRecorder(parameters?: RecorderParameters): Recorder | ConferenceRecorder

Parameters

createSequencePlayer

Creates a new SequencePlayer instance. You can attach media streams later via the SequencePlayer.sendMediaTo or VoxEngine.sendMediaBetween methods.

1
createSequencePlayer(parameters: SequencePlayerParameters): SequencePlayer

Parameters

createStreamingAgent

Creates a new StreamingAgent instance. You can attach sources later via the VoxMediaUnit sendMediaTo method. Add the following line to your scenario code to use the function:

require(Modules.StreamingAgent);

1
createStreamingAgent(parameters: StreamingAgentParameters): StreamingAgent

Parameters

createToneScriptPlayer

Creates a new Player instance with the specified ToneScript(https://en.wikipedia.org/wiki/ToneScript) sequence. You can attach media streams later via the Player.sendMediaTo or VoxEngine.sendMediaBetween methods.

1
createToneScriptPlayer(script: string, parameters?: ToneScriptPlayerParameters): Player

Parameters

createTTSPlayer

Creates a new Player instance with the specified text (TTS is used to play the text). You can attach media streams later via the Player.sendMediaTo or VoxEngine.sendMediaBetween methods. If the text length exceeds 1500 characters, the PlayerEvents.PlaybackFinished event is triggered with error description. After the very first playing, a phrase is cached; each createTTSPlayer instance stores the cache data up to 2 weeks. Note that cache addresses only the URL, without additional headers. The cached phrase is available for all applications and further sessions.

1
createTTSPlayer(text: string, parameters?: TTSPlayerParameters): Player

Parameters

createURLPlayer

Creates a new Player instance with specified audio file URL. You can attach media streams later via the Player.sendMediaTo or VoxEngine.sendMediaBetween methods.

After the very first playback, a file is cached; each ‘createURLPlayer’ instance stores the cache data up to 2 weeks. Note that cache addresses only the URL, without additional headers. The cached file is available for all applications and further sessions.

File download has a timeout of 12 seconds. Reaching this timeout causes the “Timeout is reached” error. The supported file formats are: mp3, ogg, flac, and wav (mp3, speex, vorbis, flac, and wav codecs respectively). Maximum file size is 10 Mb.

You can attach media streams later via the Player.sendMediaTo or VoxEngine.sendMediaBetween methods. method etc. IMPORTANT: each call object can send media to any number of other calls (media units), but can receive only one audio stream. A new incoming stream always replaces the previous one.

1
createURLPlayer(request: URLPlayerRequest, parameters?: URLPlayerParameters): Player

Parameters

createWebSocket

Creates a new WebSocket instance. You can attach media streams later via the WebSocket.sendMediaTo or VoxEngine.sendMediaBetween methods.

1
createWebSocket(url: string, parameters?: WebSocketParameters): WebSocket

Parameters

customData

Set or get custom string associated with current JavaScript session. There are two kinds of the customData values: one is for JavaScript session (i.e., VoxEngine object), another is for the particular call (i.e., Call.customData and web SDK parameter of the method). It is possible to use them at the same time because they are independent entities. Remember that if you receive some value from web SDK, it does not overwrite the VoxEngine’s value. Any of customData’s type values can be later obtained from call history via management API or control panel.

1
customData(customData?: string): string

Parameters

destroyConference

Destroys an existing conference. Add the following line to your scenario code to use the function:

require(Modules.Conference);

1
destroyConference(conference: Conference): void

Parameters

disableStatisticsForIncomingWebsockets

Disables statistics for incoming WebSockets

1
disableStatisticsForIncomingWebsockets(): void

disableTraceForIncomingWebsockets

Disables trace for incoming WebSockets

1
disableTraceForIncomingWebsockets(): void

easyProcess

Adds all default event listeners to pass signaling information between two calls. The source code of the method is available on GitHub(https://github.com/voximplant/easyprocess).

1
easyProcess(call1: Call, call2: Call, onEstablishedCallback?: (call1: Call, call2: Call) => void, direct?: boolean): void

Parameters

enableStatisticsForIncomingWebsockets

Enables statistics for incoming WebSockets

1
enableStatisticsForIncomingWebsockets(): void

enableTraceForIncomingWebsockets

Enables trace for incoming WebSockets

1
enableTraceForIncomingWebsockets(): void

enqueueACDRequest

Adds a new request to the specified queue. The request is dispatched to the free agent according to the agent’s status (must be “Ready”) and skills. Add the following line to your scenario code to use the function:

require(Modules.ACD);

1
enqueueACDRequest(queueName: string, callerid: string, parameters?: ACDEnqueueParameters): ACDRequest

Parameters

enqueueTask

Appends the task to the SmartQueue.

1
enqueueTask(parameters: SmartQueueTaskParameters): SmartQueueTask

Parameters

forwardCallToPSTN

Helper function to forward an incoming call to PSTN. The method handles numbers only in the E.164 format by default. If you need to handle a number in another format, pass an additional function (as a parameter) to the method. For more details see the GitHub repo.

1
forwardCallToPSTN(numberTransform?: (number: string) => string, onEstablishedCallback?: (call1: Call, call2: Call) => void, options?: { callerid: string }): void

Parameters

forwardCallToSIP

Helper function to forward an incoming call to a dialed SIP URI. For more details see the GitHub repo.

1
forwardCallToSIP(onEstablishedCallback?: (call1: Call, call2: Call) => void, video?: boolean): void

Parameters

forwardCallToUser

Helper function to forward an incoming call to a user of the current application. Dialed number is considered as username. For more details see the GitHub repo.

1
forwardCallToUser(onEstablishedCallback?: (call1: Call, call2: Call) => void, video?: boolean): void

Parameters

forwardCallToUserDirect

Helper function to forward an incoming call to a user of the current application in the P2P mode. Dialed number is considered as username. Due to the P2P mode, media player and recording do not work. For more details see the GitHub repo.

1
forwardCallToUserDirect(onEstablishedCallback?: (call1: Call, call2: Call) => void): void

Parameters

getSecretValue

Gets a value of the secret stored in the Voximplant panel.

1
getSecretValue(name: string): string | undefined

Parameters

playSoundAndHangup

Helper function to play sound to incoming call. It terminates a call in three cases:

1. playback is finished
2. call failed
3. call disconnected

1
playSoundAndHangup(fileURL: string): void

Parameters

removeEventListener

Removes a handler for the specified AppEvents event.

1
removeEventListener(event: AppEvents | T, callback?: (event: _AppEvents[T]) => any): void

Parameters

sendMediaBetween

Start sending media between mediaUnit1 and mediaUnit2. This method binds two audio/video streams.

1
sendMediaBetween(mediaUnit1: VoxMediaUnit, mediaUnit2: VoxMediaUnit): void

Parameters

stopMediaBetween

Stops sending media between mediaUnit1 and mediaUnit2.

1
stopMediaBetween(mediaUnit1: VoxMediaUnit, mediaUnit2: VoxMediaUnit): void

Parameters

terminate

Terminates the current JavaScript session. All audio/video streams are disconnected and scenario execution stops. Note that after this function, only the AppEvents.Terminating and AppEvents.Terminated events are triggered.

NOTE: if you are using this method inside a code block (e.g., an “if” block), it does not stop the execution of the current block. Use return; after using this method to exit the current code block.

1
terminate(): void