voximplant.sip.status

Scope: catalog Permissions to execute: for all

Returns the current status of the SIP registration (for cloud hosted PBX only).

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

Parameters

Parameter	Description
REG_ID	SIP registration identifier.

Result description

Code	Description
REG_ID	SIP registration identifier.
LAST_UPDATED	Date of the last change of SIP registration.
ERROR_MESSAGE	Error code textual description.
STATUS_CODE	Error numeric code.
STATUS_RESULT	SIP registration status (see Status Table).

Example

BX24.callMethod(
	"voximplant.sip.status",
	{
		"REG_ID": 5505,
	},
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		 else
			console.info(result.data());
	}
);