Documentation

voximplant.sip.add

Scope: catalog Permissions to execute: for all

Creates a new SIP line linked to the application. Once created, this line becomes an outbound line by default.

This method is available to the user with granted access permissions for Manage numbers - Edit - Any.

Example

BX24.callMethod(
	'voximplant.sip.add',
	{
		"TYPE": "cloud",
		"TITLE": "sipnet",
		"SERVER": "sipnet.ru",
		"LOGIN": "YYYYY",
		"PASSWORD": "ZZZZZ"
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.info(result.data());
	}
);

Parameters

Parameter Description
TYPE PBX type (see List of PBX Types, optional parameter; by default: cloud hosted PBX)
TITLE Connection title.
SERVER SIP registration server address.
LOGIN Server login.
PASSWORD Server password.

Result Description

Parameters Description
CONFIG_ID SIP line setup identifier.
TYPE PBX type (see List of PBX Types).
TITLE Connection title.
SERVER SIP registration server address for cloud hosted PBX or server address for office PBX.
LOGIN Server login.
PASSWORD Server password.
REG_ID SIP registration identifier (for cloud hosted PBX only).
INCOMING_SERVER Server address for connection in case of outbound call (for cloud hosted PBX only).
INCOMING_LOGIN Connection login (for cloud hosted PBX only).
INCOMING_PASSWORD Connection password (for cloud hosted PBX only).

Specific Error Codes

Code Description
MAX_CLOUD_PBX You cannot connect more than 5 cloud hosted PBX.
TITLE_EXISTS A line with this title already exists.


© «Bitrix24», 2001-2024
Up