Documentation

voximplant.sip.get

Scope: catalog Permissions to execute: for all

Returns the list of all SIP lines created by the application. It is a list method.

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

Example

BX24.callMethod(
	'voximplant.sip.get',
	{
		"FILTER": {"CONFIG_ID":12},
		"SORT": "CONFIG_ID",
		"ORDER": "DESC",
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.info(result.data());
	}
);

Parameters

Parameter Description
FILTER Fields for sorting.
SORT Field to sort by.
ORDER Sort order (ASC/DESC).
All parameters are optional

Result description

Parameter Description
CONFIG_ID SIP line setup ID.
TYPE PBX type (see List of PBX Types).
TITLE Connection title.
SERVER SIP registration server address.
LOGIN Server login.
PASSWORD Server password.
REG_ID SIP registration ID (for cloud hosted PBX only).
INCOMING_SERVER Server address for connection in case of an 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).

© «Bitrix24», 2001-2024
Up