Documentation

voximplant.sip.update

Scope: catalog Permissions to execute: for all

Updates the existing SIP line (created by the application).

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

Parameters

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

One of the following fields is required for a successful call: TITLE, SERVER, LOGIN, PASSWORD.


Result description

Returns 1 in case of success or an exception.


Specific fault codes

Code Description
TITLE_EXISTS A line with this title already exists.

Example

BX24.callMethod(
	"voximplant.sip.update",
	{
		"CONFIG_ID": 69,
		"TITLE": "название линии",
	},
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
			console.info(result.data());
	}
);


© «Bitrix24», 2001-2024