Using SIP and Built-in Telephony

We are still updating this page

Some data may be missing — we will complete it soon.

When creating applications, keep in mind that methods are available to users according to the specified access permissions. The required permission level is indicated in the method description.

voximplant.callback.start

Initiates a callback

voximplant.infocall.startwithsound

Makes a call to the specified number while playing an mp3 file from a URL

voximplant.infocall.startwithtext

Makes a call to the specified number with automatic reading of the given text

voximplant.tts.voices.get

Retrieves an array of available voices for speech synthesis

voximplant.url.get

Retrieves a set of links for navigation through telephony pages

Event

Triggered

OnVoximplantCallInit

When a call is initialized (incoming or outgoing call begins).

OnVoximplantCallStart

When the conversation starts (operator answers an incoming call or subscriber answers an outgoing call).

OnVoximplantCallEnd

When the conversation ends (recorded in history).

User Management

voximplant.user.activatePhone

Sets the presence of a SIP device for an employee

voximplant.user.get

Retrieves user settings

Managing SIP Connections

voximplant.sip.add

Creates a new SIP line linked to the application

voximplant.sip.connector.status

Retrieves the current status of the SIP Connector

voximplant.sip.delete

Deletes an existing SIP line

voximplant.sip.get

Retrieves a list of all SIP lines created by the application

voximplant.sip.status

Retrieves the current status of SIP registration (for cloud PBXs only)

voximplant.sip.update

Modifies an existing SIP line

Managing Lines

voximplant.line.get

Retrieves a list of all available outgoing lines

voximplant.line.outgoing.get

Retrieves the currently selected line as the default outgoing line

voximplant.line.outgoing.set

Sets the selected line as the default outgoing line

voximplant.line.outgoing.sip.set

Sets the selected SIP line as the default outgoing line