SIP and Built-in Telephony: Overview of Methods

This section describes the workflow for working with built-in telephony and the SIP connector in Bitrix24.

• Built-in telephony is the basic telephony mode in Bitrix24 for handling calls within the platform. Through the API in this mode, you can initiate calls, receive call events, manage outgoing lines, and configure users' SIP settings.
• The SIP connector is the integration mode of Bitrix24 with external SIP providers and PBXs. Through the API in this mode, you can create, update, and delete SIP connections for the application, check their registration status, and assign a default SIP line for outgoing calls.

Quick navigation: all methods and events

User documentation: How to choose and connect a SIP PBX in Bitrix24

How to Choose a SectionHow to Choose a Section

If you need	Open the section
React to the start and end of calls	Events
Manage SIP connections for the application	Managing SIP Connections
Manage default outgoing lines	Managing Lines
Retrieve user SIP settings and enable SIP devices	Managing Users

Interaction with Other ObjectsInteraction with Other Objects

User. To configure SIP settings for an employee, you need the user identifier USER_ID. You can obtain USER_ID using the user.get method.

SIP Connection. To work with external SIP configuration, you need the SIP connection configuration identifier CONFIG_ID. This identifier can be obtained in the response from voximplant.sip.add and in the list from voximplant.sip.get.

Outgoing Line. In outgoing call scenarios, the identifier for the outgoing line LINE_ID is used. You can obtain LINE_ID using the voximplant.line.get method.

Access PermissionsAccess Permissions

Access to telephony methods depends on the user's permissions and role in Bitrix24. If permissions are insufficient, the method will return an access error.

Specific permission requirements can be found in the description of each method.

How to Get StartedHow to Get Started

1. Choose what you will be working with: outgoing call, SIP connection, outgoing lines, user SIP settings, or call events.
2. For an outgoing call, use voximplant.callback.start, voximplant.infocall.startwithsound, or voximplant.infocall.startwithtext.
3. For a SIP scenario, create a connection using voximplant.sip.add, then check it using voximplant.sip.get and voximplant.sip.status.
4. Assign an outgoing line using voximplant.line.outgoing.set or voximplant.line.outgoing.sip.set. After voximplant.line.outgoing.set, verify the actual line using the voximplant.line.outgoing.get method.
5. To work with employees' SIP settings, use voximplant.user.get and voximplant.user.activatePhone.
6. Subscribe to events in the Events section if you need to handle the call lifecycle.

Overview of Methods and EventsOverview of Methods and Events

Scope: telephony

Who can execute methods: depending on the method

MainMain

Managing SIP ConnectionsManaging SIP Connections

Method	Description
voximplant.sip.add	Creates a SIP connection linked to the application
voximplant.sip.update	Updates an existing SIP connection
voximplant.sip.get	Returns a list of SIP connections created by the application
voximplant.sip.status	Returns the SIP registration status for the cloud PBX
voximplant.sip.delete	Deletes an existing SIP connection
voximplant.sip.connector.status	Returns the current status of the SIP connector

Managing LinesManaging Lines

Method	Description
voximplant.line.get	Returns a list of available outgoing lines
voximplant.line.outgoing.get	Returns the identifier of the current default outgoing line
voximplant.line.outgoing.set	Sets the default outgoing line
voximplant.line.outgoing.sip.set	Sets the default outgoing SIP line

Managing UsersManaging Users

Method	Description
voximplant.user.get	Returns user settings
voximplant.user.activatePhone	Sets the employee's SIP device presence flag