Adapter - NEC SV95 Commands

This page describes version 2.0.3 of the adapter.

Overview

This adapter provides a minimal set of MAT commands necessary for assigning, deleting and modifying IP stations in an NEC SV95 PBX. The adapter connects directly to the PBX MAT Port. Please refer to the SV95 MAT Command Manual for command parameter details.

Important

Avoid sending an excessive amount of traffic to the SV9500 system. Workflows that wait for the previous command to complete before executing subsequent commands are recommended. Additionally, the SV9500 should receive no more than 3 queries per second.

IP Station Assignment

Assigning an an IP station typically requires the following commands:

ASDT - Assignment of Station Data
AISTL - Assignment of IP Station Data
ALGSN - Assignment of Logical Number Data
ANDD - Assignment of Name Display Data (optional)
AKYD - Assignment of Key Data (optional)
ADKS - Assignment of Key DTERM Key Status Data

IP Station Deletion

Deleting an an IP station must be done in the reverse order of assignment.

Note

Performing an AISTL Get or Listup on an IP Station before deletion is recommended.  The results of the command contain 'dtf' parameters that indicate other data associated with the station that requires deletion before deleting the IP Station.

The following AISTL GET Results indicates that KD (key data), ND (name display), LNN (logical network number) data are assigned to this station and must be deleted before running AISTL Delete:

AISTL Result:
tn: 1
ip_stn: 25861
tec: 12
**dtf[0]: KD**
**dtf[1]: ND**
**dtf[2]: LNN**
**dtf.count: 3**
kind: 1
ug50_multislot_mode: 0
rsc: 1
sfc: 1
lens: 070134

Below is a list of 'dtf' parameters that indicate what other commands are associated with the IP station

DTF	Description	Supported	Command
KD	Key Data	yes	AKYD
CG	Call Pickup Group
CE	Call Pickup Expand Group
HC	Station Circular Hunting Group
HP	Station Pilot Hunting Group
HU	Station UCD Hunting Group
PH	Phantom Station Data
HL	Hot Line Station Data
ND	Name Display Data	yes	ANDD
NS	Night Station
D1	DTE Attribute Data1
D2	DTE Attribute Data2
IC	Intercom Line Data
SS	Secretary Station Data
WS	Wireless Station Data
IT	ISDN Terminal Data
LNL	Logical Number Data of LDM
LNN	Logical Number Data of NDM	yes	ALGSN
RIC	Reserved of Data for IP Devices Connection

Note: Commands not supported in this adapter must use the SV95 PC-PRO Terminal to assign/delete data.

AKYD Command Notes

The AKYD_GET command returns key data for a station both as flattened (keyDataJson) and unflattened (keyData) formats as shown in this AKYD_GET result. The keyDataJson parameter for a station can be modified in a workflow and then passed directly into the keyDataJson parameter of an AKYD_SET command. The key data for a new station can be assigned using either the keyDataJson parameter OR the keyData array parameter.

When using the key data in an array parameter instead of the keyDataJson parameter, the key data for each key item property is input via the web interface as show below:

keydataselect

Note: If both keyDataJson and keyData parameters are present the keyDataJson is used.

Errors

Below are examples of error codes that may be returned when running a MAT command. Please, refer to the SV95 PBX Command Manual for details and other possible errors:

code: ^2400Pbx:CdlError0001
error: There is no data.

code: ^2400Pbx:CdlError0A22
error: Telephone number is not assigned yet.

code: ^2400Pbx:CdlError0201
error: Station/Trunk is not assigned yet.

Commands

This adapter implements the following commands. Please, contact your provider if you have any questions.

Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
pbxAddress	IP-Address	True	The IP address of the SV95 PBX system.	string				1024	1
pbxPort	Port	True	The SV95 port assigned as the MAT.	integer	60000	65535	1
username	Username	False	The username used to login to the SV95's MAT.	string				1024	1
password	Password	False	The password for the user to login to the SV95's MAT.	password				1024
fpc	Fusion Point Code	False	The Fusion Point Code number assigned to this connection. (Optional)	integer	0	1023	0
multipleMode	API Mode	False	Enable or not the multiple pbx mode. default is disable. (Optional)	boolean	false

Commands

AISTL-Get IP Station Data (aistlGet)

Gets the IP Station data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station.	False	string
ip_stn	IP Station Number	The IP Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
tn	The tenant number.	string
ip_stn	The IP-Station number.	string
tec	The telephone equipment class identification.	string
dtf	An array of DTF flags set for a station.	array
ug50_multislot_mode	Set to true if the terminal uses multi-slot mode for UG50.	string
rsc	The restriction class value set for the terminal.	string
sfc	The service feature class value set for the terminal.	string
lens	The line equipment number location for the terminal.	string
mc_id	The ID for the MC.	string
mc_ch	The channel number for the MC.	string
sip_vpsno	The SIP VPS number.	string
sip_vpsch	The SIP VPS channel number.	string
ip_vpsno	The IP VPS number.	string
ip_vpsch	The IP VPS Channel Number.	string
fax.jit_siz	The jitter buffer size for fax.	string
fax.pay_typ1	The first payload type setting for fax.	string
fax.pay_typ2	The second payload type setting for fax.	string
fax.pay_typ3	The third payload type setting for fax.	string
fax.pay_typ4	The fourth payload type setting for fax.	string
fax.pay_siz1	The first payload size setting for fax.	string
fax.pay_siz2	The second payload size setting for fax.	string
fax.pay_siz3	The third payload size setting for fax.	string
fax.pay_siz4	The fourth payload size setting for fax.	string
hotel.station_type	The station type for a hotel station. (admin, guest, other)	string
hotel.room_class	The room class setting for the hotel station.	string
hotel.annex	The ANNEX value for the hotel room.	string
hotel.ground	Hotel room ground/underground settings. (Ground=0 Underground=1)	string
hotel.floor	Hotel room floor setting.	string

AISTL-Set IP Station Data (aistlSet)

Sets the IP Station data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
kind	Kind of IP Station	The kind of IP Station to assign.	True	string
ug50_multislot_mode	UG50 Multi-Slot Mode	Set to true if the terminal uses multi-slot mode for UG50.	False	string
lens	Line Equipment Number	The line equipment number location for the terminal.	True	string
mc_id	MC Identifier (MAC Address)	The ID for the MC.	False	string
mc_ch	MC Channel Number	The channel number for the MC.	False	string
sip_vpsno	SIP VPS Number	The SIP VPS number.	False	string
sip_vpsch	SIP VPS Channel Number	The SIP VPS channel number.	False	string
ip_vpsno	IP VPS Number	The IP VPS number.	False	string
ip_vpsch	IP VPS Channel Number	The IP VPS Channel Number.	False	string
jit_siz	Fax Jitter Buffer Size	The jitter buffer size for fax.	False	string
pay_typ1	Payload Type Selection 1	The first payload type setting for fax.	False	string
pay_typ2	Payload Type Selection 2	The second payload type setting for fax.	False	string
pay_typ3	Payload Type Selection 3	The third payload type setting for fax.	False	string
pay_typ4	Payload Type Selection 4	The fourth payload type setting for fax.	False	string
pay_siz1	Payload Size Selection 1	The first payload size setting for fax.	False	string
pay_siz2	Payload Size Selection 2	The second payload size setting for fax.	False	string
pay_siz3	Payload Size Selection 3	The third payload size setting for fax.	False	string
pay_siz4	Payload Size Selection 4	The fourth payload size setting for fax.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AISTL-Delete IP Station Data (aistlDel)

Delete IP Station Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the ip station.	False	string
ip_stn	IP Station Number	The IP Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AISTL-List IP Station Data (aistlList)

Lists the IP Station data for a range of Station Numbers.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Starting Tenant Number	The starting tenant number.	False	string
end_tn	Ending Tenant Number	The ending tenant number.	False	string
start_ip_stn	Starting IP Station Number	The starting station Number.	True	string
end_ip_stn	Ending IP Station Number	The ending station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
aistlList	An array of IP-Station data.	array
aistlList.tn	The tenant number.	string
aistlList.ip_stn	The IP-Station number.	string
aistlList.tec	The telephone equipment class identification.	string
aistlList.dtf	An array of DTF flags set for a station.	array
aistlList.ug50_multislot_mode	Set to true if the terminal uses multi-slot mode for UG50.	string
aistlList.rsc	The restriction class value set for the terminal.	string
aistlList.sfc	The service feature class value set for the terminal.	string
aistlList.lens	The line equipment number location for the terminal.	string
aistlList.mc_id	The ID for the MC.	string
aistlList.mc_ch	The channel number for the MC.	string
aistlList.sip_vpsno	The SIP VPS number.	string
aistlList.sip_vpsch	The SIP VPS channel number.	string
aistlList.ip_vpsno	The IP VPS number.	string
aistlList.ip_vpsch	The IP VPS Channel Number.	string
aistlList.fax.jit_siz	The jitter buffer size for fax.	string
aistlList.fax.pay_typ1	The first payload type setting for fax.	string
aistlList.fax.pay_typ2	The second payload type setting for fax.	string
aistlList.fax.pay_typ3	The third payload type setting for fax.	string
aistlList.fax.pay_typ4	The fourth payload type setting for fax.	string
aistlList.fax.pay_siz1	The first payload size setting for fax.	string
aistlList.fax.pay_siz2	The second payload size setting for fax.	string
aistlList.fax.pay_siz3	The third payload size setting for fax.	string
aistlList.fax.pay_siz4	The fourth payload size setting for fax.	string
aistlList.hotel.room_class	The room class setting for the hotel station.	string
aistlList.hotel.annex	The ANNEX value for the hotel room.	string
aistlList.hotel.ground	Hotel room ground/underground settings. (Ground=0 Underground=1)	string
aistlList.hotel.floor	Hotel room floor setting.	string

ASDT-Delete Station Data (asdtDel)

Delete Station Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the ip station.	False	string
stn	Station Number	Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASDT-Set Station Data (asdtSet)

Sets Station data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station.	False	string
stn	Station Number	Station Number.	True	string
tec	Telephone Equipment Class	The telephone equipment class identification.	True	string
rsc	Restriction Class	The restriction class value set for the terminal.	True	string
sfc	Service Feature Class	The service feature class value set for the terminal.	True	string
lens	Line Equipment Number	The line equipment number location for the terminal.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AGST-Delete Guest Station Data (agstDel)

Delete Guest Station Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the ip station.	False	string
stn	Guest Station Number	Guest Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AGST-Set Guest Station Data (agstSet)

Sets Guest Station data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station.	False	string
stn	Station Number	Station Number.	True	string
tec	Telephone Equipment Class	The telephone equipment class identification.	True	string
rsc	Restriction Class	The restriction class value set for the terminal.	True	string
sfc	Service Feature Class	The service feature class value set for the terminal.	True	string
lens	Line Equipment Number	The line equipment number location for the terminal.	False	string
room_class	Hotel Room Class	The room class setting for the hotel station.	False	string
annex	ANNEX	The ANNEX value for the hotel room.	False	string
ground	Ground or Underground	Hotel room ground/underground settings. (Ground=0 Underground=1)	False	string
floor	FLOOR	Hotel room floor setting.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AAST-Delete Admin Station Data (aastDel)

Delete Admin Station Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the ip station.	False	string
stn	Admin Station Number	Admin Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AAST-Set Admin Station Data (aastSet)

Sets Admin Station data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station.	False	string
stn	Admin Station Number	Admin Station Number.	True	string
tec	Telephone Equipment Class	The telephone equipment class identification.	True	string
rsc	Restriction Class	The restriction class value set for the terminal.	True	string
sfc	Service Feature Class	The service feature class value set for the terminal.	True	string
lens	Line Equipment Number	The line equipment number location for the terminal.	False	string
room_class	Hotel Room Class	The room class setting for the hotel station.	False	string
annex	ANNEX	The ANNEX value for the hotel room.	False	string
ground	Ground or Underground	Hotel room ground/underground settings. (Ground=0 Underground=1)	False	string
floor	FLOOR	Hotel room floor setting.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANDD-Get Name Display (anddGet)

Gets the Name Display setting for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station {1-63}. default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
name	The name that is assigned to the station number.	string
name_kanji	The name in KANJI that is assigned to the station number.	string

ANDD-Set Name Display (anddSet)

Sets the Name Display setting for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station {1-63}. default {1}.	False	string
stn	Station Number	The Station Number.	True	string
name	Display Name	The name to assign to the Station Number.	True	string
name_kanji	Display Name in KANJI	The name in KANJI to assign to the Station Number.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANDD-Delete Name Display (anddDel)

Delete the Name Display setting for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station {1-63}. default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPW-Get IP Station Password (aspwGet)

Gets the IP Station Password for a Telephone Number.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (NDM/LDM) (0/1).	True	string
ugn	User Group Number	The user group number for the telephone {1-255}.	False	string
teln	Telephone Number	The telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
password	The password that is assigned to the telephone number. 8~16 digits, (0~9, *, #)	string

ASPW-Set IP Station Password (aspwSet)

Sets the IP Station Password for a Telephone Number.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (NDM/LDM) (0/1).	True	string
ugn	User Group Number	The user group number for the telephone {1-255}.	False	string
teln	Telephone Number	The telephone Number.	True	string
password	Password	The password that is assigned to the telephone number. 8~16 digits, (0~9, *, #)	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPW-Lists IP Station Password (aspwList)

Lists the IP Station Password for a Telephone Number.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (NDM/LDM) (0/1).	True	string
start_ugn	Start User Group Number	The starting user group number for the telephone {1-255}.	False	string
end_ugn	End User Group Number	The ending user group number for the telephone.	False	string
start_teln	Start Telephone Number	The starting telephone Number.	True	string
end_teln	End Telephone Number	The ending telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
aspwListResponse.count	The count of stations.	string
aspwListResponse[0].ugn	The user group number for the telephone.	string
aspwListResponse[0].teln	The telephone Number.	string
aspwListResponse[0].password	The password that is assigned to the telephone number. 8~16 digits, (0~9, *, #)	string

ASPW-Delete IP Station Password (aspwDel)

Deletes the IP Station Password for a Telephone Number.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (NDM/LDM) (0/1).	True	string
ugn	User Group Number	The user group number for the telephone {1-255}.	False	string
teln	Telephone Number	The telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

DISD-Release IP Station (disdRelease)

Releases the IP Station.

Request Properties

Name	Display	Description	Is Required	Type
kind	Kind	The kind to be released (1/2/3) (DM/NDM/LDM)	True	string
tenantNumber	Tenant Number	The tenant number for the station. Applicable for kind=1	False	string
stationNumber	Station Number	The Station Number. Applicable for kind=1	False	string
userGroupNumber	User Group Number	The user group number for the telephone. Applicable for kind=2/3	False	string
telephoneNumber	Telephone Number	The telephone Number. Applicable for kind=2/3	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AKYD-Get Key Data (akydGet)

Get the Key Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station. {1-63}, default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
tn	The tenant for the station. {1-63}, default {1}	string
stn	The station number.	string
pri	The priority of the answering call. {0-4}, default {0}	string
pl_tn	The tenant of the prime line.{1-63}, default {1}	string
pl_stn	The station number of prime line.	string
s	The OG from prime line. {0-1} {0:Allowed/1:Inhibited}, default {0}	string
mwd	The message waiting data. {0-1} {0:MW Data Display on top line:/1:MW Data Display on bottom line}, default {0}	string
ln_pre	The line preference data. {0-1} {0:Prime line pickup/1:Line preference data are to be set on another buttons}, default {0}	string
spk	The line preference for speaker button, only when LN_PRE=1 {0-3}. {0:Prime line/1:Idle Line/2:Incoming Line/3:Ringing Line}	string
ans	The line preference for answer button, only when LN_PRE=1 {0-2}. {0:Prime line/1:Incoming Line/2:Ringing Line}	string
org	The line preference for Originating button, only when LN_PRE=1 {0-2}. {0:Prime line/1:Idle Line/2:Prime Line or Idle Line}	string
tp	The type of DTerm {0-5}	string
keyDataJson	The Key data as json.	string
flexKeyDataJson	The Flex Key data as json.	string
keyData.count	The count of keys.	string
keyData[0].kyn	The key number {1-40}	string
keyData[0].kyi	The service index {0-2}	string
keyData[0].fky	The function key number {1-320}, when KYI = 1	string
keyData[0].kd	The kind of line {0-4}, when KYI = 2	string
keyData[0].kd_tn	The tenant of the kind of line {1-63}, when KYI = 2 and KD =0/2	string
keyData[0].kd_stn	The station of the kind of line, when KYI = 2 and KD =0/2	string
keyData[0].rg	The ringing information for each line {0-7}, when KYI = 2 and KD =0/2	string
keyData[0].icm	The kind of intercom {0-2}, when KYI = 2 and KD = 1	string
keyData[0].g_id	The group id number {1-50}, when KYI = 2 and KD = 1	string
keyData[0].lens	The LENS - only when KYI = 2 and KD = 4	string
flexKeyData.count	The count of flex keys.	string
flexKeyData[0].kyi2	The service index - only when TP = 2/3/5, {0-1}	string
flexKeyData[0].kyn2	The key number 2 - only when TP = 2/3/5, {1-16}	string
flexKeyData[0].fky2	The function key number - only when TP =2/3/5 and KYI2 = 1, {1-320}	string

AKYD-Set Key Data (akydSet)

Sets the Key Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	tenant	The tenant for the station. {1-63}, default {1}	False	string
stn	Station Number	The station number	True	string
pri	Priority	The priority of the answering call. {0-4}, default {0}	False	string
pl_tn	Tenant Number of prime line	The tenant of the prime line.{1-63}, default {1}	False	string
pl_stn	Station Number of prime line	The station number of prime line.	True	string
s	OG	The OG from prime line. {0-1} {0:Allowed/1:Inhibited}, default {0}	False	string
mwd	Message Waiting Data	The message waiting data. {0-1} {0:MW Data Display on top line:/1:MW Data Display on bottom line}, default {0}	False	string
ln_pre	Line Preference	The line preference data. {0-1} {0:Prime line pickup/1:Line preference data are to be set on another buttons}, default {0}	False	string
spk	Line preference for Speaker button	The line preference for speaker button, only when LN_PRE=1 {0-3}. {0:Prime line/1:Idle Line/2:Incoming Line/3:Ringing Line}	False	string
ans	Line preference for Answer button	The line preference for answer button, only when LN_PRE=1 {0-2}. {0:Prime line/1:Incoming Line/2:Ringing Line}	False	string
org	Line preference for Originating button	The line preference for Originating button, only when LN_PRE=1 {0-2}. {0:Prime line/1:Idle Line/2:Prime Line or Idle Line}	False	string
tp	Type of Dterm	The type of DTerm {0-5}, default {0}	False	string
keyDataJson	keydata in JSON	The keydata as JSON, the JSON input takes precedence over the keyData as array input	False	string
flexKeyDataJson	flex keydata in json	The flex keydata as JSON, the JSON input takes precedence over the keyData as array input	False	string
keyData.count	count of keys	The count of keys (required when inputting via array).	False	string
keyData	keydata in array	The keydata as array	False	array
keyData[0].kyn	The Key number	The key number {1-40}	False	string
keyData[0].kyi	The service index	The service index {0-2}	False	string
keyData[0].fky	The function key number	The function key number {1-320}, when KYI = 1	False	string
keyData[0].kd	The Kind of line	The kind of line {0-4}, when KYI = 2	False	string
keyData[0].kd_tn	The tenant of the kind of line	The tenant of the kind of line {1-63}, when KYI = 2 and KD =0/2	False	string
keyData[0].kd_stn	The station of the kind of line	The station of the kind of line, when KYI = 2 and KD =0/2	False	string
keyData[0].rg	The ringing information for each line	The ringing information for each line {0-7}, when KYI = 2 and KD =0/2	False	string
keyData[0].icm	The kind of intercom	The kind of intercom {0-2}, when KYI = 2 and KD = 1	False	string
keyData[0].g_id	The group id number	The group id number {1-50}, when KYI = 2 and KD = 1	False	string
keyData[0].lens	The lens of the station	The LENS - only when KYI =2 and KD = 4	False	string
flexKeyData.count	count of flex keys	The count of flex keys (required when inputting via array).	False	string
flexKeyData	flexkeydata in array	flex key data as array	False	array
flexKeyData[0].kyi2	The service index	The service index - only when TP = 2/3/5, {0-1}	False	string
flexKeyData[0].kyn2	The Key number 2	The key number 2 - only when TP = 2/3/5 {1-16}	False	string
flexKeyData[0].fky2	The function key number	The function key number - only when TP =2/3/5 and KYI2 = 1, {1-320}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AKYD-Delete Key Data (akydDel)

Delete the Key Data setting for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station. {1-63}, default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AKYD-Lists Key Data (akydList)

Lists the Key Data for Station Numbers.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start Tenant	The starting tenant for the station {1-63}, default {1}	False	string
end_tn	End Tenant	The ending tenant for the station {1-63}, default {1}	False	string
start_stn	Start Station Number	The starting station Number.	True	string
end_stn	End Station Number	The ending station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
akydListResponse.count	The count of stations.	string
akydListResponse[0].tn	The tenant for the station.	string
akydListResponse[0].stn	The station.	string
akydListResponse[0].pri	The priority of the answering call. {0-4}	string
akydListResponse[0].pl_tn	The tenant of the prime line.	string
akydListResponse[0].pl_stn	The station number of prime line.	string
akydListResponse[0].s	The OG from prime line. {0-1}	string
akydListResponse[0].mwd	The message waiting data. {0-1}	string
akydListResponse[0].ln_pre	The line preference data. {0-1}	string
akydListResponse[0].spk	the line preference for speaker button. {0-3}	string
akydListResponse[0].ans	The line preference for answer button {0-2}	string
akydListResponse[0].org	The line preference for Originating button {0-2}	string
akydListResponse[0].tp	The type of DTerm {0-5}	string
akydListResponse[0].keyData	The key data in json	string
akydListResponse[0].flexKeyData	The flex key data in json	string

ADKS-Get Key Status Data (adksGet)

Get the Key Status Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station. {1-63}, default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
tn	The tenant for the station.	string
stn	The station.	string
skp	The Soft Key Pattern Data. {0-15}	string
lkp	The Line Key pattern data. {1-3}	string
pg	The page scroll key. {0-1}	string

ADKS-Set Key Status Data (adksSet)

Sets the Key Status Data for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	tenant	The tenant for the station {1-63}, default {1}	False	string
stn	Station Number	The station number	True	string
skp	Soft Key pattern data	The Soft Key Pattern Data. {0-15}, default {0}	False	string
lkp	Line Key pattern data	The Line Key pattern data. {1-3}, default {1}	False	string
pg	Page Scroll Key	The page scroll key. {0-1}, default {0}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADKS-Delete Key Status Data (adksDel)

Delete the Key Status Data setting for a Station Number.

Request Properties

Name	Display	Description	Is Required	Type
tn	Tenant Number	The tenant number for the station.{1-63}, default {1}	False	string
stn	Station Number	The Station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADKS-Lists Key Status Data (adksList)

Lists the Key Status Data for Station Numbers.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start Tenant	The starting tenant for the station {1-63}, default {1}	False	string
end_tn	End Tenant	The ending tenant for the station.{1-63}, default {1}	False	string
start_stn	Start Station Number	The starting station Number.	True	string
end_stn	End Station Number	The ending station Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
adksListResponse.count	The count of stations.	string
adksListResponse[0].tn	The tenant for the station.	string
adksListResponse[0].stn	The station.	string
adksListResponse[0].skp	The Soft Key pattern data. {1-15}	string
adksListResponse[0].lkp	The Line Key pattern data. {1-3}	string
adksListResponse[0].pg	The page scroll key. {0-1}	string

ALGSN-Get Telephone Number (algsnGet)

Get the Telephone Number for Station or LENS.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (1/2). (LENS/STN)	True	string
ugn	User Group Number	The user group number for the telephone {1-255}. default{1}	False	string
teln	Telephone Number	The telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
type	The data type to be requested (1/2). (LENS/STN)	string
ugn	The user group number for the telephone {1-255}.	string
teln	The telephone Number.	string
fpc	The Fusion point code.	string
tn	The tenant number for the station.	string
stn	The Station Number.	string
lens	The line equipment number.	string

ALGSN-Set Telephone Number (algsnSet)

Sets the Telephone Number for a Station Number or LENS.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (1/2). (LENS/STN)	True	string
ugn	User Group Number	The user group number for the telephone {1-255}, default {1}	False	string
teln	Telephone Number	The telephone Number.	True	string
fpc	Fusion point code	The Fusion point code {1-253}, default {1}	False	string
tn	Tenant Number	The tenant number for the station, only when TYPE = 2. {1-63}, default {1}	False	string
stn	Station Number	The Station Number, only when TYPE = 2	False	string
lens	LENS	The line equipment number, only when TYPE = 1	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALGSN-Delete Telephone Number (algsnDel)

Delete the Telephone Number.

Request Properties

Name	Display	Description	Is Required	Type
ugn	User Group Number	The user group number for the telephone {1-255}. default{1}	False	string
teln	Telephone Number	The telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALGSN-Lists Telephone Numbers (algsnList)

Lists the Telephone Numbers.

Request Properties

Name	Display	Description	Is Required	Type
type	Type	The data type to be requested (1/2). (LENS/STN)	True	string
start_fpc	Start Fusion point code	The starting fusion point code {1-253}. default {1}	False	string
end_fpc	End Fusion point code	The ending fusion point code {1-253}. default {1}	False	string
start_ugn	Start User Group Number	The starting user group number for the telephone {1-255}. default {1}	False	string
end_ugn	End User Group Number	The ending user group number for the telephone {1-255}. default {1}	False	string
start_teln	Start Telephone Number	The starting telephone Number.	True	string
end_teln	End Telephone Number	The ending telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
algsnListResponse.count	The count of telephone numbers.	string
algsnListResponse[0].ugn	The user group number for the telephone {1-255}.	string
algsnListResponse[0].teln	The telephone Number.	string
algsnListResponse[0].fpc	The Fusion point code.	string
algsnListResponse[0].tn	The tenant number for the station.	string
algsnListResponse[0].stn	The Station Number.	string
algsnListResponse[0].lens	The line equipment number.	string

AMACN-Get MAC Address for NDM (amacnGet)

Get the MAC Address for Telephone Number in NDM.

Request Properties

Name	Display	Description	Is Required	Type
ugn	User Group Number	The user group number for the telephone {1-255}. default {1}	False	string
teln	Telephone Number	The telephone Number.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ugn	The user group number for the telephone {1-255}.	string
teln	The telephone Number.	string
tec	The Tech Equipment code.	string
mac	The MAC Address	string
ch	The MAC Channel.	string

AMACN-Set MAC Address for NDM (amacnSet)

Set the MAC Address for Telephone Number in NDM.

Request Properties

Name	Display	Description	Is Required	Type
ugn	User Group Number	The user group number for the telephone {1-255}. default {1}	False	string
teln	Telephone Number	The telephone Number.	True	string
mac_address	MAC Address	The MAC Address	True	string
ch	The MAC Channel	The MAC Channel.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMACN-Delete MAC Address for NDM (amacnDel)

Delete the MAC Address for Telephone Number in NDM.

Request Properties

Name	Display	Description	Is Required	Type
ugn	User Group Number	The user group number for the telephone {1-255}. default {1}	False	string
teln	Telephone Number	The telephone Number.	True	string
mac_address	MAC Address	The MAC Address	True	string
ch	The MAC Channel	The MAC Channel.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMACN-Lists the MAC Addresses for Telephone numbers in NDM (amacnList)

Lists the MAC Addresses for Telephone numbers in NDM

Request Properties

Name	Display	Description	Is Required	Type
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
amacnListResponse.count	The count of telephone numbers.	string
amacnListResponse[0].mac	The MAC Address.	string
amacnListResponse[0].ch	The channel for MAC Address.	string
amacnListResponse[0].eqtyp	The equipment type	string
amacnListResponse[0].ugn	The user group number for the telephone {1-255}.	string
amacnListResponse[0].teln	The telephone Number.	string
amacnListResponse[0].lgrt	The logical route number	string

AFRSN-Get Flexible Route Selection Data for NDM (afrsnGet)

Gets the Flexible Route Selection Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
ma_id	MA-ID	Management Area ID {0-9999}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
opr	Outgoing Route Selection Pattern Number	string

AFRSN-Set Flexible Route Selection Data for NDM (afrsnSet)

Sets the Flexible Route Selection Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ma_id	MA-ID	Management Area ID {0-9999}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AFRSN-Delete Flexible Route Selection Data for NDM (afrsnDel)

Deletes the Flexible Route Selection Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
ma_id	MA-ID	Management Area ID {0-9999}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AFRSN-Lists Flexible Route Selection Data for NDM (afrsnList)

Lists the Flexible Route Selection Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	False	string
end_tn	End TN	The ending Tenant Number {1-63}	False	string
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
start_npc	Start NPC	The starting Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
end_npc	End NPC	The ending Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
start_ma_id	Start MA-ID	The starting Management Area ID {0-9999}	False	string
end_ma_id	End MA-ID	The ending Management Area ID {0-65535}	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
afrsnListResponse.count	The count of items.	string
afrsnListResponse[0].tn	Tenant Number	string
afrsnListResponse[0].lgrt	Logical Route Number	string
afrsnListResponse[0].npc	Number Pattern Code	string
afrsnListResponse[0].ma_id	Management Area ID	string
afrsnListResponse[0].opr	Outgoing Route Selection Pattern Number	string

AFRS-Get Flexible Route Selection Data (afrsGet)

Gets the Flexible Route Selection Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
rt	RT	Route Number {1-255}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
opr	Outgoing Route Selection Pattern Number	string

AFRS-Set Flexible Route Selection Data (afrsSet)

Sets the Flexible Route Selection Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
rt	RT	Route Number {1-255}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AFRS-Delete Flexible Route Selection Data (afrsDel)

Deletes the Flexible Route Selection Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
rt	RT	Route Number {1-255}	True	string
npc	NPC	Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AFRS-Lists Flexible Route Selection Data (afrsList)

Lists the Flexible Route Selection Data.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	False	string
end_tn	End TN	The ending Tenant Number {1-63}	False	string
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
start_npc	Start NPC	The starting Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
end_npc	End NPC	The ending Number Pattern Code {0-9,*,#,P,T} 16 digits max	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
afrsListResponse.count	The count of items.	string
afrsListResponse[0].tn	Tenant Number	string
afrsListResponse[0].rt	Route Number	string
afrsListResponse[0].npc	Number Pattern Code	string
afrsListResponse[0].opr	Outgoing Route Selection Pattern Number	string

AOPRN-Get Outgoing Pattern Routing Data for NDM (aoprnGet)

Gets the Outgoing Pattern Routing Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
e	Route Advancing End Indication	string
lgrt	Logical Route Number	string
skip	Number of digits to be skipped	string
pnl	Pattern Number Location	string
ovft	Overflow Tone	string
prsc	Priority Restriction Class	string
ip_trk	The flag of trunk kind	string
pc	Point code	string

AOPRN-Set Outgoing Pattern Routing Data for NDM (aoprnSet)

Sets the Outgoing Pattern Routing Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
e	E	Route Advancing End Indication {0-1}	True	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
skip	SKIP	Number of digits to be skipped {0-24}	True	string
pnl	PNL	Pattern Number Location {0-999}	True	string
ovft	OVFT	Overflow Tone {0-1}	True	string
prsc	PRSC	Priority Restriction Class {0-15}	True	string
ip_trk	IP_TRK	The flag of trunk kind {0-1}	True	string
pc	PC	Point code {1-16367}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AOPRN-Delete Outgoing Pattern Routing Data for NDM (aoprnDel)

Deletes the Outgoing Pattern Routing Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AOPRN-Lists Outgoing Pattern Routing Data for NDM (aoprnList)

Lists the Outgoing Pattern Routing Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tdptn	Start TDPTN	The starting Time of Day Change Pattern Number {0-7}	True	string
end_tdptn	End TDPTN	The ending Time of Day Change Pattern Number {0-7}	True	string
start_opr	Start OPR	The starting Outgoing Route Selection Pattern Number {0-4000}	True	string
end_opr	End OPR	The ending Outgoing Route Selection Pattern Number {0-4000}	True	string
start_ra	Start RA	The starting Route Advancing Order {0-7}	True	string
end_ra	End RA	The ending Route Advancing Order {0-7}	True	string
grouping	Grouping	Specify '1', the results grouped by TDPTN and OPR will be returned. Specify '0', the listed results will be returned. Default is '0'.	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aoprnListResponse.count	The count of items.	string
aoprnListResponse[0].tdptn	Time of Day Change Pattern Number	string
aoprnListResponse[0].opr	Outgoing Route Selection Pattern Number	string
aoprnListResponse[0].ra	Route Advancing Order	string
aoprnListResponse[0].e	Route Advancing End Indication	string
aoprnListResponse[0].lgrt	Logical Route Number	string
aoprnListResponse[0].skip	Number of digits to be skipped	string
aoprnListResponse[0].pnl	Pattern Number Location	string
aoprnListResponse[0].ovft	Overflow Tone	string
aoprnListResponse[0].prsc	Priority Restriction Class	string
aoprnListResponse[0].ip_trk	The flag of trunk kind	string
aoprnListResponse[0].pc	Point code	string
aoprnGroupedListResponse.count	The count of items.	string
aoprnGroupedListResponse[0].tdptn	Time of Day Change Pattern Number	string
aoprnGroupedListResponse[0].opr	Outgoing Route Selection Pattern Number	string
aoprnGroupedListResponse[0].raList.count	The count of items.	string
aoprnGroupedListResponse[0].raList[0].ra	Route Advancing Order	string
aoprnGroupedListResponse[0].raList[0].e	Route Advancing End Indication	string
aoprnGroupedListResponse[0].raList[0].lgrt	Logical Route Number	string
aoprnGroupedListResponse[0].raList[0].skip	Number of digits to be skipped	string
aoprnGroupedListResponse[0].raList[0].pnl	Pattern Number Location	string
aoprnGroupedListResponse[0].raList[0].ovft	Overflow Tone	string
aoprnGroupedListResponse[0].raList[0].prsc	Priority Restriction Class	string
aoprnGroupedListResponse[0].raList[0].ip_trk	The flag of trunk kind	string
aoprnGroupedListResponse[0].raList[0].pc	Point code	string

AOPR-Get Outgoing Pattern Routing Data (aoprGet)

Gets the Outgoing Pattern Routing Data.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
e	Route Advancing End Indication	string
rt	Route Number	string
skip	Number of digits to be skipped	string
pnl	Pattern Number Location	string
ovft	Overflow Tone	string
prsc	Priority Restriction Class	string
ip_trk	The flag of trunk kind	string
pc	Point code	string

AOPR-Set Outgoing Pattern Routing Data (aoprSet)

Sets the Outgoing Pattern Routing Data.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
e	E	Route Advancing End Indication {0-1}	True	string
rt	RT	Route Number {1-255}	True	string
skip	SKIP	Number of digits to be skipped {0-24}	True	string
pnl	PNL	Pattern Number Location {0-999}	True	string
ovft	OVFT	Overflow Tone {0-1}	True	string
prsc	PRSC	Priority Restriction Class {0-15}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AOPR-Delete Outgoing Pattern Routing Data (aoprDel)

Deletes the Outgoing Pattern Routing Data.

Request Properties

Name	Display	Description	Is Required	Type
tdptn	TDPTN	Time of Day Change Pattern Number {0-7}	True	string
opr	OPR	Outgoing Route Selection Pattern Number {0-4000}	True	string
ra	RA	Route Advancing Order {0-7}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AOPR-Lists Outgoing Pattern Routing Data (aoprList)

Lists the Outgoing Pattern Routing Data.

Request Properties

Name	Display	Description	Is Required	Type
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
start_tdptn	Start TDPTN	The starting Time of Day Change Pattern Number {0-7}	True	string
end_tdptn	End TDPTN	The ending Time of Day Change Pattern Number {0-7}	True	string
start_opr	Start OPR	The starting Outgoing Route Selection Pattern Number {0-4000}	True	string
end_opr	End OPR	The ending Outgoing Route Selection Pattern Number {0-4000}	True	string
start_ra	Start RA	The starting Route Advancing Order {0-7}	True	string
end_ra	End RA	The ending Route Advancing Order {0-7}	True	string
grouping	Grouping	Specify '1', the results grouped by TDPTN and OPR will be returned. Specify '0', the listed results will be returned. Default is '0'.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aoprListResponse.count	The count of items.	string
aoprListResponse[0].tdptn	Time of Day Change Pattern Number	string
aoprListResponse[0].opr	Outgoing Route Selection Pattern Number	string
aoprListResponse[0].ra	Route Advancing Order	string
aoprListResponse[0].e	Route Advancing End Indication	string
aoprListResponse[0].rt	Route Number	string
aoprListResponse[0].skip	Number of digits to be skipped	string
aoprListResponse[0].pnl	Pattern Number Location	string
aoprListResponse[0].ovft	Overflow Tone	string
aoprListResponse[0].prsc	Priority Restriction Class	string
aoprGroupedListResponse.count	The count of items.	string
aoprGroupedListResponse[0].tdptn	Time of Day Change Pattern Number	string
aoprGroupedListResponse[0].opr	Outgoing Route Selection Pattern Number	string
aoprGroupedListResponse[0].raList.count	The count of items.	string
aoprGroupedListResponse[0].raList[0].ra	Route Advancing Order	string
aoprGroupedListResponse[0].raList[0].e	Route Advancing End Indication	string
aoprGroupedListResponse[0].raList[0].rt	Route Number	string
aoprGroupedListResponse[0].raList[0].skip	Number of digits to be skipped	string
aoprGroupedListResponse[0].raList[0].pnl	Pattern Number Location	string
aoprGroupedListResponse[0].raList[0].ovft	Overflow Tone	string
aoprGroupedListResponse[0].raList[0].prsc	Priority Restriction Class	string

ARNPN-Get Reverse Numbering Plan Data for NDM (arnpnGet)

Gets the Reverse Numbering Plan Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
acc	Access Code	string

ARNPN-Set Reverse Numbering Plan Data for NDM (arnpnSet)

Sets the Reverse Numbering Plan Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
acc	ACC	Access Code {0-9,*,#} 4 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARNPN-Delete Reverse Numbering Plan Data for NDM (arnpnDel)

Deletes the Reverse Numbering Plan Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARNPN-Lists Reverse Numbering Plan Data for NDM (arnpnList)

Lists the Reverse Numbering Plan Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {0-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {0-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arnpnListResponse.count	The count of items.	string
arnpnListResponse[0].lgrt	Logical Route Number	string
arnpnListResponse[0].acc	Access Code	string

ARNP-Get Reverse Numbering Plan Data (arnpGet)

Gets the Reverse Numbering Plan Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {0-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
acc	Access Code	string

ARNP-Set Reverse Numbering Plan Data (arnpSet)

Sets the Reverse Numbering Plan Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {0-255}	True	string
acc	ACC	Access Code {0-9,*,#} 4 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARNP-Delete Reverse Numbering Plan Data (arnpDel)

Deletes the Reverse Numbering Plan Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {0-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARNP-Lists Reverse Numbering Plan Data (arnpList)

Lists the Reverse Numbering Plan Data.

Request Properties

Name	Display	Description	Is Required	Type
start_rt	Start RT	The starting Route Number {0-255}	True	string
end_rt	End RT	The ending Route Number {0-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arnpListResponse.count	The count of items.	string
arnpListResponse[0].rt	Route Number	string
arnpListResponse[0].acc	Access Code	string

ADPCN-Get Determinate Point Code Data for NDM (adpcnGet)

Gets the Determinate Point Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
pc	Determinate Point Code	string

ADPCN-Set Determinate Point Code Data for NDM (adpcnSet)

Sets the Determinate Point Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pc	PC	Determinate Point Code {1-16383}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADPCN-Delete Determinate Point Code Data for NDM (adpcnDel)

Deletes the Determinate Point Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADPCN-Lists Determinate Point Code Data for NDM (adpcnList)

Lists the Determinate Point Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
adpcnListResponse.count	The count of items.	string
adpcnListResponse[0].lgrt	Logical Route Number	string
adpcnListResponse[0].pc	Determinate Point Code	string

ADPC-Get Determinate Point Code Data (adpcGet)

Gets the Determinate Point Code Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
pc	Determinate Point Code	string

ADPC-Set Determinate Point Code Data (adpcSet)

Sets the Determinate Point Code Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pc	PC	Determinate Point Code {1-16383}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADPC-Delete Determinate Point Code Data (adpcDel)

Deletes the Determinate Point Code Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ADPC-Lists Determinate Point Code Data (adpcList)

Lists the Determinate Point Code Data.

Request Properties

Name	Display	Description	Is Required	Type
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
adpcListResponse.count	The count of items.	string
adpcListResponse[0].rt	Route Number	string
adpcListResponse[0].pc	Determinate Point Code	string

ACSCN-Get CSC Data for NDM (acscnGet)

Gets the CSC Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
items.count	The count of items.	string
items[0].fpc	Fusion Point Code	string
items[0].cch	Common Channel Handler LENS	string

ACSCN-Set CSC Data for NDM (acscnSet)

Sets the CSC Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
fpc_0	FPC_0	Fusion Point Code {1-253}	True	string
cch_0	CCH_0	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_1	FPC_1	Fusion Point Code {1-253}	True	string
cch_1	CCH_1	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_2	FPC_2	Fusion Point Code {1-253}	True	string
cch_2	CCH_2	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_3	FPC_3	Fusion Point Code {1-253}	True	string
cch_3	CCH_3	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_4	FPC_4	Fusion Point Code {1-253}	True	string
cch_4	CCH_4	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_5	FPC_5	Fusion Point Code {1-253}	True	string
cch_5	CCH_5	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_6	FPC_6	Fusion Point Code {1-253}	True	string
cch_6	CCH_6	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
fpc_7	FPC_7	Fusion Point Code {1-253}	True	string
cch_7	CCH_7	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACSCN-Delete CSC Data for NDM (acscnDel)

Deletes the CSC Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACSCN-Lists CSC Data for NDM (acscnList)

Lists the CSC Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_cscg	Start CSCG	The starting Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
end_cscg	End CSCG	The ending Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
acscnListResponse.count	The count of items.	string
acscnListResponse[0].cscg	Common Channel Signaling Controller Group Number	string
acscnListResponse[0].items.count	The count of items.	string
acscnListResponse[0].items[0].fpc	Fusion Point Code	string
acscnListResponse[0].items[0].cch	Common Channel Handler LENS	string

ACSC-Get CSC Data (acscGet)

Gets the CSC Data.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
items.count	The count of items.	string
items[0].cch	Common Channel Handler LENS	string

ACSC-Set CSC Data (acscSet)

Sets the CSC Data.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
cch_0	CCH_0	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_1	CCH_1	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_2	CCH_2	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_3	CCH_3	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_4	CCH_4	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_5	CCH_5	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_6	CCH_6	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
cch_7	CCH_7	Common Channel Handler LENS {XXXXX} MG, UNIT and Group only, don't need LEVEL	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACSC-Delete CSC Data (acscDel)

Deletes the CSC Data.

Request Properties

Name	Display	Description	Is Required	Type
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACSC-Lists CSC Data (acscList)

Lists the CSC Data.

Request Properties

Name	Display	Description	Is Required	Type
start_cscg	Start CSCG	The starting Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
end_cscg	End CSCG	The ending Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
acscListResponse.count	The count of items.	string
acscListResponse[0].cscg	Common Channel Signaling Controller Group Number	string
acscnListResponse[0].items.count	The count of items.	string
acscnListResponse[0].items[0].cch	Common Channel Handler LENS	string

ACIC1N-Get CIC Code Data for NDM (acic1nGet)

Gets the CIC Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
cscg	Common Channel Signaling Controller Group Number	string

ACIC1N-Set CIC Code Data for NDM (acic1nSet)

Sets the CIC Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC1N-Delete CIC Code Data for NDM (acic1nDel)

Deletes the CIC Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC1N-Lists CIC Code Data for NDM (acic1nList)

Lists the CIC Code Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_pc	Start PC	The starting Determinate Point Code {1-16383}	True	string
end_pc	End PC	The ending Determinate Point Code {1-16383}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
acic1nListResponse.count	The count of items.	string
acic1nListResponse[0].pc	Determinate Point Code	string
acic1nListResponse[0].cscg	Common Channel Signaling Controller Group Number	string

ACIC1-Get CIC Code Data (acic1Get)

Gets the CIC Code Data.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
cscg	Common Channel Signaling Controller Group Number	string

ACIC1-Set CIC Code Data (acic1Set)

Sets the CIC Code Data.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
cscg	CSCG	Common Channel Signaling Controller Group Number {2-127,130-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC1-Delete CIC Code Data (acic1Del)

Deletes the CIC Code Data.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC1-Lists CIC Code Data (acic1List)

Lists the CIC Code Data.

Request Properties

Name	Display	Description	Is Required	Type
start_pc	Start PC	The starting Determinate Point Code {1-16383}	True	string
end_pc	End PC	The ending Determinate Point Code {1-16383}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
acic1ListResponse.count	The count of items.	string
acic1ListResponse[0].pc	Determinate Point Code	string
acic1ListResponse[0].cscg	Common Channel Signaling Controller Group Number	string

ACIC2-Get CIC Code Data 2 (acic2Get)

Gets the CIC Code Data 2.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
cic	CIC	Circuit Identification Code Number {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
lens	Line Equipment Number	string

ACIC2-Set CIC Code Data 2 (acic2Set)

Sets the CIC Code Data 2.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
cic	CIC	Circuit Identification Code Number {1-999}	True	string
lens	LENS	Line Equipment Number	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC2-Delete CIC Code Data 2 (acic2Del)

Deletes the CIC Code Data 2.

Request Properties

Name	Display	Description	Is Required	Type
pc	PC	Determinate Point Code {1-16383}	True	string
cic	CIC	Circuit Identification Code Number {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ACIC2-Lists CIC Code Data 2 (acic2List)

Lists the CIC Code Data 2.

Request Properties

Name	Display	Description	Is Required	Type
start_pc	Start PC	The starting Determinate Point Code {1-16383}	True	string
end_pc	End PC	The ending Determinate Point Code {1-16383}	True	string
start_cic	Start CIC	The starting Circuit Identification Code Number {1-999}	True	string
end_cic	End CIC	The ending Circuit Identification Code Number {1-999}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
acic2ListResponse.count	The count of items.	string
acic2ListResponse[0].pc	Determinate Point Code	string
acic2ListResponse[0].cic	Circuit Identification Code Number	string
acic2ListResponse[0].lens	Line Equipment Number	string

ANPDN-Get Numbering Plan for NDM (anpdnGet)

Gets the Numbering Plan for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
nnd	Number of Necessary Digits	string
blf	Busy Lamp Field Display Activated on ATT	string

ANPDN-Set Numbering Plan for NDM (anpdnSet)

Sets the Numbering Plan for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
nnd	NND	Number of Necessary Digits {1-16}	True	string
blf	BLF	Busy Lamp Field Display Activated on ATT {0-1}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANPDN-Delete Numbering Plan for NDM (anpdnDel)

Deletes the Numbering Plan for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANPDN-Lists Numbering Plan for NDM (anpdnList)

Lists the Numbering Plan for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
anpdnListResponse.count	The count of items.	string
anpdnListResponse[0].tn	Tenant Number	string
anpdnListResponse[0].nnd	Number of Necessary Digits	string
anpdnListResponse[0].blf	Busy Lamp Field Display Activated on ATT	string

ANPD-Get Numbering Plan (anpdGet)

Gets the Numbering Plan.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
nnd	Number of Necessary Digits	string
blf	Busy Lamp Field Display Activated on ATT	string

ANPD-Set Numbering Plan (anpdSet)

Sets the Numbering Plan.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
nnd	NND	Number of Necessary Digits {1-16}	True	string
blf	BLF	Busy Lamp Field Display Activated on ATT {0-1}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANPD-Delete Numbering Plan (anpdDel)

Deletes the Numbering Plan.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
first_dc	FIRST_DC	1st Digit Code {0-9,#,*} 1 digit	True	string
ci	CI	Connection Status Index {1-3}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ANPD-Lists Numbering Plan (anpdList)

Lists the Numbering Plan.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
anpdnListResponse.count	The count of items.	string
anpdnListResponse[0].tn	Tenant Number	string
anpdnListResponse[0].nnd	Number of Necessary Digits	string
anpdnListResponse[0].blf	Busy Lamp Field Display Activated on ATT	string

MBTK-Get Make Busy of Trunk (mbtkGet)

Gets the Make Busy of Trunk.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255, 901-947}	True	string
tk	TK	Trunk Number {1-768}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
mb	0: Make Idle,1: Make Busy(Outgoing),2: Make Busy(Bothway)	string
status	1 : Self trunk MB, 2 : Other trunk MB, 3 : Both trunk MB, 4 : Self trunk MB ready, 5 : Both trunk MB ready	string

MBTK-Set Make Busy of Trunk (mbtkSet)

Sets the Make Busy of Trunk.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255, 901-947}	True	string
tk	TK	Trunk Number {1-768}	True	string
mb	MB	Make Busy Information {0 : Make Idle, 1 : Make Busy(Outgoing), 2 : Make Busy(Bothway)}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

MBTK-Multiple-Set Make Busy of Trunk (mbtkMultipleSet)

Multiple Sets the Make Busy of Trunk.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
mb	MB	Make Busy Information {0 : Make Idle, 1 : Make Busy(Outgoing), 2 : Make Busy(Bothway)}	True	string
start_tk	START TK	Start Trunk Number {1-255}	True	string
number_of_trunk	Number of Trunk	Number of Trunk	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATRK-Get Trunk Data (atrkGet)

Gets the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255, 901-947}	True	string
tk	TK	Trunk Number {1-768}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
lens	Line Equipment Number	string
tn	Tenant Number	string
rsc	The restriction class value	string
sfc	The service feature class value	string
number_of_tn	Number of TN	string
tnListResponse[0].tn	Tenant Number	string

ATRK-Set Trunk Data (atrkSet)

Sets the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255, 901-947}	True	string
tk	TK	Trunk Number {1-768}	True	string
lens	LENS	The line equipment number location for the trunk.	False	string
tn	TN	Tenant Number	False	string
rsc	RSC	The restriction class value	False	string
sfc	SFC	The service feature class value	False	string
number_of_tn	Number of TN	Number of TN	False	string
tnList	TN in array	The TN as array	False	array
tnList[0].tn	TN	Tenant Number {1-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATRK-Multiple-Set Trunk Data (atrkMultipleSet)

Multiple Sets the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
tn	TN	Tenant Number	False	string
start_tk	START TK	Start Trunk Number {1-255}	True	string
start_lens	Start LENS	Start line equipment number location for the trunk.	True	string
number_of_trunk	Number of Trunk	Number of Trunk	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATRK-Delete Trunk Data (atrkDel)

Deletes the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255, 901-947}	True	string
tk	TK	Trunk Number {1-768}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATRK-Multiple-Delete Trunk Data (atrkMultipleDel)

Multiple Deletes the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
start_tk	START TK	Start Trunk Number {1-255}	True	string
number_of_trunk	Number of Trunk	Number of Trunk	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATRK-Lists Trunk Data (atrkList)

Lists the Trunk Data.

Request Properties

Name	Display	Description	Is Required	Type
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
start_tk	Start TK	The starting Trunk Number {1-255}	True	string
end_tk	End TK	The ending Trunk Number {1-255}	True	string
grouping	Grouping	Specify '1', the results grouped by RT will be returned. Specify '0', the listed results will be returned. Default is '0'.	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
atrkListResponse.count	The count of items.	string
atrkListResponse[0].rt	Route Number {1-255}	string
atrkListResponse[0].tk	Trunk Number {1-255}	string
atrkListResponse[0].lens	Line Equipment Number {XXXXXX}	string
atrkListResponse[0].tn	Tenant Number {1-63}	string
atrkListResponse[0].rsc	Route Restriction Class {1-15}	string
atrkListResponse[0].sfc	Service Feature Restriction Class {1-15}	string
atrkListResponse[0].tnList.count	The count of items.	string
atrkListResponse[0].tnList[0].tn	Tenant Number {1-63}	string
atrkGroupedListResponse.count	The count of items.	string
atrkGroupedListResponse[0].rt	Route Number {1-255}	string
atrkGroupedListResponse[0].start_tk	Start Trunk Number {1-255}	string
atrkGroupedListResponse[0].start_lens	Start Line Equipment Number {XXXXXX}	string
atrkListResponse[0].trunkCount	Trunk Count {1-255}	string

ARTI-Get Trunk Application Data (artiGet)

Gets the Trunk Application Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
rst	Assignment of Restart	string
hmt	HMT PKG recognition	string
trcrst	Call Restriction by Information transfer rate in Bearer Capability	string
trsrst	Call Restriction by Information transfer rate in Bearer Capability	string
t309lnk	Assignment of Timer T309 for Data Link Failure	string
t309con	Assignment of Timer T309 for Layer1 Failure	string
llcrst	Call restriction by user rate in Low Layer Capability Information	string
vcm	Recognition for Voice Compression Module(VCM)	string
ovrt	Virtual Tie Line Call service for voice compression	string
pool	Type of Voice Compression Module	string
dtrt	Detection of ALL 1 alarm signal (DTI Layer 1 alarm)	string
tmprt	Temporally Route Information over CCIS/Dp	string
codec	Voice compression algorithm	string
pass	Path through control (This data becomes effective at CODEC is except 0)	string
irl	Clear call when DTI alarm is detected	string
mtc	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds	string
tc	Timer T309 Counter Value	string
ts	TS Service for Network VCM	string
cdcspd	Conversion rate of voice Codec (Kbps)	string
dvrst	Call restriction while Tie line is backed up on ISDN	string
rsct	Call restriction by temporary route Information	string
rocg	Outgoing Call account by Temporary Route Information	string
ricg	Outgoing Call account by Temporary Route Information	string
stsenq	Status inquiry Message Send	string
mmnpass	APEX Only	string
dltk	APEX Only	string
caln	APEX Only	string
netint	APEX Only	string
inband	APEX Only	string
RETMSG	Message Sent When ISDN Call is connected to ACD	string
ani	Timing to demand ANI information	string
srv	Addition service selection	string
ton	Type of number	string
npi	Numbering plan identification	string
l_t	Local/Toll	string
eccis	VT(E-CCIS) Route	string
eccistm	VT(E-CCIS) Miscellaneous Timer Counter	string
eccisob	VT(E-CCIS) Miscellaneous Timer Counter	string
eccisib	VT(E-CCIS) IC SMDR	string
spmet	Account Pulse Watch Control	string
idrt	ID Code Specification	string
eccistd	VT (E-CCIS) Type of Dialing	string
mfcg2	MFC Outgoing Call G2	string
opcc	Optimal Call Control	string
ictcon	ICT Control : Japan Only	string
vrd	Voice Recognize Dial : Japan Only	string
intd	Interface Detail	string
jeccis	Common use with E-CCIS RT	string
eccis2	E-CCIS System	string
ipint	Public PCS Protocol	string
iptrk	IP Trunk	string
ctcf	Call Transfer,Call Forwarding Q-SIG Supplementary Service	string
rert	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting	string
dcans	Answer When DC Dialing	string
rnd	Trunk Select Data in Round Robin Formula	string
clbk	Collect Call Blocking	string
ualaw	User information layer 1 protocol	string
mctfac	MCT(MCID) service send message	string
re	Recall Supplementary Service	string
pr	Path Replacement Additional Network Feature	string
cot	Continuity check for Signaling System No.7	string
ss7	Signaling System No.7	string
ni2id	Network Identifier for NI-2	string
clrf	CCIS Link Reconnection for Netfusing	string
trc	Transit Counter	string
oid	Object ID in Facility IE	string
phg	PHG Service	string
vir	Virtual IR	string
kanji	Intra-office Name Display by KANJI	string
csmds	SMDS and Customers Satisfaction Report Definition	string
fxd	FAX data enable	string
fxjs	Jitter buffer size for FAX	string
fxpt	Payload type for FAX	string
fxps	Payload size for FAX	string
cpi	CPI set up	string
e911	911 Outgoing Route	string
ra_rt	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG)	string
clicf	CLIP/CLIR is chosen at the time of call forwarding	string
ftrks	Flexible Trunk select	string
ioname	IONAME	string
bnovr	BNOVR	string
fdisc	FDISC	string
b2bua	B2BUA	string
colp	COLP	string
adrsing	Addressing Service	string
ovrrcv	Overlap Receiving Service	string
ovrsnd	Overlap Sending Service	string
ovrsdc	Overlap Send Digits	string
region	Regional Interface	string
smds5	'TRK Received Time' and 'Abandoned Call' SMDS Output	string
eu_opt	'ETSI ISDN Option Data	string
EBDC	'Digit Code of Called party number(for Enblock dialing)	string
iccbs	Isdn CCBS(Completion of Calls to Busy Subscriber)	string
b2binum	B2BUA Calling Number Notify Service	string
monitor	ACD monitor link connection	string
mgsipsv	MG(SIP) Additional Service	string
rsta	Send Restart Ack Signal to the Public Network	string
msrt	Mobile Service	string
tcgni	Transfer Calling Number Incoming	string
tcgno	Transfer Calling Number Outgoing	string
siptone	SIP Congestion Tone Sending	string
oaiinfo	OAI INFO Signal Sending Service	string
msccnt	Call Forwarding Music Silent Change Control	string
tcgnc	Transfer Calling Number to CCIS	string
prtcc	Primary Route for CPN Conversion : North America Only	string
guidance	Route of Guidance	string
loop	Loop Detection	string
sd183sdp	PROGRESS Sending to MG-SIP	string
ref_grp	REFER transfer group	string
mltmedia	Multimedia Communication	string
sip302redirect	302 Redirect	string
acfo_tn	ACFO_TN	string
fmc_mobdn	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone	string
fmc_tdm	Operation when Incoming from FMC Network in a Tandem Connection	string
ng911_index	Connection destination index when calling NG911	string
histinfo	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier	string
histdetail	More information about headers appended with HISTINFO	string
cloudsv	Cloud Service to interwork	string

ARTI-Set Trunk Application Data (artiSet)

Sets the Trunk Application Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
rst	RST	Assignment of Restart {0-3}	False	string
hmt	HMT	HMT PKG recognition {0-3}	False	string
trcrst	TRCRST	Call Restriction by Information transfer rate in Bearer Capability {0-15}	False	string
trsrst	TRSRST	Call Restriction by Information transfer rate in Bearer Capability {0-15}	False	string
t309lnk	T309LNK	Assignment of Timer T309 for Data Link Failure {0-3}	False	string
t309con	T309CON	Assignment of Timer T309 for Layer1 Failure {0-3}	False	string
llcrst	LLCRST	Call restriction by user rate in Low Layer Capability Information {0-31}	False	string
vcm	VCM	Recognition for Voice Compression Module(VCM) {0-3}	False	string
ovrt	OVRT	Virtual Tie Line Call service for voice compression {0-1}	False	string
pool	POOL	Type of Voice Compression Module {0-1}	False	string
dtrt	DTRT	Detection of ALL 1 alarm signal (DTI Layer 1 alarm) {0-3}	False	string
tmprt	TMPRT	Temporally Route Information over CCIS/Dp {0-1}	False	string
codec	CODEC	Voice compression algorithm {0-3}	False	string
pass	PASS	Path through control (This data becomes effective at CODEC is except 0) {0-1}	False	string
irl	IRL	Clear call when DTI alarm is detected {0-1}	False	string
mtc	MTC	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds {0-15}	False	string
tc	TC	Timer T309 Counter Value {0-7}	False	string
ts	TS	TS Service for Network VCM {0-1}	False	string
cdcspd	CDCSPD	Conversion rate of voice Codec (Kbps) {0-31}	False	string
dvrst	DVRST	Call restriction while Tie line is backed up on ISDN {0-3}	False	string
rsct	RSCT	Call restriction by temporary route Information {0-1}	False	string
rocg	ROCG	Outgoing Call account by Temporary Route Information {0-1}	False	string
ricg	RICG	Outgoing Call account by Temporary Route Information {0-1}	False	string
stsenq	STSENQ	Status inquiry Message Send {0-1}	False	string
mmnpass	MMNPASS	APEX Only {0-1}	False	string
dltk	DLTK	APEX Only {0-1}	False	string
caln	CALN	APEX Only {0-1}	False	string
netint	NETINT	APEX Only {0-15}	False	string
inband	INBAND	APEX Only {0-1}	False	string
retmsg	RETMSG	Message Sent When ISDN Call is connected to ACD {0-1}	False	string
ani	ANI	Timing to demand ANI information {0-7}	False	string
srv	SRV	Addition service selection {0-255}	False	string
ton	TON	Type of number {0-7}	False	string
npi	NPI	Numbering plan identification {0-15}	False	string
l_t	L_T	Local/Toll {0-1}	False	string
eccis	ECCIS	VT(E-CCIS) Route {0-1}	False	string
eccistm	ECCISTM	VT(E-CCIS) Miscellaneous Timer Counter {0-15}	False	string
eccisob	ECCISOB	VT(E-CCIS) Miscellaneous Timer Counter {0-1}	False	string
eccisib	ECCISIB	VT(E-CCIS) IC SMDR {0-1}	False	string
spmet	SPMET	Account Pulse Watch Control {0-3}	False	string
idrt	IDRT	ID Code Specification {0-1}	False	string
eccistd	ECCISTD	VT (E-CCIS) Type of Dialing {0-1}	False	string
mfcg2	MFCG2	MFC Outgoing Call G2 {0-1}	False	string
opcc	OPCC	Optimal Call Control {0-1}	False	string
ictcon	ICTCON	ICT Control : Japan Only {0-1}	False	string
vrd	VRD	Voice Recognize Dial : Japan Only {0-1}	False	string
intd	INTD	Interface Detail {0-2}	False	string
jeccis	JECCIS	Common use with E-CCIS RT {0-1}	False	string
eccis2	ECCIS2	E-CCIS System {0-3}	False	string
ipint	IPINT	Public PCS Protocol {0-15}	False	string
iptrk	IPTRK	IP Trunk {0-1}	False	string
ctcf	CTCF	Call Transfer,Call Forwarding Q-SIG Supplementary Service {0-1}	False	string
rert	RERT	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting {0-1}	False	string
dcans	DCANS	Answer When DC Dialing {0-1}	False	string
rnd	RND	Trunk Select Data in Round Robin Formula {0-1}	False	string
clbk	CLBK	Collect Call Blocking {0-1}	False	string
ualaw	UALAW	User information layer 1 protocol {0-3}	False	string
mctfac	MCTFAC	MCT(MCID) service send message {0-1}	False	string
re	RE	Recall Supplementary Service {0-1}	False	string
pr	PR	Path Replacement Additional Network Feature {0-1}	False	string
cot	COT	Continuity check for Signaling System No.7 {0-1}	False	string
ss7	SS7	Signaling System No.7 {0-1}	False	string
ni2id	NI2ID	Network Identifier for NI-2 {0-15}	False	string
clrf	CLRF	CCIS Link Reconnection for Netfusing {0-1}	False	string
trc	TRC	Transit Counter {0-1}	False	string
oid	OID	Object ID in Facility IE {0-1}	False	string
phg	PHG	PHG Service {0-1}	False	string
vir	VIR	Virtual IR {0-3}	False	string
kanji	KANJI	Intra-office Name Display by KANJI {0-1}	False	string
csmds	CSMDS	SMDS and Customers Satisfaction Report Definition {0-15}	False	string
fxd	FXD	FAX data enable {0-1}	False	string
fxjs	FXJS	Jitter buffer size for FAX {0-30}	False	string
fxpt	FXPT	Payload type for FAX {0-6}	False	string
fxps	FXPS	Payload size for FAX {0-4}	False	string
cpi	CPI	CPI set up {0-1}	False	string
e911	E911	911 Outgoing Route {0-1}	False	string
ra_rt	RA_RT	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG) {0-1}	False	string
clicf	CLICF	CLIP/CLIR is chosen at the time of call forwarding {0-1}	False	string
ftrks	FTRKS	Flexible Trunk select {0-3}	False	string
ioname	IONAME	IONAME {0-3}	False	string
bnovr	BNOVR	BNOVR {0-1}	False	string
fdisc	FDISC	FDISC {0-3}	False	string
b2bua	B2BUA	B2BUA {0-1}	False	string
colp	COLP	COLP {0-1}	False	string
adrsing	ADRSING	Addressing Service {0-1}	False	string
ovrrcv	OVRRCV	Overlap Receiving Service {0-1}	False	string
ovrsnd	OVRSND	Overlap Sending Service {0-1}	False	string
ovrsdc	OVRSDC	Overlap Send Digits {0-20}	False	string
region	REGION	Regional Interface {0-15}	False	string
smds5	SMDS5	'TRK Received Time' and 'Abandoned Call' SMDS Output {0-1}	False	string
eu_opt	EU_OPT	'ETSI ISDN Option Data {0-3}	False	string
ebdc	EBDC	'Digit Code of Called party number(for Enblock dialing) {0-32}	False	string
iccbs	ICCBS	Isdn CCBS(Completion of Calls to Busy Subscriber) {0-1}	False	string
b2binum	B2BINUM	B2BUA Calling Number Notify Service {0-1}	False	string
monitor	MONITOR	ACD monitor link connection {0-1}	False	string
mgsipsv	MGSIPSV	MG(SIP) Additional Service {0-15}	False	string
rsta	RSTA	Send Restart Ack Signal to the Public Network {0-1}	False	string
msrt	MSRT	Mobile Service {0-1}	False	string
tcgni	TCGNI	Transfer Calling Number Incoming {0-1}	False	string
tcgno	TCGNO	Transfer Calling Number Outgoing {0-1}	False	string
siptone	SIPTONE	SIP Congestion Tone Sending {0-1}	False	string
oaiinfo	OAIINFO	OAI INFO Signal Sending Service {0-2}	False	string
msccnt	MSCCNT	Call Forwarding Music Silent Change Control {0-1}	False	string
tcgnc	TCGNC	Transfer Calling Number to CCIS {0-1}	False	string
prtcc	PRTCC	Primary Route for CPN Conversion : North America Only {0-255}	False	string
guidance	GUIDANCE	Route of Guidance {0-1}	False	string
loop	LOOP	Loop Detection {0-1}	False	string
sd183sdp	SD183SDP	PROGRESS Sending to MG-SIP {0-1}	False	string
ref_grp	REF_GRP	REFER transfer group {0-7}	False	string
mltmedia	MLTMEDIA	Multimedia Communication {0-1}	False	string
sip302redirect	SIP302REDIRECT	302 Redirect {0-1}	False	string
acfo_tn	ACFO_TN	ACFO_TN {0-63}	False	string
fmc_mobdn	FMC_MOBDN	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone {0-16}	False	string
fmc_tdm	FMC_TDM	Operation when Incoming from FMC Network in a Tandem Connection {0-1}	False	string
ng911_index	NG911_INDEX	Connection destination index when calling NG911 {0-15}	False	string
histinfo	HISTINFO	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier {0-3}	False	string
histdetail	HISTDETAIL	More information about headers appended with HISTINFO {0-3}	False	string
cloudsv	CLOUDSV	Cloud Service to interwork {0-1}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTI-Delete Trunk Application Data (artiDel)

Deletes the Trunk Application Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTI-Lists Trunk Application Data (artiList)

Lists the Trunk Application Data.

Request Properties

Name	Display	Description	Is Required	Type
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
artiListResponse.count	The count of items.	string
artiListResponse[0].rt	Route Number	string
artiListResponse[0].rst	Assignment of Restart	string
artiListResponse[0].hmt	HMT PKG recognition	string
artiListResponse[0].trcrst	Call Restriction by Information transfer rate in Bearer Capability	string
artiListResponse[0].trsrst	Call Restriction by Information transfer rate in Bearer Capability	string
artiListResponse[0].t309lnk	Assignment of Timer T309 for Data Link Failure	string
artiListResponse[0].t309con	Assignment of Timer T309 for Layer1 Failure	string
artiListResponse[0].llcrst	Call restriction by user rate in Low Layer Capability Information	string
artiListResponse[0].vcm	Recognition for Voice Compression Module(VCM)	string
artiListResponse[0].ovrt	Virtual Tie Line Call service for voice compression	string
artiListResponse[0].pool	Type of Voice Compression Module	string
artiListResponse[0].dtrt	Detection of ALL 1 alarm signal (DTI Layer 1 alarm)	string
artiListResponse[0].tmprt	Temporally Route Information over CCIS/Dp	string
artiListResponse[0].codec	Voice compression algorithm	string
artiListResponse[0].pass	Path through control (This data becomes effective at CODEC is except 0)	string
artiListResponse[0].irl	Clear call when DTI alarm is detected	string
artiListResponse[0].mtc	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds	string
artiListResponse[0].tc	Timer T309 Counter Value	string
artiListResponse[0].ts	TS Service for Network VCM	string
artiListResponse[0].cdcspd	Conversion rate of voice Codec (Kbps)	string
artiListResponse[0].dvrst	Call restriction while Tie line is backed up on ISDN	string
artiListResponse[0].rsct	Call restriction by temporary route Information	string
artiListResponse[0].rocg	Outgoing Call account by Temporary Route Information	string
artiListResponse[0].ricg	Outgoing Call account by Temporary Route Information	string
artiListResponse[0].stsenq	Status inquiry Message Send	string
artiListResponse[0].mmnpass	APEX Only	string
artiListResponse[0].dltk	APEX Only	string
artiListResponse[0].caln	APEX Only	string
artiListResponse[0].netint	APEX Only	string
artiListResponse[0].inband	APEX Only	string
artiListResponse[0].retmsg	Message Sent When ISDN Call is connected to ACD	string
artiListResponse[0].ani	Timing to demand ANI information	string
artiListResponse[0].srv	Addition service selection	string
artiListResponse[0].ton	Type of number	string
artiListResponse[0].npi	Numbering plan identification	string
artiListResponse[0].l_t	Local/Toll	string
artiListResponse[0].eccis	VT(E-CCIS) Route	string
artiListResponse[0].eccistm	VT(E-CCIS) Miscellaneous Timer Counter	string
artiListResponse[0].eccisob	VT(E-CCIS) Miscellaneous Timer Counter	string
artiListResponse[0].eccisib	VT(E-CCIS) IC SMDR	string
artiListResponse[0].spmet	Account Pulse Watch Control	string
artiListResponse[0].idrt	ID Code Specification	string
artiListResponse[0].eccistd	VT (E-CCIS) Type of Dialing	string
artiListResponse[0].mfcg2	MFC Outgoing Call G2	string
artiListResponse[0].opcc	Optimal Call Control	string
artiListResponse[0].ictcon	ICT Control : Japan Only	string
artiListResponse[0].vrd	Voice Recognize Dial : Japan Only	string
artiListResponse[0].intd	Interface Detail	string
artiListResponse[0].jeccis	Common use with E-CCIS RT	string
artiListResponse[0].eccis2	E-CCIS System	string
artiListResponse[0].ipint	Public PCS Protocol	string
artiListResponse[0].iptrk	IP Trunk	string
artiListResponse[0].ctcf	Call Transfer,Call Forwarding Q-SIG Supplementary Service	string
artiListResponse[0].rert	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting	string
artiListResponse[0].dcans	Answer When DC Dialing	string
artiListResponse[0].rnd	Trunk Select Data in Round Robin Formula	string
artiListResponse[0].clbk	Collect Call Blocking	string
artiListResponse[0].ualaw	User information layer 1 protocol	string
artiListResponse[0].mctfac	MCT(MCID) service send message	string
artiListResponse[0].re	Recall Supplementary Service	string
artiListResponse[0].pr	Path Replacement Additional Network Feature	string
artiListResponse[0].cot	Continuity check for Signaling System No.7	string
artiListResponse[0].ss7	Signaling System No.7	string
artiListResponse[0].ni2id	Network Identifier for NI-2	string
artiListResponse[0].clrf	CCIS Link Reconnection for Netfusing	string
artiListResponse[0].trc	Transit Counter	string
artiListResponse[0].oid	Object ID in Facility IE	string
artiListResponse[0].phg	PHG Service	string
artiListResponse[0].vir	Virtual IR	string
artiListResponse[0].kanji	Intra-office Name Display by KANJI	string
artiListResponse[0].csmds	SMDS and Customers Satisfaction Report Definition	string
artiListResponse[0].fxd	FAX data enable	string
artiListResponse[0].fxjs	Jitter buffer size for FAX	string
artiListResponse[0].fxpt	Payload type for FAX	string
artiListResponse[0].fxps	Payload size for FAX	string
artiListResponse[0].cpi	CPI set up	string
artiListResponse[0].e911	911 Outgoing Route	string
artiListResponse[0].ra_rt	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG)	string
artiListResponse[0].clicf	CLIP/CLIR is chosen at the time of call forwarding	string
artiListResponse[0].ftrks	Flexible Trunk select	string
artiListResponse[0].ioname	IONAME	string
artiListResponse[0].bnovr	BNOVR	string
artiListResponse[0].fdisc	FDISC	string
artiListResponse[0].b2bua	B2BUA	string
artiListResponse[0].colp	COLP	string
artiListResponse[0].adrsing	Addressing Service	string
artiListResponse[0].ovrrcv	Overlap Receiving Service	string
artiListResponse[0].ovrsnd	Overlap Sending Service	string
artiListResponse[0].ovrsdc	Overlap Send Digits	string
artiListResponse[0].region	Regional Interface	string
artiListResponse[0].smds5	'TRK Received Time' and 'Abandoned Call' SMDS Output	string
artiListResponse[0].eu_opt	'ETSI ISDN Option Data	string
artiListResponse[0].EBDC	'Digit Code of Called party number(for Enblock dialing)	string
artiListResponse[0].iccbs	Isdn CCBS(Completion of Calls to Busy Subscriber)	string
artiListResponse[0].b2binum	B2BUA Calling Number Notify Service	string
artiListResponse[0].monitor	ACD monitor link connection	string
artiListResponse[0].mgsipsv	MG(SIP) Additional Service	string
artiListResponse[0].rsta	Send Restart Ack Signal to the Public Network	string
artiListResponse[0].msrt	Mobile Service	string
artiListResponse[0].tcgni	Transfer Calling Number Incoming	string
artiListResponse[0].tcgno	Transfer Calling Number Outgoing	string
artiListResponse[0].siptone	SIP Congestion Tone Sending	string
artiListResponse[0].oaiinfo	OAI INFO Signal Sending Service	string
artiListResponse[0].msccnt	Call Forwarding Music Silent Change Control	string
artiListResponse[0].tcgnc	Transfer Calling Number to CCIS	string
artiListResponse[0].prtcc	Primary Route for CPN Conversion : North America Only	string
artiListResponse[0].guidance	Route of Guidance	string
artiListResponse[0].loop	Loop Detection	string
artiListResponse[0].sd183sdp	PROGRESS Sending to MG-SIP	string
artiListResponse[0].ref_grp	REFER transfer group	string
artiListResponse[0].mltmedia	Multimedia Communication	string
artiListResponse[0].sip302redirect	302 Redirect	string
artiListResponse[0].acfo_tn	ACFO_TN	string
artiListResponse[0].fmc_mobdn	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone	string
artiListResponse[0].fmc_tdm	Operation when Incoming from FMC Network in a Tandem Connection	string
artiListResponse[0].ng911_index	Connection destination index when calling NG911	string
artiListResponse[0].histinfo	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier	string
artiListResponse[0].histdetail	More information about headers appended with HISTINFO	string
artiListResponse[0].cloudsv	Cloud Service to interwork	string

ARTIN-Get Trunk Application Data For NDM (artinGet)

Gets the Trunk Application Data For NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
rst	Assignment of Restart	string
hmt	HMT PKG recognition	string
trcrst	Call Restriction by Information transfer rate in Bearer Capability	string
trsrst	Call Restriction by Information transfer rate in Bearer Capability	string
t309lnk	Assignment of Timer T309 for Data Link Failure	string
t309con	Assignment of Timer T309 for Layer1 Failure	string
llcrst	Call restriction by user rate in Low Layer Capability Information	string
vcm	Recognition for Voice Compression Module(VCM)	string
ovrt	Virtual Tie Line Call service for voice compression	string
pool	Type of Voice Compression Module	string
dtrt	Detection of ALL 1 alarm signal (DTI Layer 1 alarm)	string
tmprt	Temporally Route Information over CCIS/Dp	string
codec	Voice compression algorithm	string
pass	Path through control (This data becomes effective at CODEC is except 0)	string
irl	Clear call when DTI alarm is detected	string
mtc	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds	string
tc	Timer T309 Counter Value	string
ts	TS Service for Network VCM	string
cdcspd	Conversion rate of voice Codec (Kbps)	string
dvrst	Call restriction while Tie line is backed up on ISDN	string
rsct	Call restriction by temporary route Information	string
rocg	Outgoing Call account by Temporary Route Information	string
ricg	Outgoing Call account by Temporary Route Information	string
stsenq	Status inquiry Message Send	string
mmnpass	APEX Only	string
dltk	APEX Only	string
caln	APEX Only	string
netint	APEX Only	string
inband	APEX Only	string
RETMSG	Message Sent When ISDN Call is connected to ACD	string
ani	Timing to demand ANI information	string
srv	Addition service selection	string
ton	Type of number	string
npi	Numbering plan identification	string
l_t	Local/Toll	string
eccis	VT(E-CCIS) Route	string
eccistm	VT(E-CCIS) Miscellaneous Timer Counter	string
eccisob	VT(E-CCIS) Miscellaneous Timer Counter	string
eccisib	VT(E-CCIS) IC SMDR	string
spmet	Account Pulse Watch Control	string
idrt	ID Code Specification	string
eccistd	VT (E-CCIS) Type of Dialing	string
mfcg2	MFC Outgoing Call G2	string
opcc	Optimal Call Control	string
ictcon	ICT Control : Japan Only	string
vrd	Voice Recognize Dial : Japan Only	string
intd	Interface Detail	string
jeccis	Common use with E-CCIS RT	string
eccis2	E-CCIS System	string
ipint	Public PCS Protocol	string
iptrk	IP Trunk	string
ctcf	Call Transfer,Call Forwarding Q-SIG Supplementary Service	string
rert	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting	string
dcans	Answer When DC Dialing	string
rnd	Trunk Select Data in Round Robin Formula	string
clbk	Collect Call Blocking	string
ualaw	User information layer 1 protocol	string
mctfac	MCT(MCID) service send message	string
re	Recall Supplementary Service	string
pr	Path Replacement Additional Network Feature	string
cot	Continuity check for Signaling System No.7	string
ss7	Signaling System No.7	string
ni2id	Network Identifier for NI-2	string
clrf	CCIS Link Reconnection for Netfusing	string
trc	Transit Counter	string
oid	Object ID in Facility IE	string
phg	PHG Service	string
vir	Virtual IR	string
kanji	Intra-office Name Display by KANJI	string
csmds	SMDS and Customers Satisfaction Report Definition	string
fxd	FAX data enable	string
fxjs	Jitter buffer size for FAX	string
fxpt	Payload type for FAX	string
fxps	Payload size for FAX	string
cpi	CPI set up	string
e911	911 Outgoing Route	string
ra_rt	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG)	string
clicf	CLIP/CLIR is chosen at the time of call forwarding	string
ftrks	Flexible Trunk select	string
ioname	IONAME	string
bnovr	BNOVR	string
fdisc	FDISC	string
b2bua	B2BUA	string
colp	COLP	string
adrsing	Addressing Service	string
ovrrcv	Overlap Receiving Service	string
ovrsnd	Overlap Sending Service	string
ovrsdc	Overlap Send Digits	string
region	Regional Interface	string
smds5	'TRK Received Time' and 'Abandoned Call' SMDS Output	string
eu_opt	'ETSI ISDN Option Data	string
EBDC	'Digit Code of Called party number(for Enblock dialing)	string
iccbs	Isdn CCBS(Completion of Calls to Busy Subscriber)	string
b2binum	B2BUA Calling Number Notify Service	string
monitor	ACD monitor link connection	string
mgsipsv	MG(SIP) Additional Service	string
rsta	Send Restart Ack Signal to the Public Network	string
msrt	Mobile Service	string
tcgni	Transfer Calling Number Incoming	string
tcgno	Transfer Calling Number Outgoing	string
siptone	SIP Congestion Tone Sending	string
oaiinfo	OAI INFO Signal Sending Service	string
msccnt	Call Forwarding Music Silent Change Control	string
tcgnc	Transfer Calling Number to CCIS	string
prtcc	Primary Route for CPN Conversion : North America Only	string
guidance	Route of Guidance	string
loop	Loop Detection	string
sd183sdp	PROGRESS Sending to MG-SIP	string
ref_grp	REFER transfer group	string
mltmedia	Multimedia Communication	string
sip302redirect	302 Redirect	string
acfo_tn	ACFO_TN	string
fmc_mobdn	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone	string
fmc_tdm	Operation when Incoming from FMC Network in a Tandem Connection	string
ng911_index	Connection destination index when calling NG911	string
histinfo	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier	string
histdetail	More information about headers appended with HISTINFO	string
cloudsv	Cloud Service to interwork	string

ARTIN-Set Trunk Application Data For NDM (artinSet)

Sets the Trunk Application Data For NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
rst	RST	Assignment of Restart {0-3}	False	string
hmt	HMT	HMT PKG recognition {0-3}	False	string
trcrst	TRCRST	Call Restriction by Information transfer rate in Bearer Capability {0-15}	False	string
trsrst	TRSRST	Call Restriction by Information transfer rate in Bearer Capability {0-15}	False	string
t309lnk	T309LNK	Assignment of Timer T309 for Data Link Failure {0-3}	False	string
t309con	T309CON	Assignment of Timer T309 for Layer1 Failure {0-3}	False	string
llcrst	LLCRST	Call restriction by user rate in Low Layer Capability Information {0-31}	False	string
vcm	VCM	Recognition for Voice Compression Module(VCM) {0-3}	False	string
ovrt	OVRT	Virtual Tie Line Call service for voice compression {0-1}	False	string
pool	POOL	Type of Voice Compression Module {0-1}	False	string
dtrt	DTRT	Detection of ALL 1 alarm signal (DTI Layer 1 alarm) {0-3}	False	string
tmprt	TMPRT	Temporally Route Information over CCIS/Dp {0-1}	False	string
codec	CODEC	Voice compression algorithm {0-3}	False	string
pass	PASS	Path through control (This data becomes effective at CODEC is except 0) {0-1}	False	string
irl	IRL	Clear call when DTI alarm is detected {0-1}	False	string
mtc	MTC	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds {0-15}	False	string
tc	TC	Timer T309 Counter Value {0-7}	False	string
ts	TS	TS Service for Network VCM {0-1}	False	string
cdcspd	CDCSPD	Conversion rate of voice Codec (Kbps) {0-31}	False	string
dvrst	DVRST	Call restriction while Tie line is backed up on ISDN {0-3}	False	string
rsct	RSCT	Call restriction by temporary route Information {0-1}	False	string
rocg	ROCG	Outgoing Call account by Temporary Route Information {0-1}	False	string
ricg	RICG	Outgoing Call account by Temporary Route Information {0-1}	False	string
stsenq	STSENQ	Status inquiry Message Send {0-1}	False	string
mmnpass	MMNPASS	APEX Only {0-1}	False	string
dltk	DLTK	APEX Only {0-1}	False	string
caln	CALN	APEX Only {0-1}	False	string
netint	NETINT	APEX Only {0-15}	False	string
inband	INBAND	APEX Only {0-1}	False	string
RETMSG	RETMSG	Message Sent When ISDN Call is connected to ACD {0-1}	False	string
ani	ANI	Timing to demand ANI information {0-7}	False	string
srv	SRV	Addition service selection {0-255}	False	string
ton	TON	Type of number {0-7}	False	string
npi	NPI	Numbering plan identification {0-15}	False	string
l_t	L_T	Local/Toll {0-1}	False	string
eccis	ECCIS	VT(E-CCIS) Route {0-1}	False	string
eccistm	ECCISTM	VT(E-CCIS) Miscellaneous Timer Counter {0-15}	False	string
eccisob	ECCISOB	VT(E-CCIS) Miscellaneous Timer Counter {0-1}	False	string
eccisib	ECCISIB	VT(E-CCIS) IC SMDR {0-1}	False	string
spmet	SPMET	Account Pulse Watch Control {0-3}	False	string
idrt	IDRT	ID Code Specification {0-1}	False	string
eccistd	ECCISTD	VT (E-CCIS) Type of Dialing {0-1}	False	string
mfcg2	MFCG2	MFC Outgoing Call G2 {0-1}	False	string
opcc	OPCC	Optimal Call Control {0-1}	False	string
ictcon	ICTCON	ICT Control : Japan Only {0-1}	False	string
vrd	VRD	Voice Recognize Dial : Japan Only {0-1}	False	string
intd	INTD	Interface Detail {0-2}	False	string
jeccis	JECCIS	Common use with E-CCIS RT {0-1}	False	string
eccis2	ECCIS2	E-CCIS System {0-3}	False	string
ipint	IPINT	Public PCS Protocol {0-15}	False	string
iptrk	IPTRK	IP Trunk {0-1}	False	string
ctcf	CTCF	Call Transfer,Call Forwarding Q-SIG Supplementary Service {0-1}	False	string
rert	RERT	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting {0-1}	False	string
dcans	DCANS	Answer When DC Dialing {0-1}	False	string
rnd	RND	Trunk Select Data in Round Robin Formula {0-1}	False	string
clbk	CLBK	Collect Call Blocking {0-1}	False	string
ualaw	UALAW	User information layer 1 protocol {0-3}	False	string
mctfac	MCTFAC	MCT(MCID) service send message {0-1}	False	string
re	RE	Recall Supplementary Service {0-1}	False	string
pr	PR	Path Replacement Additional Network Feature {0-1}	False	string
cot	COT	Continuity check for Signaling System No.7 {0-1}	False	string
ss7	SS7	Signaling System No.7 {0-1}	False	string
ni2id	NI2ID	Network Identifier for NI-2 {0-15}	False	string
clrf	CLRF	CCIS Link Reconnection for Netfusing {0-1}	False	string
trc	TRC	Transit Counter {0-1}	False	string
oid	OID	Object ID in Facility IE {0-1}	False	string
phg	PHG	PHG Service {0-1}	False	string
vir	VIR	Virtual IR {0-3}	False	string
kanji	KANJI	Intra-office Name Display by KANJI {0-1}	False	string
csmds	CSMDS	SMDS and Customers Satisfaction Report Definition {0-15}	False	string
fxd	FXD	FAX data enable {0-1}	False	string
fxjs	FXJS	Jitter buffer size for FAX {0-30}	False	string
fxpt	FXPT	Payload type for FAX {0-6}	False	string
fxps	FXPS	Payload size for FAX {0-4}	False	string
cpi	CPI	CPI set up {0-1}	False	string
e911	E911	911 Outgoing Route {0-1}	False	string
ra_rt	RA_RT	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG) {0-1}	False	string
clicf	CLICF	CLIP/CLIR is chosen at the time of call forwarding {0-1}	False	string
ftrks	FTRKS	Flexible Trunk select {0-3}	False	string
ioname	IONAME	IONAME {0-3}	False	string
bnovr	BNOVR	BNOVR {0-1}	False	string
fdisc	FDISC	FDISC {0-3}	False	string
b2bua	B2BUA	B2BUA {0-1}	False	string
colp	COLP	COLP {0-1}	False	string
adrsing	ADRSING	Addressing Service {0-1}	False	string
ovrrcv	OVRRCV	Overlap Receiving Service {0-1}	False	string
ovrsnd	OVRSND	Overlap Sending Service {0-1}	False	string
ovrsdc	OVRSDC	Overlap Send Digits {0-20}	False	string
region	REGION	Regional Interface {0-15}	False	string
smds5	SMDS5	'TRK Received Time' and 'Abandoned Call' SMDS Output {0-1}	False	string
eu_opt	EU_OPT	'ETSI ISDN Option Data {0-3}	False	string
EBDC	EBDC	'Digit Code of Called party number(for Enblock dialing) {0-32}	False	string
iccbs	ICCBS	Isdn CCBS(Completion of Calls to Busy Subscriber) {0-1}	False	string
b2binum	B2BINUM	B2BUA Calling Number Notify Service {0-1}	False	string
monitor	MONITOR	ACD monitor link connection {0-1}	False	string
mgsipsv	MGSIPSV	MG(SIP) Additional Service {0-15}	False	string
rsta	RSTA	Send Restart Ack Signal to the Public Network {0-1}	False	string
msrt	MSRT	Mobile Service {0-1}	False	string
tcgni	TCGNI	Transfer Calling Number Incoming {0-1}	False	string
tcgno	TCGNO	Transfer Calling Number Outgoing {0-1}	False	string
siptone	SIPTONE	SIP Congestion Tone Sending {0-1}	False	string
oaiinfo	OAIINFO	OAI INFO Signal Sending Service {0-2}	False	string
msccnt	MSCCNT	Call Forwarding Music Silent Change Control {0-1}	False	string
tcgnc	TCGNC	Transfer Calling Number to CCIS {0-1}	False	string
prtcc	PRTCC	Primary Route for CPN Conversion : North America Only {0-255}	False	string
guidance	GUIDANCE	Route of Guidance {0-1}	False	string
loop	LOOP	Loop Detection {0-1}	False	string
sd183sdp	SD183SDP	PROGRESS Sending to MG-SIP {0-1}	False	string
ref_grp	REF_GRP	REFER transfer group {0-7}	False	string
mltmedia	MLTMEDIA	Multimedia Communication {0-1}	False	string
sip302redirect	SIP302REDIRECT	302 Redirect {0-1}	False	string
acfo_tn	ACFO_TN	ACFO_TN {0-63}	False	string
fmc_mobdn	FMC_MOBDN	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone {0-16}	False	string
fmc_tdm	FMC_TDM	Operation when Incoming from FMC Network in a Tandem Connection {0-1}	False	string
ng911_index	NG911_INDEX	Connection destination index when calling NG911 {0-15}	False	string
histinfo	HISTINFO	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier {0-3}	False	string
histdetail	HISTDETAIL	More information about headers appended with HISTINFO {0-3}	False	string
cloudsv	CLOUDSV	Cloud Service to interwork {0-1}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTIN-Delete Trunk Application Data For NDM (artinDel)

Deletes the Trunk Application Data For NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTIN-Lists Trunk Application Data For NDM (artinList)

Lists the Trunk Application Data For NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
artinListResponse.count	The count of items.	string
artinListResponse[0].lgrt	Logical Route Number	string
artinListResponse[0].rst	Assignment of Restart	string
artinListResponse[0].hmt	HMT PKG recognition	string
artinListResponse[0].trcrst	Call Restriction by Information transfer rate in Bearer Capability	string
artinListResponse[0].trsrst	Call Restriction by Information transfer rate in Bearer Capability	string
artinListResponse[0].t309lnk	Assignment of Timer T309 for Data Link Failure	string
artinListResponse[0].t309con	Assignment of Timer T309 for Layer1 Failure	string
artinListResponse[0].llcrst	Call restriction by user rate in Low Layer Capability Information	string
artinListResponse[0].vcm	Recognition for Voice Compression Module(VCM)	string
artinListResponse[0].ovrt	Virtual Tie Line Call service for voice compression	string
artinListResponse[0].pool	Type of Voice Compression Module	string
artinListResponse[0].dtrt	Detection of ALL 1 alarm signal (DTI Layer 1 alarm)	string
artinListResponse[0].tmprt	Temporally Route Information over CCIS/Dp	string
artinListResponse[0].codec	Voice compression algorithm	string
artinListResponse[0].pass	Path through control (This data becomes effective at CODEC is except 0)	string
artinListResponse[0].irl	Clear call when DTI alarm is detected	string
artinListResponse[0].mtc	Assignment of Timer T309 Value, Restoration timer TC*MTC=Seconds	string
artinListResponse[0].tc	Timer T309 Counter Value	string
artinListResponse[0].ts	TS Service for Network VCM	string
artinListResponse[0].cdcspd	Conversion rate of voice Codec (Kbps)	string
artinListResponse[0].dvrst	Call restriction while Tie line is backed up on ISDN	string
artinListResponse[0].rsct	Call restriction by temporary route Information	string
artinListResponse[0].rocg	Outgoing Call account by Temporary Route Information	string
artinListResponse[0].ricg	Outgoing Call account by Temporary Route Information	string
artinListResponse[0].stsenq	Status inquiry Message Send	string
artinListResponse[0].mmnpass	APEX Only	string
artinListResponse[0].dltk	APEX Only	string
artinListResponse[0].caln	APEX Only	string
artinListResponse[0].netint	APEX Only	string
artinListResponse[0].inband	APEX Only	string
artinListResponse[0].retmsg	Message Sent When ISDN Call is connected to ACD	string
artinListResponse[0].ani	Timing to demand ANI information	string
artinListResponse[0].srv	Addition service selection	string
artinListResponse[0].ton	Type of number	string
artinListResponse[0].npi	Numbering plan identification	string
artinListResponse[0].l_t	Local/Toll	string
artinListResponse[0].eccis	VT(E-CCIS) Route	string
artinListResponse[0].eccistm	VT(E-CCIS) Miscellaneous Timer Counter	string
artinListResponse[0].eccisob	VT(E-CCIS) Miscellaneous Timer Counter	string
artinListResponse[0].eccisib	VT(E-CCIS) IC SMDR	string
artinListResponse[0].spmet	Account Pulse Watch Control	string
artinListResponse[0].idrt	ID Code Specification	string
artinListResponse[0].eccistd	VT (E-CCIS) Type of Dialing	string
artinListResponse[0].mfcg2	MFC Outgoing Call G2	string
artinListResponse[0].opcc	Optimal Call Control	string
artinListResponse[0].ictcon	ICT Control : Japan Only	string
artinListResponse[0].vrd	Voice Recognize Dial : Japan Only	string
artinListResponse[0].intd	Interface Detail	string
artinListResponse[0].jeccis	Common use with E-CCIS RT	string
artinListResponse[0].eccis2	E-CCIS System	string
artinListResponse[0].ipint	Public PCS Protocol	string
artinListResponse[0].iptrk	IP Trunk	string
artinListResponse[0].ctcf	Call Transfer,Call Forwarding Q-SIG Supplementary Service	string
artinListResponse[0].rert	Call Transfer, Call Forwarding QSIG Supplementary Service with Rerouting	string
artinListResponse[0].dcans	Answer When DC Dialing	string
artinListResponse[0].rnd	Trunk Select Data in Round Robin Formula	string
artinListResponse[0].clbk	Collect Call Blocking	string
artinListResponse[0].ualaw	User information layer 1 protocol	string
artinListResponse[0].mctfac	MCT(MCID) service send message	string
artinListResponse[0].re	Recall Supplementary Service	string
artinListResponse[0].pr	Path Replacement Additional Network Feature	string
artinListResponse[0].cot	Continuity check for Signaling System No.7	string
artinListResponse[0].ss7	Signaling System No.7	string
artinListResponse[0].ni2id	Network Identifier for NI-2	string
artinListResponse[0].clrf	CCIS Link Reconnection for Netfusing	string
artinListResponse[0].trc	Transit Counter	string
artinListResponse[0].oid	Object ID in Facility IE	string
artinListResponse[0].phg	PHG Service	string
artinListResponse[0].vir	Virtual IR	string
artinListResponse[0].kanji	Intra-office Name Display by KANJI	string
artinListResponse[0].csmds	SMDS and Customers Satisfaction Report Definition	string
artinListResponse[0].fxd	FAX data enable	string
artinListResponse[0].fxjs	Jitter buffer size for FAX	string
artinListResponse[0].fxpt	Payload type for FAX	string
artinListResponse[0].fxps	Payload size for FAX	string
artinListResponse[0].cpi	CPI set up	string
artinListResponse[0].e911	911 Outgoing Route	string
artinListResponse[0].ra_rt	Register Trunk used at the time of Remote Access to PBX operation(SIP-MG)	string
artinListResponse[0].clicf	CLIP/CLIR is chosen at the time of call forwarding	string
artinListResponse[0].ftrks	Flexible Trunk select	string
artinListResponse[0].ioname	IONAME	string
artinListResponse[0].bnovr	BNOVR	string
artinListResponse[0].fdisc	FDISC	string
artinListResponse[0].b2bua	B2BUA	string
artinListResponse[0].colp	COLP	string
artinListResponse[0].adrsing	Addressing Service	string
artinListResponse[0].ovrrcv	Overlap Receiving Service	string
artinListResponse[0].ovrsnd	Overlap Sending Service	string
artinListResponse[0].ovrsdc	Overlap Send Digits	string
artinListResponse[0].region	Regional Interface	string
artinListResponse[0].smds5	'TRK Received Time' and 'Abandoned Call' SMDS Output	string
artinListResponse[0].eu_opt	'ETSI ISDN Option Data	string
artinListResponse[0].EBDC	'Digit Code of Called party number(for Enblock dialing)	string
artinListResponse[0].iccbs	Isdn CCBS(Completion of Calls to Busy Subscriber)	string
artinListResponse[0].b2binum	B2BUA Calling Number Notify Service	string
artinListResponse[0].monitor	ACD monitor link connection	string
artinListResponse[0].mgsipsv	MG(SIP) Additional Service	string
artinListResponse[0].rsta	Send Restart Ack Signal to the Public Network	string
artinListResponse[0].msrt	Mobile Service	string
artinListResponse[0].tcgni	Transfer Calling Number Incoming	string
artinListResponse[0].tcgno	Transfer Calling Number Outgoing	string
artinListResponse[0].siptone	SIP Congestion Tone Sending	string
artinListResponse[0].oaiinfo	OAI INFO Signal Sending Service	string
artinListResponse[0].msccnt	Call Forwarding Music Silent Change Control	string
artinListResponse[0].tcgnc	Transfer Calling Number to CCIS	string
artinListResponse[0].prtcc	Primary Route for CPN Conversion : North America Only	string
artinListResponse[0].guidance	Route of Guidance	string
artinListResponse[0].loop	Loop Detection	string
artinListResponse[0].sd183sdp	PROGRESS Sending to MG-SIP	string
artinListResponse[0].ref_grp	REFER transfer group	string
artinListResponse[0].mltmedia	Multimedia Communication	string
artinListResponse[0].sip302redirect	302 Redirect	string
artinListResponse[0].acfo_tn	ACFO_TN	string
artinListResponse[0].fmc_mobdn	FMC Extension Collaboration Service/The Number of Digits of the Mobile Phone	string
artinListResponse[0].fmc_tdm	Operation when Incoming from FMC Network in a Tandem Connection	string
artinListResponse[0].ng911_index	Connection destination index when calling NG911	string
artinListResponse[0].histinfo	Notify original CPN to MGSIP when forwarding a call from PSTN to a SIP carrier	string
artinListResponse[0].histdetail	More information about headers appended with HISTINFO	string
artinListResponse[0].cloudsv	Cloud Service to interwork	string

ARTD-Get Route Class Data (artdGet)

Gets the Route Class Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
osgs	Signal Interface for Outgoing	string
onsg	Signal Selection for Outgoing	string
isgs	Signal Interface for Incoming	string
insg	Signal Selection for Incoming	string
tf	Type of Trunk Function	string
tcl	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	string
l_t	Line / Trunk Identification( This data should always be assigned as '1' )	string
rlp	Trunk Release Pattern	string
tq	Outgoing Trunk Queuing	string
smdr	Detailed Billing Information	string
td	Toll Denial-Battery Reversal	string
dr	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	string
ac	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	string
tnt	Tenant Number Check	string
lsg	Line Signal	string
smdr2	Detailed Billing Information	string
h_m	Hotel Service over CCIS	string
mc	TS Service for Network VCM	string
ani	E911-ANI Service	string
d	When assigning this data,'0' should always be entered.	string
msb	When assigning this data,'0' should always be entered.	string
msw	Outgoing Call account by Temporary Route Information	string
tr	GII Signal Override(MFC)	string
oc	Originating Category Request(MFC)	string
r_l	Attendant-Identification of Incoming Trunk Display	string
rvsd	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	string
tl	Tone Level	string
ans	Answer Signal from Trunk Side	string
telp	Time Elapse Indication Service	string
pad	This data determines PAD control on the ODT/DTI circuit card	string
ogrl	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	string
icrl	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	string
hd	Trunk Hold Timing( Normally assigned as '0' )	string
guard	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	string
wink	Width of a Wink Signal( Normally assigned as '0' )	string
vad	When assigning this data, '0' should always be entered.	string
cld	When assigning this data, '0' should always be entered.	string
fa	Forced Account/Forced Authorization Code	string
bc	C.O. Line Idle Balance Condition( Australia ONLY )	string
tcm	Terminal Class Mark	string
tdmq	Tandem Off Hook OG Queuing	string
trsc	Trunk Restriction Class	string
bt	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	string
prv	Line Trunk Privacy	string
a_d	Analog/Digital Line Data	string
cw	Call Waiting Service	string
tpq	Priority OG Queuing	string
bl	Detect of Blocking Signal	string
trks	Trunk Selection Sequence	string
dply	Number Display of Dterm between Office	string
acd	ACD Service	string
_2w_4w	2 Wires/4 Wires	string
faat	Authorization Code for ATT	string
gw	Gateway Option	string
tcma	When assigning this data, '0' should always be entered.	string
smdr3	Detailed Billing for Outgoing in Tandem Connection	string
hdt	Collect Call Blocking	string
cd	Consecutive Dialing	string
cch	CCIS Transmitter/Receiver( Common Channel Handler )	string
tc_ec	When assigning this data, '0' should always be entered.	string
ire	Inter-reringing Signal	string
scr	Step Call Restriction for TIE Line Call	string
lyer1	Layer 1(for ISDN)	string
net	User/Net Identification(for ISDN)	string
int	Interface Specification(for ISDN)	string
dc	Dialed Number Confirmation(for ISDN)	string
hks	Hooking Service	string
scf	Split Call Forwarding	string
smdr4	Detailed Billing for Incoming in Tandem Connection	string
tcmn	Number of digits of TCM(S Code)	string
tcmc	TCM and KP Sending Sequence	string
mfsp	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	string
kpst	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	string
kppt	Pause after KP sending/Originating MFC Backward signal Receive Timer	string
stc	Stop Code	string
mc2	MP Start Cause( This data must always be set to '0' )	string
MT	MF Frequency	string
tone	TONE Destination for TRK Call Termination	string
pptm	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	string
mptm	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	string
lptm	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	string
rsax	When assigning this data, '0' should always be entered.	string
cst	When assigning this data, '0' should always be entered.	string
cseg	When assigning this data, '0' should always be entered.	string
cseu	When assigning this data, '0' should always be entered.	string
csel	When assigning this data, '0' should always be entered.	string
cmp	When assigning this data, '0' should always be entered.	string
talk	When assigning this data, '0' should always be entered.	string
fot	When assigning this data, '0' should always be entered.	string
rst	When assigning this data, '0' should always be entered.	string
toci	Trunk Override Calling	string
tocd	'Trunk Override Called	string
odgd	When assigning this data, '0' should always be entered.	string
rls	When assigning this data, '0' should always be entered.	string
gwd	Gate Way Data Service	string
h1	When assigning this data, '0' should always be entered.	string
dt	When assigning this data, '0' should always be entered.	string
ci	ISDN transmitting information	string
oid	When assigning this data, '0' should always be entered.	string
tks	When assigning this data, '0' should always be entered.	string
pad2	Pad Control Data 2	string
trm	When assigning this data, '0' should always be entered.	string
trpx	When assigning this data, '0' should always be entered.	string
ldr	When assigning this data, '0' should always be entered.	string
tsc	When assigning this data, '0' should always be entered.	string
sats	When assigning this data, '0' should always be entered.	string
rvpx	When assigning this data, '0' should always be entered.	string
dq	When assigning this data, '0' should always be entered.	string
slov	Slumber Time Override Service	string
sdto	System message automatic output when Connection Acknowledge	string
advpra	ISDN PRI Failure Routing Service	string
ind	Inter-office Name Display	string
uui	When assigning this data, '0' should always be entered.	string
dch	When assigning this data, '0' should always be entered.	string
cmrt	Common use of Route Numbers of ISDN trunks	string
pref	When assigning this data, '0' should always be entered.	string
dfs	When assigning this data, '0' should always be entered.	string
bob	When assigning this data, '0' should always be entered.	string
ho1ch	When assigning this data, '0' should always be entered.	string
ifr	Indonesia Compulsion Cut Service	string
conv	SMDR Called Party's Number Conversion	string
orrt	Originally Trunk Information	string
cni	Calling Number Identification Format	string
aoc	AOC kind data	string
mgcot	Media Gateway(Central Office Trunk) use)	string

ARTD-Set Route Class Data (artdSet)

Sets the Route Class Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
osgs	OSGS	Signal Interface for Outgoing	False	string
onsg	ONSG	Signal Selection for Outgoing	False	string
isgs	ISGS	Signal Interface for Incoming	False	string
insg	INSG	Signal Selection for Incoming	False	string
tf	TF	Type of Trunk Function	False	string
tcl	TCL	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	False	string
l_t	L_T	Line / Trunk Identification( This data should always be assigned as '1' )	False	string
rlp	RLP	Trunk Release Pattern	False	string
tq	TQ	Outgoing Trunk Queuing	False	string
smdr	SMDR	Detailed Billing Information	False	string
td	TD	Toll Denial-Battery Reversal	False	string
dr	DR	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	False	string
ac	AC	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	False	string
tnt	TNT	Tenant Number Check	False	string
lsg	LSG	Line Signal	False	string
smdr2	SMDR2	Detailed Billing Information	False	string
h_m	H_M	Hotel Service over CCIS	False	string
mc	MC	TS Service for Network VCM	False	string
ani	ANI	E911-ANI Service	False	string
d	D	When assigning this data,'0' should always be entered.	False	string
msb	MSB	When assigning this data,'0' should always be entered.	False	string
msw	MSW	Outgoing Call account by Temporary Route Information	False	string
tr	TR	GII Signal Override(MFC)	False	string
oc	OC	Originating Category Request(MFC)	False	string
r_l	R_L	Attendant-Identification of Incoming Trunk Display	False	string
rvsd	RVSD	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	False	string
tl	TL	Tone Level	False	string
ans	ANS	Answer Signal from Trunk Side	False	string
telp	TELP	Time Elapse Indication Service	False	string
pad	PAD	This data determines PAD control on the ODT/DTI circuit card	False	string
ogrl	OGRL	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	False	string
icrl	ICRL	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	False	string
hd	HD	Trunk Hold Timing( Normally assigned as '0' )	False	string
guard	GUARD	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	False	string
wink	WINK	Width of a Wink Signal( Normally assigned as '0' )	False	string
vad	VAD	When assigning this data, '0' should always be entered.	False	string
cld	CLD	When assigning this data, '0' should always be entered.	False	string
fa	FA	Forced Account/Forced Authorization Code	False	string
bc	BC	C.O. Line Idle Balance Condition( Australia ONLY )	False	string
tcm	TCM	Terminal Class Mark	False	string
tdmq	TDMQ	Tandem Off Hook OG Queuing	False	string
trsc	TRSC	Trunk Restriction Class	False	string
bt	BT	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	False	string
prv	PRV	Line Trunk Privacy	False	string
a_d	A_D	Analog/Digital Line Data	False	string
cw	CW	Call Waiting Service	False	string
tpq	TPQ	Priority OG Queuing	False	string
bl	BL	Detect of Blocking Signal	False	string
trks	TRKS	Trunk Selection Sequence	False	string
dply	DPLY	Number Display of Dterm between Office	False	string
acd	ACD	ACD Service	False	string
_2w_4w	_2W_4W	2 Wires/4 Wires	False	string
faat	FAAT	Authorization Code for ATT	False	string
gw	GW	Gateway Option	False	string
tcma	TCMA	When assigning this data, '0' should always be entered.	False	string
smdr3	SMDR3	Detailed Billing for Outgoing in Tandem Connection	False	string
hdt	HDT	Collect Call Blocking	False	string
cd	CD	Consecutive Dialing	False	string
cch	CCH	CCIS Transmitter/Receiver( Common Channel Handler )	False	string
tc_ec	TC_EC	When assigning this data, '0' should always be entered.	False	string
ire	IRE	Inter-reringing Signal	False	string
scr	SCR	Step Call Restriction for TIE Line Call	False	string
lyer1	LYER1	Layer 1(for ISDN)	False	string
net	NET	User/Net Identification(for ISDN)	False	string
int	INT	Interface Specification(for ISDN)	False	string
dc	DC	Dialed Number Confirmation(for ISDN)	False	string
hks	HKS	Hooking Service	False	string
scf	SCF	Split Call Forwarding	False	string
smdr4	SMDR4	Detailed Billing for Incoming in Tandem Connection	False	string
tcmn	TCMN	Number of digits of TCM(S Code)	False	string
tcmc	TCMC	TCM and KP Sending Sequence	False	string
mfsp	MFSP	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	False	string
kpst	KPST	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	False	string
kppt	KPPT	Pause after KP sending/Originating MFC Backward signal Receive Timer	False	string
stc	STC	Stop Code	False	string
mc2	MC2	MP Start Cause( This data must always be set to '0' )	False	string
mt	MT	MF Frequency	False	string
tone	TONE	TONE Destination for TRK Call Termination	False	string
pptm	PPTM	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	False	string
mptm	MPTM	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	False	string
lptm	LPTM	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	False	string
rsax	RSAX	When assigning this data, '0' should always be entered.	False	string
cst	CST	When assigning this data, '0' should always be entered.	False	string
cseg	CSEG	When assigning this data, '0' should always be entered.	False	string
cseu	CSEU	When assigning this data, '0' should always be entered.	False	string
csel	CSEL	When assigning this data, '0' should always be entered.	False	string
cmp	CMP	When assigning this data, '0' should always be entered.	False	string
talk	TALK	When assigning this data, '0' should always be entered.	False	string
fot	FOT	When assigning this data, '0' should always be entered.	False	string
rst	RST	When assigning this data, '0' should always be entered.	False	string
toci	TOCI	Trunk Override Calling	False	string
tocd	TOCD	'Trunk Override Called	False	string
odgd	ODGD	When assigning this data, '0' should always be entered.	False	string
rls	RLS	When assigning this data, '0' should always be entered.	False	string
gwd	GWD	Gate Way Data Service	False	string
h1	H1	When assigning this data, '0' should always be entered.	False	string
dt	DT	When assigning this data, '0' should always be entered.	False	string
ci	CI	ISDN transmitting information	False	string
oid	OID	When assigning this data, '0' should always be entered.	False	string
tks	TKS	When assigning this data, '0' should always be entered.	False	string
pad2	PAD2	Pad Control Data 2	False	string
trm	TRM	When assigning this data, '0' should always be entered.	False	string
trpx	TRPX	When assigning this data, '0' should always be entered.	False	string
ldr	LDR	When assigning this data, '0' should always be entered.	False	string
tsc	TSC	When assigning this data, '0' should always be entered.	False	string
sats	SATS	When assigning this data, '0' should always be entered.	False	string
rvpx	RVPX	When assigning this data, '0' should always be entered.	False	string
dq	DQ	When assigning this data, '0' should always be entered.	False	string
slov	SLOV	Slumber Time Override Service	False	string
sdto	SDTO	System message automatic output when Connection Acknowledge	False	string
advpra	ADVPRA	ISDN PRI Failure Routing Service	False	string
ind	IND	Inter-office Name Display	False	string
uui	UUI	When assigning this data, '0' should always be entered.	False	string
dch	DCH	When assigning this data, '0' should always be entered.	False	string
cmrt	CMRT	Common use of Route Numbers of ISDN trunks	False	string
pref	PREF	When assigning this data, '0' should always be entered.	False	string
dfs	DFS	When assigning this data, '0' should always be entered.	False	string
bob	BOB	When assigning this data, '0' should always be entered.	False	string
ho1ch	HO1CH	When assigning this data, '0' should always be entered.	False	string
ifr	IFR	Indonesia Compulsion Cut Service	False	string
conv	CONV	SMDR Called Party's Number Conversion	False	string
orrt	ORRT	Originally Trunk Information	False	string
cni	CNI	Calling Number Identification Format	False	string
aoc	AOC	AOC kind data	False	string
mgcot	MGCOT	Media Gateway(Central Office Trunk) use)	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTD-Delete Route Class Data (artdDel)

Deletes the Route Class Data.

Request Properties

Name	Display	Description	Is Required	Type
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTD-Lists Route Class Data (artdList)

Lists the Route Class Data.

Request Properties

Name	Display	Description	Is Required	Type
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
artdListResponse.count	The count of items.	string
artdListResponse[0].rt	Route Number	string
artdListResponse[0].osgs	Signal Interface for Outgoing	string
artdListResponse[0].onsg	Signal Selection for Outgoing	string
artdListResponse[0].isgs	Signal Interface for Incoming	string
artdListResponse[0].insg	Signal Selection for Incoming	string
artdListResponse[0].tf	Type of Trunk Function	string
artdListResponse[0].tcl	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	string
artdListResponse[0].l_t	Line / Trunk Identification( This data should always be assigned as '1' )	string
artdListResponse[0].rlp	Trunk Release Pattern	string
artdListResponse[0].tq	Outgoing Trunk Queuing	string
artdListResponse[0].smdr	Detailed Billing Information	string
artdListResponse[0].td	Toll Denial-Battery Reversal	string
artdListResponse[0].dr	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	string
artdListResponse[0].ac	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	string
artdListResponse[0].tnt	Tenant Number Check	string
artdListResponse[0].lsg	Line Signal	string
artdListResponse[0].smdr2	Detailed Billing Information	string
artdListResponse[0].h_m	Hotel Service over CCIS	string
artdListResponse[0].mc	TS Service for Network VCM	string
artdListResponse[0].ani	E911-ANI Service	string
artdListResponse[0].d	When assigning this data,'0' should always be entered.	string
artdListResponse[0].msb	When assigning this data,'0' should always be entered.	string
artdListResponse[0].msw	Outgoing Call account by Temporary Route Information	string
artdListResponse[0].tr	GII Signal Override(MFC)	string
artdListResponse[0].oc	Originating Category Request(MFC)	string
artdListResponse[0].r_l	Attendant-Identification of Incoming Trunk Display	string
artdListResponse[0].rvsd	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	string
artdListResponse[0].tl	Tone Level	string
artdListResponse[0].ans	Answer Signal from Trunk Side	string
artdListResponse[0].telp	Time Elapse Indication Service	string
artdListResponse[0].pad	This data determines PAD control on the ODT/DTI circuit card	string
artdListResponse[0].ogrl	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	string
artdListResponse[0].icrl	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	string
artdListResponse[0].hd	Trunk Hold Timing( Normally assigned as '0' )	string
artdListResponse[0].guard	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	string
artdListResponse[0].wink	Width of a Wink Signal( Normally assigned as '0' )	string
artdListResponse[0].vad	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cld	When assigning this data, '0' should always be entered.	string
artdListResponse[0].fa	Forced Account/Forced Authorization Code	string
artdListResponse[0].bc	C.O. Line Idle Balance Condition( Australia ONLY )	string
artdListResponse[0].tcm	Terminal Class Mark	string
artdListResponse[0].tdmq	Tandem Off Hook OG Queuing	string
artdListResponse[0].trsc	Trunk Restriction Class	string
artdListResponse[0].bt	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	string
artdListResponse[0].prv	Line Trunk Privacy	string
artdListResponse[0].a_d	Analog/Digital Line Data	string
artdListResponse[0].cw	Call Waiting Service	string
artdListResponse[0].tpq	Priority OG Queuing	string
artdListResponse[0].bl	Detect of Blocking Signal	string
artdListResponse[0].trks	Trunk Selection Sequence	string
artdListResponse[0].dply	Number Display of Dterm between Office	string
artdListResponse[0].acd	ACD Service	string
artdListResponse[0]._2w_4w	2 Wires/4 Wires	string
artdListResponse[0].faat	Authorization Code for ATT	string
artdListResponse[0].gw	Gateway Option	string
artdListResponse[0].tcma	When assigning this data, '0' should always be entered.	string
artdListResponse[0].smdr3	Detailed Billing for Outgoing in Tandem Connection	string
artdListResponse[0].hdt	Collect Call Blocking	string
artdListResponse[0].cd	Consecutive Dialing	string
artdListResponse[0].cch	CCIS Transmitter/Receiver( Common Channel Handler )	string
artdListResponse[0].tc_ec	When assigning this data, '0' should always be entered.	string
artdListResponse[0].ire	Inter-reringing Signal	string
artdListResponse[0].scr	Step Call Restriction for TIE Line Call	string
artdListResponse[0].lyer1	Layer 1(for ISDN)	string
artdListResponse[0].net	User/Net Identification(for ISDN)	string
artdListResponse[0].int	Interface Specification(for ISDN)	string
artdListResponse[0].dc	Dialed Number Confirmation(for ISDN)	string
artdListResponse[0].hks	Hooking Service	string
artdListResponse[0].scf	Split Call Forwarding	string
artdListResponse[0].smdr4	Detailed Billing for Incoming in Tandem Connection	string
artdListResponse[0].tcmn	Number of digits of TCM(S Code)	string
artdListResponse[0].tcmc	TCM and KP Sending Sequence	string
artdListResponse[0].mfsp	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	string
artdListResponse[0].kpst	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	string
artdListResponse[0].kppt	Pause after KP sending/Originating MFC Backward signal Receive Timer	string
artdListResponse[0].stc	Stop Code	string
artdListResponse[0].mc2	MP Start Cause( This data must always be set to '0' )	string
artdListResponse[0].mt	MF Frequency	string
artdListResponse[0].tone	TONE Destination for TRK Call Termination	string
artdListResponse[0].pptm	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	string
artdListResponse[0].mptm	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	string
artdListResponse[0].lptm	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	string
artdListResponse[0].rsax	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cst	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cseg	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cseu	When assigning this data, '0' should always be entered.	string
artdListResponse[0].csel	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cmp	When assigning this data, '0' should always be entered.	string
artdListResponse[0].talk	When assigning this data, '0' should always be entered.	string
artdListResponse[0].fot	When assigning this data, '0' should always be entered.	string
artdListResponse[0].rst	When assigning this data, '0' should always be entered.	string
artdListResponse[0].toci	Trunk Override Calling	string
artdListResponse[0].tocd	'Trunk Override Called	string
artdListResponse[0].odgd	When assigning this data, '0' should always be entered.	string
artdListResponse[0].rls	When assigning this data, '0' should always be entered.	string
artdListResponse[0].gwd	Gate Way Data Service	string
artdListResponse[0].h1	When assigning this data, '0' should always be entered.	string
artdListResponse[0].dt	When assigning this data, '0' should always be entered.	string
artdListResponse[0].ci	ISDN transmitting information	string
artdListResponse[0].oid	When assigning this data, '0' should always be entered.	string
artdListResponse[0].tks	When assigning this data, '0' should always be entered.	string
artdListResponse[0].pad2	Pad Control Data 2	string
artdListResponse[0].trm	When assigning this data, '0' should always be entered.	string
artdListResponse[0].trpx	When assigning this data, '0' should always be entered.	string
artdListResponse[0].ldr	When assigning this data, '0' should always be entered.	string
artdListResponse[0].tsc	When assigning this data, '0' should always be entered.	string
artdListResponse[0].sats	When assigning this data, '0' should always be entered.	string
artdListResponse[0].rvpx	When assigning this data, '0' should always be entered.	string
artdListResponse[0].dq	When assigning this data, '0' should always be entered.	string
artdListResponse[0].slov	Slumber Time Override Service	string
artdListResponse[0].sdto	System message automatic output when Connection Acknowledge	string
artdListResponse[0].advpra	ISDN PRI Failure Routing Service	string
artdListResponse[0].ind	Inter-office Name Display	string
artdListResponse[0].uui	When assigning this data, '0' should always be entered.	string
artdListResponse[0].dch	When assigning this data, '0' should always be entered.	string
artdListResponse[0].cmrt	Common use of Route Numbers of ISDN trunks	string
artdListResponse[0]pref	When assigning this data, '0' should always be entered.	string
artdListResponse[0]dfs	When assigning this data, '0' should always be entered.	string
artdListResponse[0]bob	When assigning this data, '0' should always be entered.	string
artdListResponse[0]ho1ch	When assigning this data, '0' should always be entered.	string
artdListResponse[0]ifr	Indonesia Compulsion Cut Service	string
artdListResponse[0]conv	SMDR Called Party's Number Conversion	string
artdListResponse[0]orrt	Originally Trunk Information	string
artdListResponse[0]cni	Calling Number Identification Format	string
artdListResponse[0]aoc	AOC kind data	string
artdListResponse[0]mgcot	Media Gateway(Central Office Trunk) use)	string
artdListResponse[0]templateName	Route Class Template Name	string

ARTDN-Get Route Class Data for NDM (artdnGet)

Gets the Route Class Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
osgs	Signal Interface for Outgoing	string
onsg	Signal Selection for Outgoing	string
isgs	Signal Interface for Incoming	string
insg	Signal Selection for Incoming	string
tf	Type of Trunk Function	string
tcl	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	string
l_t	Line / Trunk Identification( This data should always be assigned as '1' )	string
rlp	Trunk Release Pattern	string
tq	Outgoing Trunk Queuing	string
smdr	Detailed Billing Information	string
td	Toll Denial-Battery Reversal	string
dr	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	string
ac	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	string
tnt	Tenant Number Check	string
lsg	Line Signal	string
smdr2	Detailed Billing Information	string
h_m	Hotel Service over CCIS	string
mc	TS Service for Network VCM	string
ani	E911-ANI Service	string
d	When assigning this data,'0' should always be entered.	string
msb	When assigning this data,'0' should always be entered.	string
msw	Outgoing Call account by Temporary Route Information	string
tr	GII Signal Override(MFC)	string
oc	Originating Category Request(MFC)	string
r_l	Attendant-Identification of Incoming Trunk Display	string
rvsd	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	string
tl	Tone Level	string
ans	Answer Signal from Trunk Side	string
telp	Time Elapse Indication Service	string
pad	This data determines PAD control on the ODT/DTI circuit card	string
ogrl	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	string
icrl	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	string
hd	Trunk Hold Timing( Normally assigned as '0' )	string
guard	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	string
wink	Width of a Wink Signal( Normally assigned as '0' )	string
vad	When assigning this data, '0' should always be entered.	string
cld	When assigning this data, '0' should always be entered.	string
fa	Forced Account/Forced Authorization Code	string
bc	C.O. Line Idle Balance Condition( Australia ONLY )	string
tcm	Terminal Class Mark	string
tdmq	Tandem Off Hook OG Queuing	string
trsc	Trunk Restriction Class	string
bt	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	string
prv	Line Trunk Privacy	string
a_d	Analog/Digital Line Data	string
cw	Call Waiting Service	string
tpq	Priority OG Queuing	string
bl	Detect of Blocking Signal	string
trks	Trunk Selection Sequence	string
dply	Number Display of Dterm between Office	string
acd	ACD Service	string
_2w_4w	2 Wires/4 Wires	string
faat	Authorization Code for ATT	string
gw	Gateway Option	string
tcma	When assigning this data, '0' should always be entered.	string
smdr3	Detailed Billing for Outgoing in Tandem Connection	string
hdt	Collect Call Blocking	string
cd	Consecutive Dialing	string
cch	CCIS Transmitter/Receiver( Common Channel Handler )	string
tc_ec	When assigning this data, '0' should always be entered.	string
ire	Inter-reringing Signal	string
scr	Step Call Restriction for TIE Line Call	string
lyer1	Layer 1(for ISDN)	string
net	User/Net Identification(for ISDN)	string
int	Interface Specification(for ISDN)	string
dc	Dialed Number Confirmation(for ISDN)	string
hks	Hooking Service	string
scf	Split Call Forwarding	string
smdr4	Detailed Billing for Incoming in Tandem Connection	string
tcmn	Number of digits of TCM(S Code)	string
tcmc	TCM and KP Sending Sequence	string
mfsp	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	string
kpst	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	string
kppt	Pause after KP sending/Originating MFC Backward signal Receive Timer	string
stc	Stop Code	string
mc2	MP Start Cause( This data must always be set to '0' )	string
MT	MF Frequency	string
tone	TONE Destination for TRK Call Termination	string
pptm	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	string
mptm	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	string
lptm	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	string
rsax	When assigning this data, '0' should always be entered.	string
cst	When assigning this data, '0' should always be entered.	string
cseg	When assigning this data, '0' should always be entered.	string
cseu	When assigning this data, '0' should always be entered.	string
csel	When assigning this data, '0' should always be entered.	string
cmp	When assigning this data, '0' should always be entered.	string
talk	When assigning this data, '0' should always be entered.	string
fot	When assigning this data, '0' should always be entered.	string
rst	When assigning this data, '0' should always be entered.	string
toci	Trunk Override Calling	string
tocd	'Trunk Override Called	string
odgd	When assigning this data, '0' should always be entered.	string
rls	When assigning this data, '0' should always be entered.	string
gwd	Gate Way Data Service	string
h1	When assigning this data, '0' should always be entered.	string
dt	When assigning this data, '0' should always be entered.	string
ci	ISDN transmitting information	string
oid	When assigning this data, '0' should always be entered.	string
tks	When assigning this data, '0' should always be entered.	string
pad2	Pad Control Data 2	string
trm	When assigning this data, '0' should always be entered.	string
trpx	When assigning this data, '0' should always be entered.	string
ldr	When assigning this data, '0' should always be entered.	string
tsc	When assigning this data, '0' should always be entered.	string
sats	When assigning this data, '0' should always be entered.	string
rvpx	When assigning this data, '0' should always be entered.	string
dq	When assigning this data, '0' should always be entered.	string
slov	Slumber Time Override Service	string
sdto	System message automatic output when Connection Acknowledge	string
advpra	ISDN PRI Failure Routing Service	string
ind	Inter-office Name Display	string
uui	When assigning this data, '0' should always be entered.	string
dch	When assigning this data, '0' should always be entered.	string
cmrt	Common use of Route Numbers of ISDN trunks	string
pref	When assigning this data, '0' should always be entered.	string
dfs	When assigning this data, '0' should always be entered.	string
bob	When assigning this data, '0' should always be entered.	string
ho1ch	When assigning this data, '0' should always be entered.	string
ifr	Indonesia Compulsion Cut Service	string
conv	SMDR Called Party's Number Conversion	string
orrt	Originally Trunk Information	string
cni	Calling Number Identification Format	string
aoc	AOC kind data	string
mgcot	Media Gateway(Central Office Trunk) use)	string

ARTDN-Set Route Class Data for NDM (artdnSet)

Sets the Route Class Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
osgs	OSGS	Signal Interface for Outgoing	False	string
onsg	ONSG	Signal Selection for Outgoing	False	string
isgs	ISGS	Signal Interface for Incoming	False	string
insg	INSG	Signal Selection for Incoming	False	string
tf	TF	Type of Trunk Function	False	string
tcl	TCL	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	False	string
l_t	L_T	Line / Trunk Identification( This data should always be assigned as '1' )	False	string
rlp	RLP	Trunk Release Pattern	False	string
tq	TQ	Outgoing Trunk Queuing	False	string
smdr	SMDR	Detailed Billing Information	False	string
td	TD	Toll Denial-Battery Reversal	False	string
dr	DR	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	False	string
ac	AC	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	False	string
tnt	TNT	Tenant Number Check	False	string
lsg	LSG	Line Signal	False	string
smdr2	SMDR2	Detailed Billing Information	False	string
h_m	H_M	Hotel Service over CCIS	False	string
mc	MC	TS Service for Network VCM	False	string
ani	ANI	E911-ANI Service	False	string
d	D	When assigning this data,'0' should always be entered.	False	string
msb	MSB	When assigning this data,'0' should always be entered.	False	string
msw	MSW	Outgoing Call account by Temporary Route Information	False	string
tr	TR	GII Signal Override(MFC)	False	string
oc	OC	Originating Category Request(MFC)	False	string
r_l	R_L	Attendant-Identification of Incoming Trunk Display	False	string
rvsd	RVSD	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	False	string
tl	TL	Tone Level	False	string
ans	ANS	Answer Signal from Trunk Side	False	string
telp	TELP	Time Elapse Indication Service	False	string
pad	PAD	This data determines PAD control on the ODT/DTI circuit card	False	string
ogrl	OGRL	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	False	string
icrl	ICRL	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	False	string
hd	HD	Trunk Hold Timing( Normally assigned as '0' )	False	string
guard	GUARD	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	False	string
wink	WINK	Width of a Wink Signal( Normally assigned as '0' )	False	string
vad	VAD	When assigning this data, '0' should always be entered.	False	string
cld	CLD	When assigning this data, '0' should always be entered.	False	string
fa	FA	Forced Account/Forced Authorization Code	False	string
bc	BC	C.O. Line Idle Balance Condition( Australia ONLY )	False	string
tcm	TCM	Terminal Class Mark	False	string
tdmq	TDMQ	Tandem Off Hook OG Queuing	False	string
trsc	TRSC	Trunk Restriction Class	False	string
bt	BT	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	False	string
prv	PRV	Line Trunk Privacy	False	string
a_d	A_D	Analog/Digital Line Data	False	string
cw	CW	Call Waiting Service	False	string
tpq	TPQ	Priority OG Queuing	False	string
bl	BL	Detect of Blocking Signal	False	string
trks	TRKS	Trunk Selection Sequence	False	string
dply	DPLY	Number Display of Dterm between Office	False	string
acd	ACD	ACD Service	False	string
_2w_4w	_2W_4W	2 Wires/4 Wires	False	string
faat	FAAT	Authorization Code for ATT	False	string
gw	GW	Gateway Option	False	string
tcma	TCMA	When assigning this data, '0' should always be entered.	False	string
smdr3	SMDR3	Detailed Billing for Outgoing in Tandem Connection	False	string
hdt	HDT	Collect Call Blocking	False	string
cd	CD	Consecutive Dialing	False	string
cch	CCH	CCIS Transmitter/Receiver( Common Channel Handler )	False	string
tc_ec	TC_EC	When assigning this data, '0' should always be entered.	False	string
ire	IRE	Inter-reringing Signal	False	string
scr	SCR	Step Call Restriction for TIE Line Call	False	string
lyer1	LYER1	Layer 1(for ISDN)	False	string
net	NET	User/Net Identification(for ISDN)	False	string
int	INT	Interface Specification(for ISDN)	False	string
dc	DC	Dialed Number Confirmation(for ISDN)	False	string
hks	HKS	Hooking Service	False	string
scf	SCF	Split Call Forwarding	False	string
smdr4	SMDR4	Detailed Billing for Incoming in Tandem Connection	False	string
tcmn	TCMN	Number of digits of TCM(S Code)	False	string
tcmc	TCMC	TCM and KP Sending Sequence	False	string
mfsp	MFSP	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	False	string
kpst	KPST	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	False	string
kppt	KPPT	Pause after KP sending/Originating MFC Backward signal Receive Timer	False	string
stc	STC	Stop Code	False	string
mc2	MC2	MP Start Cause( This data must always be set to '0' )	False	string
MT	MT	MF Frequency	False	string
tone	TONE	TONE Destination for TRK Call Termination	False	string
pptm	PPTM	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	False	string
mptm	MPTM	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	False	string
lptm	LPTM	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	False	string
rsax	RSAX	When assigning this data, '0' should always be entered.	False	string
cst	CST	When assigning this data, '0' should always be entered.	False	string
cseg	CSEG	When assigning this data, '0' should always be entered.	False	string
cseu	CSEU	When assigning this data, '0' should always be entered.	False	string
csel	CSEL	When assigning this data, '0' should always be entered.	False	string
cmp	CMP	When assigning this data, '0' should always be entered.	False	string
talk	TALK	When assigning this data, '0' should always be entered.	False	string
fot	FOT	When assigning this data, '0' should always be entered.	False	string
rst	RST	When assigning this data, '0' should always be entered.	False	string
toci	TOCI	Trunk Override Calling	False	string
tocd	TOCD	'Trunk Override Called	False	string
odgd	ODGD	When assigning this data, '0' should always be entered.	False	string
rls	RLS	When assigning this data, '0' should always be entered.	False	string
gwd	GWD	Gate Way Data Service	False	string
h1	H1	When assigning this data, '0' should always be entered.	False	string
dt	DT	When assigning this data, '0' should always be entered.	False	string
ci	CI	ISDN transmitting information	False	string
oid	OID	When assigning this data, '0' should always be entered.	False	string
tks	TKS	When assigning this data, '0' should always be entered.	False	string
pad2	PAD2	Pad Control Data 2	False	string
trm	TRM	When assigning this data, '0' should always be entered.	False	string
trpx	TRPX	When assigning this data, '0' should always be entered.	False	string
ldr	LDR	When assigning this data, '0' should always be entered.	False	string
tsc	TSC	When assigning this data, '0' should always be entered.	False	string
sats	SATS	When assigning this data, '0' should always be entered.	False	string
rvpx	RVPX	When assigning this data, '0' should always be entered.	False	string
dq	DQ	When assigning this data, '0' should always be entered.	False	string
slov	SLOV	Slumber Time Override Service	False	string
sdto	SDTO	System message automatic output when Connection Acknowledge	False	string
advpra	ADVPRA	ISDN PRI Failure Routing Service	False	string
ind	IND	Inter-office Name Display	False	string
uui	UUI	When assigning this data, '0' should always be entered.	False	string
dch	DCH	When assigning this data, '0' should always be entered.	False	string
cmrt	CMRT	Common use of Route Numbers of ISDN trunks	False	string
pref	PREF	When assigning this data, '0' should always be entered.	False	string
dfs	DFS	When assigning this data, '0' should always be entered.	False	string
bob	BOB	When assigning this data, '0' should always be entered.	False	string
ho1ch	HO1CH	When assigning this data, '0' should always be entered.	False	string
ifr	IFR	Indonesia Compulsion Cut Service	False	string
conv	CONV	SMDR Called Party's Number Conversion	False	string
orrt	ORRT	Originally Trunk Information	False	string
cni	CNI	Calling Number Identification Format	False	string
aoc	AOC	AOC kind data	False	string
mgcot	MGCOT	Media Gateway(Central Office Trunk) use)	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTDN-Delete Route Class Data for NDM (artdnDel)

Deletes the Route Class Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARTDN-Lists Route Class Data for NDM (artdnList)

Lists the Route Class Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
artdnListResponse.count	The count of items.	string
artdnListResponse[0].lgrt	Logical Route Number	string
artdnListResponse[0].osgs	Signal Interface for Outgoing	string
artdnListResponse[0].onsg	Signal Selection for Outgoing	string
artdnListResponse[0].isgs	Signal Interface for Incoming	string
artdnListResponse[0].insg	Signal Selection for Incoming	string
artdnListResponse[0].tf	Type of Trunk Function	string
artdnListResponse[0].tcl	Trunk Class( This data is assigned in order to terminate Incoming Calls at their designated keys - TRK ICI Key Lamps - on the Attendant Console. )	string
artdnListResponse[0].l_t	Line / Trunk Identification( This data should always be assigned as '1' )	string
artdnListResponse[0].rlp	Trunk Release Pattern	string
artdnListResponse[0].tq	Outgoing Trunk Queuing	string
artdnListResponse[0].smdr	Detailed Billing Information	string
artdnListResponse[0].td	Toll Denial-Battery Reversal	string
artdnListResponse[0].dr	Distinctive Ringing Pattern( This parameter designates whether distinctive ringing will be provided for an incoming )	string
artdnListResponse[0].ac	Flexible Routing Pattern Designation( When outgoing route selection pattern number s to be determined by the AFRS command, '1' is to be assigned if the Access Code is included in the Number Pattern Code - NPC	string
artdnListResponse[0].tnt	Tenant Number Check	string
artdnListResponse[0].lsg	Line Signal	string
artdnListResponse[0].smdr2	Detailed Billing Information	string
artdnListResponse[0].h_m	Hotel Service over CCIS	string
artdnListResponse[0].mc	TS Service for Network VCM	string
artdnListResponse[0].ani	E911-ANI Service	string
artdnListResponse[0].d	When assigning this data,'0' should always be entered.	string
artdnListResponse[0].msb	When assigning this data,'0' should always be entered.	string
artdnListResponse[0].msw	Outgoing Call account by Temporary Route Information	string
artdnListResponse[0].tr	GII Signal Override(MFC)	string
artdnListResponse[0].oc	Originating Category Request(MFC)	string
artdnListResponse[0].r_l	Attendant-Identification of Incoming Trunk Display	string
artdnListResponse[0].rvsd	Trunk Reversal Identification( This data is necessary when a specific Trunk route provides battery reversal for answer supervision	string
artdnListResponse[0].tl	Tone Level	string
artdnListResponse[0].ans	Answer Signal from Trunk Side	string
artdnListResponse[0].telp	Time Elapse Indication Service	string
artdnListResponse[0].pad	This data determines PAD control on the ODT/DTI circuit card	string
artdnListResponse[0].ogrl	Release Timing for Outgoing Trunk Connection( Normally assigned as '0' )	string
artdnListResponse[0].icrl	Release Timing for Incoming Trunk Connection( Normally assigned as '0' )	string
artdnListResponse[0].hd	Trunk Hold Timing( Normally assigned as '0' )	string
artdnListResponse[0].guard	Outgoing Inhibit Timing after Trunk Release( Normally assigning as '0' )	string
artdnListResponse[0].wink	Width of a Wink Signal( Normally assigned as '0' )	string
artdnListResponse[0].vad	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cld	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].fa	Forced Account/Forced Authorization Code	string
artdnListResponse[0].bc	C.O. Line Idle Balance Condition( Australia ONLY )	string
artdnListResponse[0].tcm	Terminal Class Mark	string
artdnListResponse[0].tdmq	Tandem Off Hook OG Queuing	string
artdnListResponse[0].trsc	Trunk Restriction Class	string
artdnListResponse[0].bt	For any condition other than CCIS, assign data '0'.For CCIS voice route and/or to send ANI across CCIS signaling route, assign data '1'.	string
artdnListResponse[0].prv	Line Trunk Privacy	string
artdnListResponse[0].a_d	Analog/Digital Line Data	string
artdnListResponse[0].cw	Call Waiting Service	string
artdnListResponse[0].tpq	Priority OG Queuing	string
artdnListResponse[0].bl	Detect of Blocking Signal	string
artdnListResponse[0].trks	Trunk Selection Sequence	string
artdnListResponse[0].dply	Number Display of Dterm between Office	string
artdnListResponse[0].acd	ACD Service	string
artdnListResponse[0]._2w_4w	2 Wires/4 Wires	string
artdnListResponse[0].faat	Authorization Code for ATT	string
artdnListResponse[0].gw	Gateway Option	string
artdnListResponse[0].tcma	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].smdr3	Detailed Billing for Outgoing in Tandem Connection	string
artdnListResponse[0].hdt	Collect Call Blocking	string
artdnListResponse[0].cd	Consecutive Dialing	string
artdnListResponse[0].cch	CCIS Transmitter/Receiver( Common Channel Handler )	string
artdnListResponse[0].tc_ec	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].ire	Inter-reringing Signal	string
artdnListResponse[0].scr	Step Call Restriction for TIE Line Call	string
artdnListResponse[0].lyer1	Layer 1(for ISDN)	string
artdnListResponse[0].net	User/Net Identification(for ISDN)	string
artdnListResponse[0].int	Interface Specification(for ISDN)	string
artdnListResponse[0].dc	Dialed Number Confirmation(for ISDN)	string
artdnListResponse[0].hks	Hooking Service	string
artdnListResponse[0].scf	Split Call Forwarding	string
artdnListResponse[0].smdr4	Detailed Billing for Incoming in Tandem Connection	string
artdnListResponse[0].tcmn	Number of digits of TCM(S Code)	string
artdnListResponse[0].tcmc	TCM and KP Sending Sequence	string
artdnListResponse[0].mfsp	Sending Speed/Originating MFC Forward Signal Send Inter Digit Timer	string
artdnListResponse[0].kpst	Duration of KP sending Note/Originating MFC Forward Signal Send Timer	string
artdnListResponse[0].kppt	Pause after KP sending/Originating MFC Backward signal Receive Timer	string
artdnListResponse[0].stc	Stop Code	string
artdnListResponse[0].mc2	MP Start Cause( This data must always be set to '0' )	string
artdnListResponse[0].mt	MF Frequency	string
artdnListResponse[0].tone	TONE Destination for TRK Call Termination	string
artdnListResponse[0].pptm	Sender Prepause/Incoming MFC Forward Signal Receive Inter Digit Timer	string
artdnListResponse[0].mptm	Sender Minimum Pause/Incoming MFC Backward Signal Send Timer	string
artdnListResponse[0].lptm	Sender Inter-Digit Pause Index/Incoming MFC Forward Signal Receive Timer	string
artdnListResponse[0].rsax	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cst	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cseg	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cseu	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].csel	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cmp	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].talk	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].fot	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].rst	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].toci	Trunk Override Calling	string
artdnListResponse[0].tocd	'Trunk Override Called	string
artdnListResponse[0].odgd	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].rls	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].gwd	Gate Way Data Service	string
artdnListResponse[0].h1	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].dt	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].ci	ISDN transmitting information	string
artdnListResponse[0].oid	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].tks	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].pad2	Pad Control Data 2	string
artdnListResponse[0].trm	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].trpx	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].ldr	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].tsc	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].sats	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].rvpx	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].dq	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].slov	Slumber Time Override Service	string
artdnListResponse[0].sdto	System message automatic output when Connection Acknowledge	string
artdnListResponse[0].advpra	ISDN PRI Failure Routing Service	string
artdnListResponse[0].ind	Inter-office Name Display	string
artdnListResponse[0].uui	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].dch	When assigning this data, '0' should always be entered.	string
artdnListResponse[0].cmrt	Common use of Route Numbers of ISDN trunks	string
artdnListResponse[0]pref	When assigning this data, '0' should always be entered.	string
artdnListResponse[0]dfs	When assigning this data, '0' should always be entered.	string
artdnListResponse[0]bob	When assigning this data, '0' should always be entered.	string
artdnListResponse[0]ho1ch	When assigning this data, '0' should always be entered.	string
artdnListResponse[0]ifr	Indonesia Compulsion Cut Service	string
artdnListResponse[0]conv	SMDR Called Party's Number Conversion	string
artdnListResponse[0]orrt	Originally Trunk Information	string
artdnListResponse[0]cni	Calling Number Identification Format	string
artdnListResponse[0]aoc	AOC kind data	string
artdnListResponse[0]mgcot	Media Gateway(Central Office Trunk) use)	string
artdnListResponse[0]templateName	Route Class Template Name	string

AMGIL-Get Media Gateway Information for LDM (amgilGet)

Gets the Media Gateway Information for LDM.

Request Properties

Name	Display	Description	Is Required	Type
mg_id	MG_ID	Media Gateway ID {000000000000-FFFFFFFFFFFF}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
kind	Kind of MG Trunk	string
mgList.count	The count of items.	string
mgList[0].mg_line	MG Line number	string
mgList[0].mg_ch	MG Channel number	string
mgList[0].mg_lens	MG Common channel LENS	string
tos_data.tos_type	ToS Data type	string
tos_data.precedence	Precedence	string
tos_data.delay	Low Delay	string
tos_data.throughput	Through Put	string
tos_data.reliability	Reliability	string
tos_data.cost	Min Cost	string
tos_data.dscp	DSCP	string
music_on_hold	MUSIC on hold set	string
emergency_telephone	Emergency Telephone	string
gain	Input gain adjustment of external music on hold	string
rtry	Consecutive connection failure threshold	string
mg_pri_call_hold	MG_PRI_CALL_HOLD	string
ug50_multislot_mode	UG50_MULTISLOT_MODE	string
ch_info	Number of channel possible use	string
atc_data.atc_flg	Flag of authentication	string
atc_data.mg_group	MG Group	string
atc_data.mg_num	MG Number	string
ic_congestion_cnt	Flag of Incoming Call Congestion Control	string
country_code	Country Code	string
a_d_convert_law	A/D Convert Law	string
pb_din_rcv_cpt_timer	PB Dial in Receive Complete Timer	string
false_ans_timer	False Answer Timer	string
pathList.count	The count of items.	string
pathList[0].path_index	Index of outgoing PATH Data	string
pathList[0].path_data.path_id	Identification number of outgoing PATH	string
pathList[0].path_data.rt_number	Route Number	string
pathList[0].path_data.tk_number	Trunk Number	string
pathList[0].path_data.num_of_channel	Number of channels	string
pathList[0].path_data.ip_version	IP address Version. IPv4/IPv6	string
pathList[0].path_data.ip_data	Remote Gateway IP Address	string
pathList[0].path_data.port_num	Remote Gateway Port Number	string
pathList[0].path_data.capability	Gateway Capability	string
pathList[0].path_data.lgrt	Logical Route Number	string
pathList[0].path_data.path_reset_flg	Media Gateway reset flag	string

AMGIL-Set Media Gateway Information for LDM (amgilSet)

Sets the Media Gateway Information for LDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Set Type {1 : Media Gateway AMGIL Base Data set, 2 : Media Gateway reset from AMGIL, 3 : Media Gateway AMGIL Base Data set. (PATH Data is sent in the next.), 4 : Media Gateway AMGIL PATH Data set, 5 : Media Gateway AMGIL PATH Data reset}	True	string
mg_id	MG_ID	MG ID(MAC Address) {000000000000-FFFFFFFFFFFF}	False	string
kind	KIND	Kind of MG Trunk {9-15, 17-18, 26-27, 29-33, 36-37}	False	string
mg_lens_cnt	MG_LENS_CNT	Number of MG LENS {1-32}	False	string
mgList	mgdata in array	The mgdata as array	False	array
mgList[0].mg_line	MG_LINE	MG Line number {0-6}	True	string
mgList[0].mg_ch	MG_CH	MG Channel number {0-23}	True	string
mgList[0].mg_lens	MG_LENS	MG Common channel LENS {XXXXXX}	True	string
tos_type	TOS_TYPE	ToS Data type {0-2}	False	string
precedence	PRECEDENCE	Precedence {0-7}	False	string
delay	DELAY	Low Delay {0-1}	False	string
throughput	THROUGHPUT	Through Put {0-1}	False	string
reliability	RELIABILITY	Reliability {0-1}	False	string
cost	COST	Min Cost {0-1}	False	string
dscp	DSCP	DSCP {0-63}	False	string
music_on_hold	MUSIC_ON_HOLD	MUSIC on hold set {0-3(In the case of KIND=11,26,29,32,33,36,37) or 0-5(In the case of KIND=15/27)}	False	string
emergency_telephone	EMERGENCY_TELEPHONE	Emergency Telephone {1-2}	False	string
gain	GAIN	Input gain adjustment of external music on hold {0-15}	False	string
rtry	RTRY	Consecutive connection failure threshold {0-15}	False	string
mg_pri_call_hold	MG_PRI_CALL_HOLD	MG_PRI_CALL_HOLD {0-1}	False	string
ug50_multislot_mode	UG50_MULTISLOT_MODE	UG50_MULTISLOT_MODE {0-1}	False	string
ch_info	CH_INFO	Number of channel possible use {1-255(KIND=14 SIP-MG) or 1-4(KIND=30 SIP-GW(4ch)) or 1-3(KIND= 31 SIP-GW(4ch))2}	False	string
atc_flg	ATC_FLG	Flag of authentication {0-1}	False	string
mg_group	MG_GROUP	MG Group {1-4(In the case of SVI 860=0) or 1-15(In the case of SVI 860=1)}	False	string
mg_num	MG_NUM	MG Number {1-4(In the case of SVI 860=0) or 1-15(In the case of SVI 860=1)}	False	string
ic_congestion_cnt	IC_CONGESTION_CNT	Flag of Incoming Call Congestion Control {0-1}	False	string
country_code	COUNTRY_CODE	Country Code {1-17}	False	string
a_d_convert_law	A_D_CONVERT_LAW	A/D Convert Law {0-1}	False	string
pb_din_rcv_cpt_timer	PB_DIN_RCV_CPT_TIMER	PB Dial in Receive Complete Timer {0-15}	False	string
false_ans_timer	FALSE_ANS_TIMER	False Answer Timer {0-15}	False	string
mg_lens	MG_LENS	MG Common channel LENS {XXXXXX}	False	string
reset_flg	RESET_FLG	PATH Reset Flag {00-01}	False	string
pathList	pathdata in array	The mgdata as array	False	array
pathList[0].rt_number	RT_NUMBER	Route Number {1-255}	False	string
pathList[0].tk_number	TK_NUMBER	Trunk Number {1-255}	False	string
pathList[0].num_of_channel	NUM_OF_CHANNEL	Number of channels {1-254}	False	string
pathList[0].ip_version	IP_VERSION	IP address Version. IPv4/IPv6 {0-2}	False	string
pathList[0].ip_data	IP_DATA	Remote Gateway IP Address	False	string
pathList[0].port_num	PORT_NUM	Remote Gateway Port Number {0, 1024-65535}	False	string
pathList[0].capability	CAPABILITY	Gateway Capability {00-FF}	False	string
path_reset	PATH_RESET	PATH Data Reset Request {0000-FFFF}	False	string
pathListJson	the path list as json	The Path list as json.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMGIL-Delete Media Gateway Information for LDM (amgilDel)

Deletes the Media Gateway Information for LDM.

Request Properties

Name	Display	Description	Is Required	Type
mg_id	MG_ID	Media Gateway ID {000000000000-FFFFFFFFFFFF}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMGIL-Lists Media Gateway Information for LDM (amgilList)

Lists the Media Gateway Information for LDM.

Request Properties

Name	Display	Description	Is Required	Type
dstsList	Dsts List	This property is for developers. Normally there is no need to specify it.	False	string
routeList	Route List	This property is for developers. Normally there is no need to specify it.	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
amgilListResponse.count	The count of items.	string
amgilListResponse[0].mg_id	MG ID(MAC Address)	string
amgilListResponse[0].kind	Kind of MG Trunk	string
amgilListResponse[0].mgList.count	The count of items.	string
amgilListResponse[0].mgList[0].mg_line	MG Line number	string
amgilListResponse[0].mgList[0].mg_ch	MG Channel number	string
amgilListResponse[0].mgList[0].mg_lens	MG Common channel LENS	string
amgilListResponse[0].tos_data.tos_type	ToS Data type	string
amgilListResponse[0].tos_data.precedence	Precedence	string
amgilListResponse[0].tos_data.delay	Low Delay	string
amgilListResponse[0].tos_data.throughput	Through Put	string
amgilListResponse[0].tos_data.reliability	Reliability	string
amgilListResponse[0].tos_data.cost	Min Cost	string
amgilListResponse[0].tos_data.dscp	DSCP	string
amgilListResponse[0].music_on_hold	MUSIC on hold set	string
amgilListResponse[0].emergency_telephone	Emergency Telephone	string
amgilListResponse[0].gain	Input gain adjustment of external music on hold	string
amgilListResponse[0].rtry	Consecutive connection failure threshold	string
amgilListResponse[0].mg_pri_call_hold	MG_PRI_CALL_HOLD	string
amgilListResponse[0].ug50_multislot_mode	UG50_MULTISLOT_MODE	string
amgilListResponse[0].ch_info	Maximum number of channels	string
amgilListResponse[0].availablech	Number of channel possible use	string
amgilListResponse[0].atc_data.atc_flg	Flag of authentication	string
amgilListResponse[0].atc_data.mg_group	MG Group	string
amgilListResponse[0].atc_data.mg_num	MG Number	string
amgilListResponse[0].ic_congestion_cnt	Flag of Incoming Call Congestion Control	string
amgilListResponse[0].country_code	Country Code	string
amgilListResponse[0].a_d_convert_law	A/D Convert Law	string
amgilListResponse[0].pb_din_rcv_cpt_timer	PB Dial in Receive Complete Timer	string
amgilListResponse[0].false_ans_timer	False Answer Timer	string
amgilListResponse[0].pathList.count	The count of items.	string
amgilListResponse[0].pathList[0].path_index	Index of outgoing PATH Data	string
amgilListResponse[0].pathList[0].path_id	Identification number of outgoing PATH	string
amgilListResponse[0].pathList[0].rt_number	Route Number	string
amgilListResponse[0].pathList[0].tk_number	Trunk Number	string
amgilListResponse[0].pathList[0].ch	Number of channels	string
amgilListResponse[0].pathList[0].ip_version	IP address Version. IPv4/IPv6	string
amgilListResponse[0].pathList[0].ip_data	Remote Gateway IP Address	string
amgilListResponse[0].pathList[0].port_num	Remote Gateway Port Number	string
amgilListResponse[0].pathList[0].capability	Gateway Capability	string
amgilListResponse[0].pathList[0].lgrt	Logical Route Number	string
amgilListResponse[0].pathList[0].path_reset_flg	Media Gateway reset flag	string

ASPAN-Get Special Access Code for NDM (aspanGet)

Gets the Special Access Code for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
srv	Kind of Service	string
sid	Service Index	string
nnd	Necessary Digit	string
nnd1	Necessary Digit for Speed Calling	string
fpc	Fusion Point Code	string
state	Hotel/Motel Service Code	string
no1	Kind of Assignment Number 1	string
no2	Kind of Assignment Number 2	string
kind	Kind of Function	string
sida	Service Index A	string
pno	Pattern Number For AOSP command	string
a_g	Administration/Guest Station	string
lgrt	Logical Route Number	string
lgrtList.count	The count of items.	string
lgrtList[0].lgrt	Logical Route Number	string
second_dt	Second Dial Tone	string
ah	Authorization Code Dialing	string
sub	Sub Address Dialing	string
skip	Skip Digit	string
eqp	Announcement Equipment Number	string
tn_annc	Tenant Number	string

ASPAN-Set Special Access Code for NDM (aspanSet)

Sets the Special Access Code for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
srv	SRV	Kind of Service {2-12, 16}	False	string
sid	SID	Service Index {1-63}	False	string
nnd	NND	Necessary Digit {0-31}	False	string
nnd1	NND1	Necessary Digit for Speed Calling {0-7}	False	string
fpc	FPC	Fusion Point Code {1-253}	False	string
state	STATE	Hotel/Motel Service Code {1-255}	False	string
no1	NO1	Kind of Assignment Number 1 {0-15}	False	string
no2	NO2	Kind of Assignment Number 2 {0-63}	False	string
kind	KIND	Kind of Function {0-3}	False	string
sida	SIDA	Service Index A {1-255}	False	string
pno	PNO	Pattern Number For AOSP command {1-15}	False	string
a_g	A_G	Administration/Guest Station {0-1}	False	string
lgrt	LGRT	Logical Route Number {1-899}	False	string
lgrtList	lgrt in array	The lgrt as array	False	array
lgrtList[0].lgrt	LGRT	Logical Route Number {1-899}	False	string
second_dt	SECOND_DT	Second Dial Tone {0-2}	False	string
ah	AH	Authorization Code Dialing {0-1}	False	string
sub	SUB	Sub Address Dialing {0-1}	False	string
skip	SKIP	Skip Digit {0-5}	False	string
eqp	EQP	Announcement Equipment Number {1-127}	False	string
tn_annc	TN_ANNC	Tenant Number {1-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPAN-Delete Special Access Code for NDM (aspanDel)

Deletes the Special Access Code for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPAN-Lists Special Access Code for NDM (aspanList)

Lists the Special Access Code for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_acc	Start ACC	The starting Access Code {0-9,*,#} max 6 digits	True	string
end_acc	End ACC	The ending Access Code {0-9,*,#} max 6 digits	True	string
start_ci	Start CI	The starting Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
end_ci	End CI	The ending Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aspanListResponse.count	The count of items.	string
aspanListResponse[0].srv	Kind of Service	string
aspanListResponse[0].sid	Service Index	string
aspanListResponse[0].nnd	Necessary Digit	string
aspanListResponse[0].nnd1	Necessary Digit for Speed Calling	string
aspanListResponse[0].fpc	Fusion Point Code	string
aspanListResponse[0].state	Hotel/Motel Service Code	string
aspanListResponse[0].no1	Kind of Assignment Number 1	string
aspanListResponse[0].no2	Kind of Assignment Number 2	string
aspanListResponse[0].kind	Kind of Function	string
aspanListResponse[0].sida	Service Index A	string
aspanListResponse[0].pno	Pattern Number For AOSP command	string
aspanListResponse[0].a_g	Administration/Guest Station	string
aspanListResponse[0].lgrt	Logical Route Number	string
aspanListResponse[0].lgrtList.count	The count of items.	string
aspanListResponse[0].lgrtList[0].lgrt	Logical Route Number	string
aspanListResponse[0].second_dt	Second Dial Tone	string
aspanListResponse[0].ah	Authorization Code Dialing	string
aspanListResponse[0].sub	Sub Address Dialing	string
aspanListResponse[0].skip	Skip Digit	string
aspanListResponse[0].eqp	Announcement Equipment Number	string
aspanListResponse[0].tn_annc	Tenant Number	string

ASPA-Get Special Access Code (aspaGet)

Gets the Special Access Code.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
srv	Kind of Service	string
sid	Service Index	string
nnd	Necessary Digit	string
nnd1	Necessary Digit for Speed Calling	string
sida	Service Index A	string
rt	Route Number	string
rtList.count	The count of items.	string
rtList[0].rt	Route Number	string
second_dt	Second Dial Tone	string
ah	Authorization Code Dialing	string
sub	Sub Address Dialing	string
skip	Skip Digit	string
eqp	Announcement Equipment Number	string
tn_annc	Tenant Number	string

ASPA-Set Special Access Code (aspaSet)

Sets the Special Access Code.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
srv	SRV	Kind of Service {1-12}	False	string
sid	SID	Service Index {0-63}	False	string
nnd	NND	Necessary Digit {0-31}	False	string
nnd1	NND1	Necessary Digit for Speed Calling {0-4}	False	string
sida	SIDA	Service Index A {0-255}	False	string
rt	RT	Route Number {1-255}	False	string
rtList	rt in array	The rt as array	False	array
rtList[0].rt	RT	Route Number {1-255}	False	string
second_dt	SECOND_DT	Second Dial Tone {0-2}	False	string
ah	AH	Authorization Code Dialing {0-1}	False	string
sub	SUB	Sub Address Dialing {0-1}	False	string
skip	SKIP	Skip Digit {0-5}	False	string
eqp	EQP	Announcement Equipment Number {0-127}	False	string
tn_annc	TN_ANNC	Tenant Number {1-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPA-Delete Special Access Code (aspaDel)

Deletes the Special Access Code.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
acc	ACC	Access Code {0-9,*,#} max 6 digits	True	string
ci	CI	Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASPA-Lists Special Access Code (aspaList)

Lists the Special Access Code.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_acc	Start ACC	The starting Access Code {0-9,*,#} max 6 digits	True	string
end_acc	End ACC	The ending Access Code {0-9,*,#} max 6 digits	True	string
start_ci	Start CI	The starting Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
end_ci	End CI	The ending Connection Status Index {1 : Normal, 2 : Hooking, 3 : Busy}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aspaListResponse.count	The count of items.	string
aspaListResponse[0].srv	Kind of Service	string
aspaListResponse[0].sid	Service Index	string
aspaListResponse[0].nnd	Necessary Digit	string
aspaListResponse[0].nnd1	Necessary Digit for Speed Calling	string
aspaListResponse[0].sida	Service Index A	string
aspaListResponse[0].rt	Route Number	string
aspaListResponse[0].rtList.count	The count of items.	string
aspaListResponse[0].rtList[0].rt	Route Number	string
aspaListResponse[0].second_dt	Second Dial Tone	string
aspaListResponse[0].ah	Authorization Code Dialing	string
aspaListResponse[0].sub	Sub Address Dialing	string
aspaListResponse[0].skip	Skip Digit	string
aspaListResponse[0].eqp	Announcement Equipment Number	string
aspaListResponse[0].tn_annc	Tenant Number	string

ARRCN-Get Alternative Route Restriction for NDM (arrcnGet)

Gets the Alternative Route Restriction for NDM.

Request Properties

Name	Display	Description	Is Required	Type
iclgrt	ICLGRT	Incoming Logical Route Number {1-899}	True	string
oglgrt	OGLGRT	Outgoing Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ari_a_res	Restriction Data for Alternative Route Index-A	string
ari_d_res	Restriction Data for Alternative Route Index-D	string

ARRCN-Set Alternative Route Restriction for NDM (arrcnSet)

Sets the Alternative Route Restriction for NDM.

Request Properties

Name	Display	Description	Is Required	Type
iclgrt	ICLGRT	Incoming Logical Route Number {1-899}	True	string
oglgrt	OGLGRT	Outgoing Logical Route Number {1-899}	True	string
ari_a_res	ARI_A_RES	Restriction Data for Alternative Route Index-A {0: Alternate routing is Restricted, 1: Alternate routing is Allowed, 2: Toll Restriction is required}	True	string
ari_d_res	ARI_D_RES	Restriction Data for Alternative Route Index-D {0: Alternate routing is Restricted, 1: Alternate routing is Allowed, 2: Toll Restriction is required}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARRCN-Lists Alternative Route Restriction for NDM (arrcnList)

Lists the Alternative Route Restriction for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_iclgrt	Start ICLGRT	The starting Incoming Logical Route Number {1-899}	True	string
end_iclgrt	End ICLGRT	The ending Incoming Logical Route Number {1-899}	True	string
start_oglgrt	Start OGLGRT	The starting Outgoing Logical Route Number {1-899}	True	string
end_oglgrt	End OGLGRT	The ending Outgoing Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arrcnListResponse.count	The count of items.	string
arrcnListResponse[0].iclgrt	Incoming Logical Route Number	string
arrcnListResponse[0].oglgrt	Outgoing Logical Route Number	string
arrcnListResponse[0].ari_a_res	Restriction Data for Alternative Route Index-A	string
arrcnListResponse[0].ari_d_res	Restriction Data for Alternative Route Index-D	string

ARRC-Get Alternative Route Restriction (arrcGet)

Gets the Alternative Route Restriction.

Request Properties

Name	Display	Description	Is Required	Type
icrt	ICRT	Incoming Route Number {1-255}	True	string
ogrt	OGRT	Outgoing Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ari_a_res	Restriction Data for Alternative Route Index-A	string
ari_d_res	Restriction Data for Alternative Route Index-D	string

ARRC-Set Alternative Route Restriction (arrcSet)

Sets the Alternative Route Restriction.

Request Properties

Name	Display	Description	Is Required	Type
icrt	ICRT	Incoming Route Number {1-255}	True	string
ogrt	OGRT	Outgoing Route Number {1-255}	True	string
ari_a_res	ARI_A_RES	Restriction Data for Alternative Route Index-A {0: Alternate routing is Restricted, 1: Alternate routing is Allowed}	True	string
ari_d_res	ARI_D_RES	Restriction Data for Alternative Route Index-D {0: Alternate routing is Restricted, 1: Alternate routing is Allowed, 2: Toll Restriction is required}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARRC-Lists Alternative Route Restriction (arrcList)

Lists the Alternative Route Restriction.

Request Properties

Name	Display	Description	Is Required	Type
start_icrt	Start ICRT	The starting Incoming Route Number {1-255}	True	string
end_icrt	End ICRT	The ending Incoming Route Number {1-255}	True	string
start_ogrt	Start OGRT	The starting Outgoing Route Number {1-255}	True	string
end_ogrt	End OGRT	The ending Outgoing Route Number {1-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arrcListResponse.count	The count of items.	string
arrcListResponse[0].icrt	Incoming Route Number	string
arrcListResponse[0].ogrt	Outgoing Route Number	string
arrcListResponse[0].ari_a_res	Restriction Data for Alternative Route Index-A	string
arrcListResponse[0].ari_d_res	Restriction Data for Alternative Route Index-D	string

ARSCN-Get Route Restriction Class for NDM (arscnGet)

Gets the Route Restriction Class for NDM.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
tn	TN	Tenant Number {1-63}	False	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
rri0_0	Restriction Data {0-2}	string
rri0_1	Restriction Data {0-2}	string
rri0_2	Restriction Data {0-2}	string
rri0_3	Restriction Data {0-2}	string
rri0_4	Restriction Data {0-2}	string
rri0_5	Restriction Data {0-2}	string
rri0_6	Restriction Data {0-2}	string
rri0_7	Restriction Data {0-2}	string
rri0_8	Restriction Data {0-2}	string
rri0_9	Restriction Data {0-2}	string
rri0_10	Restriction Data {0-2}	string
rri0_11	Restriction Data {0-2}	string
rri0_12	Restriction Data {0-2}	string
rri0_13	Restriction Data {0-2}	string
rri0_14	Restriction Data {0-2}	string
rri0_15	Restriction Data {0-2}	string
rri1_0	Restriction Data {0-2}	string
rri1_1	Restriction Data {0-2}	string
rri1_2	Restriction Data {0-2}	string
rri1_3	Restriction Data {0-2}	string
rri1_4	Restriction Data {0-2}	string
rri1_5	Restriction Data {0-2}	string
rri1_6	Restriction Data {0-2}	string
rri1_7	Restriction Data {0-2}	string
rri1_8	Restriction Data {0-2}	string
rri1_9	Restriction Data {0-2}	string
rri1_10	Restriction Data {0-2}	string
rri1_11	Restriction Data {0-2}	string
rri1_12	Restriction Data {0-2}	string
rri1_13	Restriction Data {0-2}	string
rri1_14	Restriction Data {0-2}	string
rri1_15	Restriction Data {0-2}	string
rri2_0	Restriction Data {0-2}	string
rri2_1	Restriction Data {0-2}	string
rri2_2	Restriction Data {0-2}	string
rri2_3	Restriction Data {0-2}	string
rri2_4	Restriction Data {0-2}	string
rri2_5	Restriction Data {0-2}	string
rri2_6	Restriction Data {0-2}	string
rri2_7	Restriction Data {0-2}	string
rri2_8	Restriction Data {0-2}	string
rri2_9	Restriction Data {0-2}	string
rri2_10	Restriction Data {0-2}	string
rri2_11	Restriction Data {0-2}	string
rri2_12	Restriction Data {0-2}	string
rri2_13	Restriction Data {0-2}	string
rri2_14	Restriction Data {0-2}	string
rri2_15	Restriction Data {0-2}	string
rri3_0	Restriction Data {0-2}	string
rri3_1	Restriction Data {0-2}	string
rri3_2	Restriction Data {0-2}	string
rri3_3	Restriction Data {0-2}	string
rri3_4	Restriction Data {0-2}	string
rri3_5	Restriction Data {0-2}	string
rri3_6	Restriction Data {0-2}	string
rri3_7	Restriction Data {0-2}	string
rri3_8	Restriction Data {0-2}	string
rri3_9	Restriction Data {0-2}	string
rri3_10	Restriction Data {0-2}	string
rri3_11	Restriction Data {0-2}	string
rri3_12	Restriction Data {0-2}	string
rri3_13	Restriction Data {0-2}	string
rri3_14	Restriction Data {0-2}	string
rri3_15	Restriction Data {0-2}	string

ARSCN-Set Route Restriction Class for NDM (arscnSet)

Sets the Route Restriction Class for NDM.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
tn	TN	Tenant Number {1-63}	False	string
lgrt	LGRT	Logical Route Number {1-899}	True	string
rri0_0	RRI-0_0	Restriction Data {0-2}	False	string
rri0_1	RRI-0_1	Restriction Data {0-2}	False	string
rri0_2	RRI-0_2	Restriction Data {0-2}	False	string
rri0_3	RRI-0_3	Restriction Data {0-2}	False	string
rri0_4	RRI-0_4	Restriction Data {0-2}	False	string
rri0_5	RRI-0_5	Restriction Data {0-2}	False	string
rri0_6	RRI-0_6	Restriction Data {0-2}	False	string
rri0_7	RRI-0_7	Restriction Data {0-2}	False	string
rri0_8	RRI-0_8	Restriction Data {0-2}	False	string
rri0_9	RRI-0_9	Restriction Data {0-2}	False	string
rri0_10	RRI-0_10	Restriction Data {0-2}	False	string
rri0_11	RRI-0_11	Restriction Data {0-2}	False	string
rri0_12	RRI-0_12	Restriction Data {0-2}	False	string
rri0_13	RRI-0_13	Restriction Data {0-2}	False	string
rri0_14	RRI-0_14	Restriction Data {0-2}	False	string
rri0_15	RRI-0_15	Restriction Data {0-2}	False	string
rri1_0	RRI-1_0	Restriction Data {0-2}	False	string
rri1_1	RRI-1_1	Restriction Data {0-2}	False	string
rri1_2	RRI-1_2	Restriction Data {0-2}	False	string
rri1_3	RRI-1_3	Restriction Data {0-2}	False	string
rri1_4	RRI-1_4	Restriction Data {0-2}	False	string
rri1_5	RRI-1_5	Restriction Data {0-2}	False	string
rri1_6	RRI-1_6	Restriction Data {0-2}	False	string
rri1_7	RRI-1_7	Restriction Data {0-2}	False	string
rri1_8	RRI-1_8	Restriction Data {0-2}	False	string
rri1_9	RRI-1_9	Restriction Data {0-2}	False	string
rri1_10	RRI-1_10	Restriction Data {0-2}	False	string
rri1_11	RRI-1_11	Restriction Data {0-2}	False	string
rri1_12	RRI-1_12	Restriction Data {0-2}	False	string
rri1_13	RRI-1_13	Restriction Data {0-2}	False	string
rri1_14	RRI-1_14	Restriction Data {0-2}	False	string
rri1_15	RRI-1_15	Restriction Data {0-2}	False	string
rri2_0	RRI-2_0	Restriction Data {0-2}	False	string
rri2_1	RRI-2_1	Restriction Data {0-2}	False	string
rri2_2	RRI-2_2	Restriction Data {0-2}	False	string
rri2_3	RRI-2_3	Restriction Data {0-2}	False	string
rri2_4	RRI-2_4	Restriction Data {0-2}	False	string
rri2_5	RRI-2_5	Restriction Data {0-2}	False	string
rri2_6	RRI-2_6	Restriction Data {0-2}	False	string
rri2_7	RRI-2_7	Restriction Data {0-2}	False	string
rri2_8	RRI-2_8	Restriction Data {0-2}	False	string
rri2_9	RRI-2_9	Restriction Data {0-2}	False	string
rri2_10	RRI-2_10	Restriction Data {0-2}	False	string
rri2_11	RRI-2_11	Restriction Data {0-2}	False	string
rri2_12	RRI-2_12	Restriction Data {0-2}	False	string
rri2_13	RRI-2_13	Restriction Data {0-2}	False	string
rri2_14	RRI-2_14	Restriction Data {0-2}	False	string
rri2_15	RRI-2_15	Restriction Data {0-2}	False	string
rri3_0	RRI-3_0	Restriction Data {0-2}	False	string
rri3_1	RRI-3_1	Restriction Data {0-2}	False	string
rri3_2	RRI-3_2	Restriction Data {0-2}	False	string
rri3_3	RRI-3_3	Restriction Data {0-2}	False	string
rri3_4	RRI-3_4	Restriction Data {0-2}	False	string
rri3_5	RRI-3_5	Restriction Data {0-2}	False	string
rri3_6	RRI-3_6	Restriction Data {0-2}	False	string
rri3_7	RRI-3_7	Restriction Data {0-2}	False	string
rri3_8	RRI-3_8	Restriction Data {0-2}	False	string
rri3_9	RRI-3_9	Restriction Data {0-2}	False	string
rri3_10	RRI-3_10	Restriction Data {0-2}	False	string
rri3_11	RRI-3_11	Restriction Data {0-2}	False	string
rri3_12	RRI-3_12	Restriction Data {0-2}	False	string
rri3_13	RRI-3_13	Restriction Data {0-2}	False	string
rri3_14	RRI-3_14	Restriction Data {0-2}	False	string
rri3_15	RRI-3_15	Restriction Data {0-2}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARSCN-Lists Route Restriction Class for NDM (arscnList)

Lists the Route Restriction Class for NDM.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arscnListResponse.count	The count of items.	string
arscnListResponse[0].tn	Tenant Number {1-63}	string
arscnListResponse[0].lgrt	Logical Route Number {1-899}	string
arscnListResponse[0].rri0_0	Restriction Data {0-2}	string
arscnListResponse[0].rri0_1	Restriction Data {0-2}	string
arscnListResponse[0].rri0_2	Restriction Data {0-2}	string
arscnListResponse[0].rri0_3	Restriction Data {0-2}	string
arscnListResponse[0].rri0_4	Restriction Data {0-2}	string
arscnListResponse[0].rri0_5	Restriction Data {0-2}	string
arscnListResponse[0].rri0_6	Restriction Data {0-2}	string
arscnListResponse[0].rri0_7	Restriction Data {0-2}	string
arscnListResponse[0].rri0_8	Restriction Data {0-2}	string
arscnListResponse[0].rri0_9	Restriction Data {0-2}	string
arscnListResponse[0].rri0_10	Restriction Data {0-2}	string
arscnListResponse[0].rri0_11	Restriction Data {0-2}	string
arscnListResponse[0].rri0_12	Restriction Data {0-2}	string
arscnListResponse[0].rri0_13	Restriction Data {0-2}	string
arscnListResponse[0].rri0_14	Restriction Data {0-2}	string
arscnListResponse[0].rri0_15	Restriction Data {0-2}	string
arscnListResponse[0].rri1_0	Restriction Data {0-2}	string
arscnListResponse[0].rri1_1	Restriction Data {0-2}	string
arscnListResponse[0].rri1_2	Restriction Data {0-2}	string
arscnListResponse[0].rri1_3	Restriction Data {0-2}	string
arscnListResponse[0].rri1_4	Restriction Data {0-2}	string
arscnListResponse[0].rri1_5	Restriction Data {0-2}	string
arscnListResponse[0].rri1_6	Restriction Data {0-2}	string
arscnListResponse[0].rri1_7	Restriction Data {0-2}	string
arscnListResponse[0].rri1_8	Restriction Data {0-2}	string
arscnListResponse[0].rri1_9	Restriction Data {0-2}	string
arscnListResponse[0].rri1_10	Restriction Data {0-2}	string
arscnListResponse[0].rri1_11	Restriction Data {0-2}	string
arscnListResponse[0].rri1_12	Restriction Data {0-2}	string
arscnListResponse[0].rri1_13	Restriction Data {0-2}	string
arscnListResponse[0].rri1_14	Restriction Data {0-2}	string
arscnListResponse[0].rri1_15	Restriction Data {0-2}	string
arscnListResponse[0].rri2_0	Restriction Data {0-2}	string
arscnListResponse[0].rri2_1	Restriction Data {0-2}	string
arscnListResponse[0].rri2_2	Restriction Data {0-2}	string
arscnListResponse[0].rri2_3	Restriction Data {0-2}	string
arscnListResponse[0].rri2_4	Restriction Data {0-2}	string
arscnListResponse[0].rri2_5	Restriction Data {0-2}	string
arscnListResponse[0].rri2_6	Restriction Data {0-2}	string
arscnListResponse[0].rri2_7	Restriction Data {0-2}	string
arscnListResponse[0].rri2_8	Restriction Data {0-2}	string
arscnListResponse[0].rri2_9	Restriction Data {0-2}	string
arscnListResponse[0].rri2_10	Restriction Data {0-2}	string
arscnListResponse[0].rri2_11	Restriction Data {0-2}	string
arscnListResponse[0].rri2_12	Restriction Data {0-2}	string
arscnListResponse[0].rri2_13	Restriction Data {0-2}	string
arscnListResponse[0].rri2_14	Restriction Data {0-2}	string
arscnListResponse[0].rri2_15	Restriction Data {0-2}	string
arscnListResponse[0].rri3_0	Restriction Data {0-2}	string
arscnListResponse[0].rri3_1	Restriction Data {0-2}	string
arscnListResponse[0].rri3_2	Restriction Data {0-2}	string
arscnListResponse[0].rri3_3	Restriction Data {0-2}	string
arscnListResponse[0].rri3_4	Restriction Data {0-2}	string
arscnListResponse[0].rri3_5	Restriction Data {0-2}	string
arscnListResponse[0].rri3_6	Restriction Data {0-2}	string
arscnListResponse[0].rri3_7	Restriction Data {0-2}	string
arscnListResponse[0].rri3_8	Restriction Data {0-2}	string
arscnListResponse[0].rri3_9	Restriction Data {0-2}	string
arscnListResponse[0].rri3_10	Restriction Data {0-2}	string
arscnListResponse[0].rri3_11	Restriction Data {0-2}	string
arscnListResponse[0].rri3_12	Restriction Data {0-2}	string
arscnListResponse[0].rri3_13	Restriction Data {0-2}	string
arscnListResponse[0].rri3_14	Restriction Data {0-2}	string
arscnListResponse[0].rri3_15	Restriction Data {0-2}	string

ARSC-Get Route Restriction Class (arscGet)

Gets the Route Restriction Class.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
tn	TN	Tenant Number {1-63}	False	string
rt	RT	Route Number {1-255}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
rri0_0	Restriction Data {0-2}	string
rri0_1	Restriction Data {0-2}	string
rri0_2	Restriction Data {0-2}	string
rri0_3	Restriction Data {0-2}	string
rri0_4	Restriction Data {0-2}	string
rri0_5	Restriction Data {0-2}	string
rri0_6	Restriction Data {0-2}	string
rri0_7	Restriction Data {0-2}	string
rri0_8	Restriction Data {0-2}	string
rri0_9	Restriction Data {0-2}	string
rri0_10	Restriction Data {0-2}	string
rri0_11	Restriction Data {0-2}	string
rri0_12	Restriction Data {0-2}	string
rri0_13	Restriction Data {0-2}	string
rri0_14	Restriction Data {0-2}	string
rri0_15	Restriction Data {0-2}	string
rri1_0	Restriction Data {0-2}	string
rri1_1	Restriction Data {0-2}	string
rri1_2	Restriction Data {0-2}	string
rri1_3	Restriction Data {0-2}	string
rri1_4	Restriction Data {0-2}	string
rri1_5	Restriction Data {0-2}	string
rri1_6	Restriction Data {0-2}	string
rri1_7	Restriction Data {0-2}	string
rri1_8	Restriction Data {0-2}	string
rri1_9	Restriction Data {0-2}	string
rri1_10	Restriction Data {0-2}	string
rri1_11	Restriction Data {0-2}	string
rri1_12	Restriction Data {0-2}	string
rri1_13	Restriction Data {0-2}	string
rri1_14	Restriction Data {0-2}	string
rri1_15	Restriction Data {0-2}	string
rri2_0	Restriction Data {0-2}	string
rri2_1	Restriction Data {0-2}	string
rri2_2	Restriction Data {0-2}	string
rri2_3	Restriction Data {0-2}	string
rri2_4	Restriction Data {0-2}	string
rri2_5	Restriction Data {0-2}	string
rri2_6	Restriction Data {0-2}	string
rri2_7	Restriction Data {0-2}	string
rri2_8	Restriction Data {0-2}	string
rri2_9	Restriction Data {0-2}	string
rri2_10	Restriction Data {0-2}	string
rri2_11	Restriction Data {0-2}	string
rri2_12	Restriction Data {0-2}	string
rri2_13	Restriction Data {0-2}	string
rri2_14	Restriction Data {0-2}	string
rri2_15	Restriction Data {0-2}	string
rri3_0	Restriction Data {0-2}	string
rri3_1	Restriction Data {0-2}	string
rri3_2	Restriction Data {0-2}	string
rri3_3	Restriction Data {0-2}	string
rri3_4	Restriction Data {0-2}	string
rri3_5	Restriction Data {0-2}	string
rri3_6	Restriction Data {0-2}	string
rri3_7	Restriction Data {0-2}	string
rri3_8	Restriction Data {0-2}	string
rri3_9	Restriction Data {0-2}	string
rri3_10	Restriction Data {0-2}	string
rri3_11	Restriction Data {0-2}	string
rri3_12	Restriction Data {0-2}	string
rri3_13	Restriction Data {0-2}	string
rri3_14	Restriction Data {0-2}	string
rri3_15	Restriction Data {0-2}	string

ARSC-Set Route Restriction Class (arscSet)

Sets the Route Restriction Class.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
tn	TN	Tenant Number {1-63}	False	string
rt	RT	Route Number {1-255}	True	string
rri0_0	RRI-0_0	Restriction Data {0-2}	False	string
rri0_1	RRI-0_1	Restriction Data {0-2}	False	string
rri0_2	RRI-0_2	Restriction Data {0-2}	False	string
rri0_3	RRI-0_3	Restriction Data {0-2}	False	string
rri0_4	RRI-0_4	Restriction Data {0-2}	False	string
rri0_5	RRI-0_5	Restriction Data {0-2}	False	string
rri0_6	RRI-0_6	Restriction Data {0-2}	False	string
rri0_7	RRI-0_7	Restriction Data {0-2}	False	string
rri0_8	RRI-0_8	Restriction Data {0-2}	False	string
rri0_9	RRI-0_9	Restriction Data {0-2}	False	string
rri0_10	RRI-0_10	Restriction Data {0-2}	False	string
rri0_11	RRI-0_11	Restriction Data {0-2}	False	string
rri0_12	RRI-0_12	Restriction Data {0-2}	False	string
rri0_13	RRI-0_13	Restriction Data {0-2}	False	string
rri0_14	RRI-0_14	Restriction Data {0-2}	False	string
rri0_15	RRI-0_15	Restriction Data {0-2}	False	string
rri1_0	RRI-1_0	Restriction Data {0-2}	False	string
rri1_1	RRI-1_1	Restriction Data {0-2}	False	string
rri1_2	RRI-1_2	Restriction Data {0-2}	False	string
rri1_3	RRI-1_3	Restriction Data {0-2}	False	string
rri1_4	RRI-1_4	Restriction Data {0-2}	False	string
rri1_5	RRI-1_5	Restriction Data {0-2}	False	string
rri1_6	RRI-1_6	Restriction Data {0-2}	False	string
rri1_7	RRI-1_7	Restriction Data {0-2}	False	string
rri1_8	RRI-1_8	Restriction Data {0-2}	False	string
rri1_9	RRI-1_9	Restriction Data {0-2}	False	string
rri1_10	RRI-1_10	Restriction Data {0-2}	False	string
rri1_11	RRI-1_11	Restriction Data {0-2}	False	string
rri1_12	RRI-1_12	Restriction Data {0-2}	False	string
rri1_13	RRI-1_13	Restriction Data {0-2}	False	string
rri1_14	RRI-1_14	Restriction Data {0-2}	False	string
rri1_15	RRI-1_15	Restriction Data {0-2}	False	string
rri2_0	RRI-2_0	Restriction Data {0-2}	False	string
rri2_1	RRI-2_1	Restriction Data {0-2}	False	string
rri2_2	RRI-2_2	Restriction Data {0-2}	False	string
rri2_3	RRI-2_3	Restriction Data {0-2}	False	string
rri2_4	RRI-2_4	Restriction Data {0-2}	False	string
rri2_5	RRI-2_5	Restriction Data {0-2}	False	string
rri2_6	RRI-2_6	Restriction Data {0-2}	False	string
rri2_7	RRI-2_7	Restriction Data {0-2}	False	string
rri2_8	RRI-2_8	Restriction Data {0-2}	False	string
rri2_9	RRI-2_9	Restriction Data {0-2}	False	string
rri2_10	RRI-2_10	Restriction Data {0-2}	False	string
rri2_11	RRI-2_11	Restriction Data {0-2}	False	string
rri2_12	RRI-2_12	Restriction Data {0-2}	False	string
rri2_13	RRI-2_13	Restriction Data {0-2}	False	string
rri2_14	RRI-2_14	Restriction Data {0-2}	False	string
rri2_15	RRI-2_15	Restriction Data {0-2}	False	string
rri3_0	RRI-3_0	Restriction Data {0-2}	False	string
rri3_1	RRI-3_1	Restriction Data {0-2}	False	string
rri3_2	RRI-3_2	Restriction Data {0-2}	False	string
rri3_3	RRI-3_3	Restriction Data {0-2}	False	string
rri3_4	RRI-3_4	Restriction Data {0-2}	False	string
rri3_5	RRI-3_5	Restriction Data {0-2}	False	string
rri3_6	RRI-3_6	Restriction Data {0-2}	False	string
rri3_7	RRI-3_7	Restriction Data {0-2}	False	string
rri3_8	RRI-3_8	Restriction Data {0-2}	False	string
rri3_9	RRI-3_9	Restriction Data {0-2}	False	string
rri3_10	RRI-3_10	Restriction Data {0-2}	False	string
rri3_11	RRI-3_11	Restriction Data {0-2}	False	string
rri3_12	RRI-3_12	Restriction Data {0-2}	False	string
rri3_13	RRI-3_13	Restriction Data {0-2}	False	string
rri3_14	RRI-3_14	Restriction Data {0-2}	False	string
rri3_15	RRI-3_15	Restriction Data {0-2}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARSC-Lists Route Restriction Class (arscList)

Lists the Route Restriction Class.

Request Properties

Name	Display	Description	Is Required	Type
d_n	D_N	Day/Night Mode {0-1}	True	string
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_rt	Start RT	The starting Route Number {1-255}	True	string
end_rt	End RT	The ending Route Number {1-255}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arscListResponse.count	The count of items.	string
arscListResponse[0].tn	Tenant Number {1-63}	string
arscListResponse[0].rt	Route Number {1-255}	string
arscListResponse[0].rri0_0	Restriction Data {0-2}	string
arscListResponse[0].rri0_1	Restriction Data {0-2}	string
arscListResponse[0].rri0_2	Restriction Data {0-2}	string
arscListResponse[0].rri0_3	Restriction Data {0-2}	string
arscListResponse[0].rri0_4	Restriction Data {0-2}	string
arscListResponse[0].rri0_5	Restriction Data {0-2}	string
arscListResponse[0].rri0_6	Restriction Data {0-2}	string
arscListResponse[0].rri0_7	Restriction Data {0-2}	string
arscListResponse[0].rri0_8	Restriction Data {0-2}	string
arscListResponse[0].rri0_9	Restriction Data {0-2}	string
arscListResponse[0].rri0_10	Restriction Data {0-2}	string
arscListResponse[0].rri0_11	Restriction Data {0-2}	string
arscListResponse[0].rri0_12	Restriction Data {0-2}	string
arscListResponse[0].rri0_13	Restriction Data {0-2}	string
arscListResponse[0].rri0_14	Restriction Data {0-2}	string
arscListResponse[0].rri0_15	Restriction Data {0-2}	string
arscListResponse[0].rri1_0	Restriction Data {0-2}	string
arscListResponse[0].rri1_1	Restriction Data {0-2}	string
arscListResponse[0].rri1_2	Restriction Data {0-2}	string
arscListResponse[0].rri1_3	Restriction Data {0-2}	string
arscListResponse[0].rri1_4	Restriction Data {0-2}	string
arscListResponse[0].rri1_5	Restriction Data {0-2}	string
arscListResponse[0].rri1_6	Restriction Data {0-2}	string
arscListResponse[0].rri1_7	Restriction Data {0-2}	string
arscListResponse[0].rri1_8	Restriction Data {0-2}	string
arscListResponse[0].rri1_9	Restriction Data {0-2}	string
arscListResponse[0].rri1_10	Restriction Data {0-2}	string
arscListResponse[0].rri1_11	Restriction Data {0-2}	string
arscListResponse[0].rri1_12	Restriction Data {0-2}	string
arscListResponse[0].rri1_13	Restriction Data {0-2}	string
arscListResponse[0].rri1_14	Restriction Data {0-2}	string
arscListResponse[0].rri1_15	Restriction Data {0-2}	string
arscListResponse[0].rri2_0	Restriction Data {0-2}	string
arscListResponse[0].rri2_1	Restriction Data {0-2}	string
arscListResponse[0].rri2_2	Restriction Data {0-2}	string
arscListResponse[0].rri2_3	Restriction Data {0-2}	string
arscListResponse[0].rri2_4	Restriction Data {0-2}	string
arscListResponse[0].rri2_5	Restriction Data {0-2}	string
arscListResponse[0].rri2_6	Restriction Data {0-2}	string
arscListResponse[0].rri2_7	Restriction Data {0-2}	string
arscListResponse[0].rri2_8	Restriction Data {0-2}	string
arscListResponse[0].rri2_9	Restriction Data {0-2}	string
arscListResponse[0].rri2_10	Restriction Data {0-2}	string
arscListResponse[0].rri2_11	Restriction Data {0-2}	string
arscListResponse[0].rri2_12	Restriction Data {0-2}	string
arscListResponse[0].rri2_13	Restriction Data {0-2}	string
arscListResponse[0].rri2_14	Restriction Data {0-2}	string
arscListResponse[0].rri2_15	Restriction Data {0-2}	string
arscListResponse[0].rri3_0	Restriction Data {0-2}	string
arscListResponse[0].rri3_1	Restriction Data {0-2}	string
arscListResponse[0].rri3_2	Restriction Data {0-2}	string
arscListResponse[0].rri3_3	Restriction Data {0-2}	string
arscListResponse[0].rri3_4	Restriction Data {0-2}	string
arscListResponse[0].rri3_5	Restriction Data {0-2}	string
arscListResponse[0].rri3_6	Restriction Data {0-2}	string
arscListResponse[0].rri3_7	Restriction Data {0-2}	string
arscListResponse[0].rri3_8	Restriction Data {0-2}	string
arscListResponse[0].rri3_9	Restriction Data {0-2}	string
arscListResponse[0].rri3_10	Restriction Data {0-2}	string
arscListResponse[0].rri3_11	Restriction Data {0-2}	string
arscListResponse[0].rri3_12	Restriction Data {0-2}	string
arscListResponse[0].rri3_13	Restriction Data {0-2}	string
arscListResponse[0].rri3_14	Restriction Data {0-2}	string
arscListResponse[0].rri3_15	Restriction Data {0-2}	string

AMNDN-Get Maximum Necessary Digits Data for NDM (amndnGet)

Gets the Maximum Necessary Digits Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1-2}	True	string
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
ma_id	MA_ID	Management Area ID {0-9999, 65535}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
maidflg	Management Area ID flag	string
mnd	Maximum Necessary Digits	string
toll	Toll Code Identification(TN is a more effective)	string
an	Account Number(TN is a more effective)	string
rate	Index Number for Billing (APEX Only and TN is a more effective)	string
a_d	Analog/Digital Line Data(TN is a more effective)	string

AMNDN-Set Maximum Necessary Digits Data for NDM (amndnSet)

Sets the Maximum Necessary Digits Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
ma_id	MA_ID	Management Area ID {0-9999, 65535}	True	string
mnd	MND	Maximum Necessary Digits {1-32}	True	string
toll	TOLL	Toll Code Identification(TN is a more effective) {0:Local Code, 1:Toll Code}	True	string
an	AN	Account Number(TN is a more effective) {0:Out of Service, 1:Account Code}	True	string
rate	RATE	Index Number for Billing (APEX Only and TN is a more effective) {0-63}	True	string
a_d	A_D	Analog/Digital Line Data(TN is a more effective) {0:Analog, 1:Digital}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMNDN-Delete Maximum Necessary Digits Data for NDM (amndnDel)

Deletes the Maximum Necessary Digits Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
ma_id	MA_ID	Management Area ID {0-9999, 65535}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMNDN-Lists Maximum Necessary Digits Data for NDM (amndnList)

Lists the Maximum Necessary Digits Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_dc	Start DC	The starting Destination Code {0-9,#,*} 10 digits max	True	string
end_dc	End DC	The ending Destination Code {0-9,#,*} 10 digits max	True	string
start_ma_id	Start MA_ID	The starting Management Area ID {0-9999, 65535}	True	string
end_ma_id	End MA_ID	The ending Management Area ID {0-9999, 65535}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
amndnListResponse.count	The count of items.	string
amndnListResponse[0].tn	Tenant Number {1-63}	string
amndnListResponse[0].dc	Destination Code {0-9,#,*} 10 digits max	string
amndnListResponse[0].ma_id	Management Area ID {0-9999}	string
amndnListResponse[0].mnd	Maximum Necessary Digits	string
amndnListResponse[0].toll	Toll Code Identification(TN is a more effective)	string
amndnListResponse[0].an	Account Number(TN is a more effective)	string
amndnListResponse[0].rate	Index Number for Billing (APEX Only and TN is a more effective)	string
amndnListResponse[0].a_d	Analog/Digital Line Data(TN is a more effective)	string

AMND-Get Maximum Necessary Digits Data (amndGet)

Gets the Maximum Necessary Digits Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
maidflg	Management Area ID flag	string
mnd	Maximum Necessary Digits	string
toll	Toll Code Identification(TN is a more effective)	string
an	Account Number(TN is a more effective)	string
rate	Index Number for Billing (APEX Only and TN is a more effective)	string
a_d	Analog/Digital Line Data(TN is a more effective)	string

AMND-Set Maximum Necessary Digits Data (amndSet)

Sets the Maximum Necessary Digits Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
mnd	MND	Maximum Necessary Digits {1-32}	True	string
toll	TOLL	Toll Code Identification(TN is a more effective) {0:Local Code, 1:Toll Code}	False	string
an	AN	Account Number(TN is a more effective) {0:Out of Service, 1:Account Code}	False	string
rate	RATE	Index Number for Billing (APEX Only and TN is a more effective) {0-63}	False	string
a_d	A_D	Analog/Digital Line Data(TN is a more effective) {0:Analog, 1:Digital}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMND-Delete Maximum Necessary Digits Data (amndDel)

Deletes the Maximum Necessary Digits Data.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
dc	DC	Destination Code {0-9,#,*} 10 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AMND-Lists Maximum Necessary Digits Data (amndList)

Lists the Maximum Necessary Digits Data.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_dc	Start DC	The starting Destination Code {0-9,#,*} 10 digits max	True	string
end_dc	End DC	The ending Destination Code {0-9,#,*} 10 digits max	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
amndListResponse.count	The count of items.	string
amndListResponse[0].tn	Tenant Number {1-63}	string
amndListResponse[0].dc	Destination Code {0-9,#,*} 10 digits max	string
amndListResponse[0].mnd	Maximum Necessary Digits	string
amndListResponse[0].toll	Toll Code Identification(TN is a more effective)	string
amndListResponse[0].an	Account Number(TN is a more effective)	string
amndListResponse[0].rate	Index Number for Billing (APEX Only and TN is a more effective)	string
amndListResponse[0].a_d	Analog/Digital Line Data(TN is a more effective)	string

APRDN-Get Priority Control Route Data for NDM (aprdnGet)

Gets the Priority Control Route Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ictype	Incoming Priority Detection Type	string
ogtype	Outgoing Priority Notification Type	string
prc	Priority Control	string
priority_a	Priority Class A	string
priority_b	Priority Class B	string
priority_c	Priority Class C	string
priority_d	Priority Class D	string
priority_e	Priority Class E	string

APRDN-Set Priority Control Route Data for NDM (aprdnSet)

Sets the Priority Control Route Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
ictype	ICTYPE	Incoming Priority Detection Type {0: No Detection, 1: First Digit, 2: SIP Header}	True	string
ogtype	OGTYPE	Outgoing Priority Notification Type {0: Nothing, 1: First Digit, 2: SIP Header}	True	string
prc	PRC	Priority Control {0: Disable, 1: Enable}	True	string
priority_a	PRIORITY_A	Priority Class A	False	string
priority_b	PRIORITY_B	Priority Class B	False	string
priority_c	PRIORITY_C	Priority Class C	False	string
priority_d	PRIORITY_D	Priority Class D	False	string
priority_e	PRIORITY_E	Priority Class E	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APRDN-Delete Priority Control Route Data for NDM (aprdnDel)

Deletes the Priority Control Route Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APRDN-Lists Priority Control Route Data for NDM (aprdnList)

Lists the Priority Control Route Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aprdnListResponse.count	The count of items.	string
aprdnListResponse[0].lgrt	Logical Route Number	string
aprdnListResponse[0].ictype	Incoming Priority Detection Type	string
aprdnListResponse[0].ogtype	Outgoing Priority Notification Type	string
aprdnListResponse[0].prc	Priority Control	string
aprdnListResponse[0].priority_a	Priority Class A	string
aprdnListResponse[0].priority_b	Priority Class B	string
aprdnListResponse[0].priority_c	Priority Class C	string
aprdnListResponse[0].priority_d	Priority Class D	string
aprdnListResponse[0].priority_e	Priority Class E	string

ARRPN-Get Route Restriction with Priority Control for NDM (arrpnGet)

Gets the Route Restriction with Priority Control for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ica	Incoming Restriction Control Priority Class A	string
oga	Outgoing Restriction Control Priority Class A	string
icb	Incoming Restriction Control Priority Class B	string
ogb	Outgoing Restriction Control Priority Class B	string
icc	Incoming Restriction Control Priority Class C	string
ogc	Outgoing Restriction Control Priority Class C	string
icd	Incoming Restriction Control Priority Class D	string
ogd	Outgoing Restriction Control Priority Class D	string
ice	Incoming Restriction Control Priority Class E	string
oge	Outgoing Restriction Control Priority Class E	string

ARRPN-Set Route Restriction with Priority Control for NDM (arrpnSet)

Sets the Route Restriction with Priority Control for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
ica	ICA	Incoming Restriction Control Priority Class A {0 : Permit, 1 : Restrict}	True	string
oga	OGA	Outgoing Restriction Control Priority Class A {0 : Permit, 1 : Restrict}	True	string
icb	ICB	Incoming Restriction Control Priority Class B {0 : Permit, 1 : Restrict}	True	string
ogb	OGB	Outgoing Restriction Control Priority Class B {0 : Permit, 1 : Restrict}	True	string
icc	ICC	Incoming Restriction Control Priority Class C {0 : Permit, 1 : Restrict}	True	string
ogc	OGC	Outgoing Restriction Control Priority Class C {0 : Permit, 1 : Restrict}	True	string
icd	ICD	Incoming Restriction Control Priority Class D {0 : Permit, 1 : Restrict}	True	string
ogd	OGD	Outgoing Restriction Control Priority Class D {0 : Permit, 1 : Restrict}	True	string
ice	ICE	Incoming Restriction Control Priority Class E {0 : Permit, 1 : Restrict}	True	string
oge	OGE	Outgoing Restriction Control Priority Class E {0 : Permit, 1 : Restrict}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARRPN-Delete Route Restriction with Priority Control for NDM (arrpnDel)

Deletes the Route Restriction with Priority Control for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {1-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARRPN-Lists Route Restriction with Priority Control for NDM (arrpnList)

Lists the Route Restriction with Priority Control for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {1-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {1-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arrpnListResponse.count	The count of items.	string
arrpnListResponse[0].lgrt	Logical Route Number	string
arrpnListResponse[0].ica	Incoming Restriction Control Priority Class A	string
arrpnListResponse[0].oga	Outgoing Restriction Control Priority Class A	string
arrpnListResponse[0].icb	Incoming Restriction Control Priority Class B	string
arrpnListResponse[0].ogb	Outgoing Restriction Control Priority Class B	string
arrpnListResponse[0].icc	Incoming Restriction Control Priority Class C	string
arrpnListResponse[0].ogc	Outgoing Restriction Control Priority Class C	string
arrpnListResponse[0].icd	Incoming Restriction Control Priority Class D	string
arrpnListResponse[0].ogd	Outgoing Restriction Control Priority Class D	string
arrpnListResponse[0].ice	Incoming Restriction Control Priority Class E	string
arrpnListResponse[0].oge	Outgoing Restriction Control Priority Class E	string

ARSAN-Get Restriction Data of Specific Area for NDM (arsanGet)

Gets the Restriction Data of Specific Area for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
adc	ADC	Access Digit Code {0-9,#,*} 16 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
pra_rest	Priority Class A	string
prb_rest	Priority Class B	string
prc_rest	Priority Class C	string
prd_rest	Priority Class D	string
pre_rest	Priority Class E	string

ARSAN-Set Restriction Data of Specific Area for NDM (arsanSet)

Sets the Restriction Data of Specific Area for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
adc	ADC	Access Digit Code {0-9,#,*} 16 digits max	True	string
pra_rest	PRA_REST	Priority Class A {0 : Permit, 1 : Restrict}	True	string
prb_rest	PRB_REST	Priority Class B {0 : Permit, 1 : Restrict}	True	string
prc_rest	PRC_REST	Priority Class C {0 : Permit, 1 : Restrict}	True	string
prd_rest	PRD_REST	Priority Class D {0 : Permit, 1 : Restrict}	True	string
pre_rest	PRE_REST	Priority Class E {0 : Permit, 1 : Restrict}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARSAN-Delete Restriction Data of Specific Area for NDM (arsanDel)

Deletes the Restriction Data of Specific Area for NDM.

Request Properties

Name	Display	Description	Is Required	Type
tn	TN	Tenant Number {1-63}	False	string
adc	ADC	Access Digit Code {0-9,#,*} 16 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ARSAN-Lists Restriction Data of Specific Area for NDM (arsanList)

Lists the Restriction Data of Specific Area for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_tn	Start TN	The starting Tenant Number {1-63}	True	string
end_tn	End TN	The ending Tenant Number {1-63}	True	string
start_adc	Start ADC	The starting Access Digit Code{0-9,#,*} 16 digits max	True	string
end_adc	End ADC	The ending Access Digit Code{0-9,#,*} 16 digits max	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
arsanListResponse.count	The count of items.	string
arsanListResponse[0].tn	Tenant Number {1-63}	string
arsanListResponse[0].adc	Access Digit Code{0-9,#,*} 16 digits max	string
arsanListResponse[0].pra_rest	Priority Class A {0 : Permit, 1 : Restrict}	string
arsanListResponse[0].prb_rest	Priority Class B {0 : Permit, 1 : Restrict}	string
arsanListResponse[0].prc_rest	Priority Class C {0 : Permit, 1 : Restrict}	string
arsanListResponse[0].prd_rest	Priority Class D {0 : Permit, 1 : Restrict}	string
arsanListResponse[0].pre_rest	Priority Class E {0 : Permit, 1 : Restrict}	string

AADCN-Get Additional Digit Translation Data for NDM (aadcnGet)

Gets the Additional Digit Translation Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
dc	Access Digit Code {0-9,#,*} 24 digits max	string

AADCN-Set Additional Digit Translation Data for NDM (aadcnSet)

Sets the Additional Digit Translation Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
dc	DC	Access Digit Code {0-9,#,*} 24 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AADCN-Delete Additional Digit Translation Data for NDM (aadcnDel)

Deletes the Additional Digit Translation Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AADCN-Lists Additional Digit Translation Data for NDM (aadcnList)

Lists the Additional Digit Translation Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_pnl	Start PNL	The starting Pattern Number Location {1-999}	True	string
end_pnl	End PNL	The ending Pattern Number Location {1-999}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aadcnListResponse.count	The count of items.	string
aadcnListResponse[0].pnl	Pattern Number Location	string
aadcnListResponse[0].dc	Access Digit Code	string

AADC-Get Additional Digit Translation Data (aadcGet)

Gets the Additional Digit Translation Data.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
dc	Access Digit Code {0-9,#,*} 24 digits max	string

AADC-Set Additional Digit Translation Data (aadcSet)

Sets the Additional Digit Translation Data.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
dc	DC	Access Digit Code {0-9,#,*} 24 digits max	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AADC-Delete Additional Digit Translation Data (aadcDel)

Deletes the Additional Digit Translation Data.

Request Properties

Name	Display	Description	Is Required	Type
pnl	PNL	Pattern Number Location {1-999}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

AADC-Lists Additional Digit Translation Data (aadcList)

Lists the Additional Digit Translation Data.

Request Properties

Name	Display	Description	Is Required	Type
start_pnl	Start PNL	The starting Pattern Number Location {1-999}	True	string
end_pnl	End PNL	The ending Pattern Number Location {1-999}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
aadcListResponse.count	The count of items.	string
aadcListResponse[0].pnl	Pattern Number Location	string
aadcListResponse[0].dc	Access Digit Code	string

APADN-Get PAD Data for NDM (apadnGet)

Gets the PAD Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station}	True	string
iclgrt	ICLGRT	Incoming Logical Route Number {1-899}	False	string
oglgrt	OGLGRT	Outgoing Logical Route Number {1-899}	False	string
sfc	SFC	Service Feature Class {0-15}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
icpad	Incoming PAD Data	string
ogpad	Outgoing PAD Data	string

APADN-Set PAD Data for NDM (apadnSet)

Sets the PAD Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station}	True	string
iclgrt	ICLGRT	Incoming Logical Route Number {1-899}	False	string
oglgrt	OGLGRT	Outgoing Logical Route Number {1-899}	True	string
sfc	SFC	Service Feature Class {0-15}	False	string
icpad	ICPAD	Incoming PAD Data {1-15}	True	string
ogpad	OGPAD	Outgoing PAD Data {1-15}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APADN-Delete PAD Data for NDM (apadnDel)

Deletes the PAD Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station}	True	string
iclgrt	ICLGRT	Incoming Logical Route Number {1-899}	False	string
oglgrt	OGLGRT	Outgoing Logical Route Number {1-899}	False	string
sfc	SFC	Service Feature Class {0-15}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APADN-Lists PAD Data for NDM (apadnList)

Lists the PAD Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station}	True	string
start_iclgrt	Start ICLGRT	The starting Incoming Logical Route Number {1-899}	False	string
end_iclgrt	End ICLGRT	The ending Incoming Logical Route Number {1-899}	False	string
start_oglgrt	Start OGLGRT	The starting Outgoing Logical Route Number {1-899}	False	string
end_oglgrt	End OGLGRT	The ending Outgoing Logical Route Number {1-899}	False	string
start_sfc	Start SFC	The starting Service Feature Class {0-15}	False	string
end_sfc	End SFC	The ending Service Feature Class {0-15}	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
apadnListResponse.count	The count of items.	string
apadnListResponse[0].iclgrt	Incoming Logical Route Number {1-899}	string
apadnListResponse[0].oglgrt	Outgoing Logical Route Number {1-899}	string
apadnListResponse[0].sfc	Service Feature Class {0-15}	string
apadnListResponse[0].icpad	Incoming PAD Data {1-15}	string
apadnListResponse[0].ogpad	Outgoing PAD Data {1-15}	string

APAD-Get PAD Data (apadGet)

Gets the PAD Data.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station, 3 : Outgoing, 4 : Incoming}	True	string
icrt	ICRT	Incoming Route Number {1-255}	False	string
ogrt	OGRT	Outgoing Route Number {1-255}	False	string
sfc	SFC	Service Feature Class {0-15}	False	string
dc	DC	Digit Code {0-9,#,*} 24 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
icpad	Incoming PAD Data	string
ogpad	Outgoing PAD Data	string

APAD-Set PAD Data (apadSet)

Sets the PAD Data.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station, 3 : Outgoing, 4 : Incoming}	True	string
icrt	ICRT	Incoming Route Number {1-899}	False	string
ogrt	OGRT	Outgoing Route Number {1-899}	False	string
sfc	SFC	Service Feature Class {0-15}	False	string
dc	DC	Digit Code {0-9,#,*} 24 digits max	False	string
icpad	ICPAD	Incoming PAD Data {1-15}	False	string
ogpad	OGPAD	Outgoing PAD Data {1-15}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APAD-Delete PAD Data (apadDel)

Deletes the PAD Data.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station, 3 : Outgoing, 4 : Incoming}	True	string
icrt	ICRT	Incoming Route Number {1-255}	False	string
ogrt	OGRT	Outgoing Route Number {1-255}	False	string
sfc	SFC	Service Feature Class {0-15}	False	string
dc	DC	Digit Code {0-9,#,*} 24 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

APAD-Lists PAD Data (apadList)

Lists the PAD Data.

Request Properties

Name	Display	Description	Is Required	Type
connect_kind	CONNECT_KIND	Connection Kind {1 : Tandem Connection, 2 : Station, 3 : Outgoing, 4 : Incoming}	True	string
start_icrt	Start ICRT	The starting Incoming Route Number {1-899}	False	string
end_icrt	End ICRT	The ending Incoming Route Number {1-899}	False	string
start_ogrt	Start OGRT	The starting Outgoing Route Number {1-899}	False	string
end_ogrt	End OGRT	The ending Outgoing Route Number {1-899}	False	string
start_sfc	Start SFC	The starting Service Feature Class {0-15}	False	string
end_sfc	End SFC	The ending Service Feature Class {0-15}	False	string
start_dc	Start DC	The starting Digit Code {0-9,#,*} 24 digits max	False	string
end_dc	End DC	The ending Digit Code {0-9,#,*} 24 digits max	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
apadListResponse.count	The count of items.	string
apadListResponse[0].icrt	Incoming Route Number {1-899}	string
apadListResponse[0].ogrt	Outgoing Route Number {1-899}	string
apadListResponse[0].sfc	Service Feature Class {0-15}	string
apadListResponse[0].dc	Digit Code {0-9,#,*} 24 digits max	string
apadListResponse[0].icpad	Incoming PAD Data {1-15}	string
apadListResponse[0].ogpad	Outgoing PAD Data {1-15}	string

ASYD-Get System Data (asydGet)

Gets the System Data.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2, 3 : System Data 3}	True	string
index	INDEX	Index {SYS = 1/INDEX = 0-511, SYS = 2/INDEX = 0-15, SYS = 3/INDEX = 0-31}	False	string
tn	TN	Tenant Number {1-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
data	Data	string
fdata	Fusion Network Data	string
mdata	Mask Data	string

ASYD-Set System Data (asydSet)

Sets the System Data.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2, 3 : System Data 3}	True	string
index	INDEX	Index {SYS = 1/INDEX = 0-511, SYS = 2/INDEX = 0-15, SYS = 3/INDEX = 0-31}	True	string
tn	TN	Tenant Number {1-63}	False	string
data	DATA	Data {0x00-FF}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASYD-Lists System Data (asydList)

Lists the System Data.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2, 3 : System Data 3}	True	string
start_index	Start INDEX	The starting Index {SYS = 1/INDEX = 0-511, SYS = 2/INDEX = 0-15, SYS = 3/INDEX = 0-31}	True	string
end_index	End INDEX	The ending Index {SYS = 1/INDEX = 0-511, SYS = 2/INDEX = 0-15, SYS = 3/INDEX = 0-31}	True	string
start_tn	Start TN	The starting Tenant Number {1-63}	False	string
end_tn	End TN	The ending Tenant Number {1-63}	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
asydListResponse.count	The count of items.	string
asydListResponse[0].index	Index {SYS = 1/INDEX = 0-511, SYS = 2/INDEX = 0-15, SYS = 3/INDEX = 0-31}	string
asydListResponse[0].tn	Tenant Number {1-63}	string
asydListResponse[0].data	Data	string
asydListResponse[0].fdata	Fusion Network Data	string
asydListResponse[0].mdata	Mask Data	string

ASYDL-Get System Data for LDM (asydlGet)

Gets the System Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2}	True	string
index	INDEX	Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	False	string
tn	TN	Tenant Number {1-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
data	Data	string
fdata	Fusion Network Data	string
mdata	Mask Data	string

ASYDL-Set System Data for LDM (asydlSet)

Sets the System Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2}	True	string
index	INDEX	Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	True	string
tn	TN	Tenant Number {1-63}	False	string
data	DATA	Data {0x00-FF}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASYDL-Lists System Data for LDM (asydlList)

Lists the System Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
sys	SYS	System Data Type {1 : System Data 1, 2 : System Data 2}	True	string
start_index	Start INDEX	The starting Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	True	string
end_index	End INDEX	The ending Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	True	string
start_tn	Start TN	The starting Tenant Number {1-63}	False	string
end_tn	End TN	The ending Tenant Number {1-63}	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
asydlListResponse.count	The count of items.	string
asydlListResponse[0].index	Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	string
asydlListResponse[0].tn	Tenant Number {1-63}	string
asydlListResponse[0].data	Data	string
asydlListResponse[0].fdata	Fusion Network Data	string
asydlListResponse[0].mdata	Mask Data	string

ASYDN-Get System Data for NDM (asydnGet)

Gets the System Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
index	INDEX	Index {0-1535}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
data	Data	string
fdata	Fusion Network Data	string
mdata	Mask Data	string

ASYDN-Set System Data for NDM (asydnSet)

Sets the System Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
index	INDEX	Index {0-1535}	True	string
data	DATA	Data {0x00-FF}	True	string
mdata	MDATA	Mask Data {0x00-FF}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ASYDN-Lists System Data for NDM (asydnList)

Lists the System Data for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_index	Start INDEX	The starting Index {0-1535}	True	string
end_index	End INDEX	The ending Index {0-1535}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
asydnListResponse.count	The count of items.	string
asydnListResponse[0].index	Index {SYS = 1/INDEX = 512-1535, SYS = 2/INDEX = 16-79}	string
asydnListResponse[0].data	Data	string
asydnListResponse[0].fdata	Fusion Network Data	string
asydnListResponse[0].mdata	Mask Data	string

ALOCL-Get Location ID Data for LDM (aloclGet)

Gets the Location ID Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1 : Network address, 2 : Point code, 3 : Fusion Point code, 4 : Station Number, 17 : Network address and Connection Route Number exist, 18 : Point code and Connection Route Number exist, 19 : Fusion Point code and Connection Route Number exist}	True	string
ip_address	IP_ADDRESS	Network Address {xxx.xxx.xxx.xxx}	False	string
pc	PC	Point code {1-16383}	False	string
fpc	FPC	Fusion Point code {1-253}	False	string
tn	TN	Tenant Number {0-15}	False	string
stn	STN	Station Number {0-9,#,*} 5 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
network_address	Net Mask	string
mask_bit	The Number of Mask Bit	string
loc_id	Location ID	string
tos_flag	ToS Data Validation Flag	string
tos_type	ToS Type	string
precedence	Precedence	string
delay	Low Delay	string
throughput	Through Put	string
reliability	Reliability	string
cost	Min Cost	string
dscp	DSCP	string
c_rt	Connection Route Number	string

ALOCL-Set Location ID Data for LDM (aloclSet)

Sets the Location ID Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1 : Network address, 2 : Point code, 3 : Fusion Point code, 4 : Station Number, 17 : Network address and Connection Route Number exist, 18 : Point code and Connection Route Number exist, 19 : Fusion Point code and Connection Route Number exist}	True	string
ip_address	IP_ADDRESS	Network Address {xxx.xxx.xxx.xxx}	False	string
mask_bit	MASK_BIT	The Number of Mask Bit {1-32}	False	string
loc_id	LOC_ID	Location ID {0-4095}	False	string
tos_flag	TOS_FLAG	ToS Data Validation Flag {0-1}	False	string
tos_type	TOS_TYPE	ToS Type {1: IP Precedence, 2: Diffserv}	False	string
precedence	PRECEDENCE	Precedence {0-7}	False	string
delay	DELAY	Low Delay {0-1}	False	string
throughput	THROUGHPUT	Through Put {0-1}	False	string
reliability	RELIABILITY	Reliability {0-1}	False	string
cost	COST	Min Cost {0-1}	False	string
dscp	DSCP	DSCP {0-63}	False	string
c_rt	C_RT	Connection Route Number {1-1023}	False	string
pc	PC	Point code {1-16383}	False	string
fpc	FPC	Fusion Point code {1-253}	False	string
tn	TN	Tenant Number {0-15}	False	string
stn	STN	Station Number {0-9,#,*} 5 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALOCL-Delete Location ID Data for LDM (aloclDel)

Deletes the Location ID Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1 : Network address, 2 : Point code, 3 : Fusion Point code, 4 : Station Number, 17 : Network address and Connection Route Number exist, 18 : Point code and Connection Route Number exist, 19 : Fusion Point code and Connection Route Number exist}	True	string
ip_address	IP_ADDRESS	Network Address {xxx.xxx.xxx.xxx}	False	string
pc	PC	Point code {1-16383}	False	string
fpc	FPC	Fusion Point code {1-253}	False	string
tn	TN	Tenant Number {0-15}	False	string
stn	STN	Station Number {0-9,#,*} 5 digits max	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALOCL-Lists Location ID Data for LDM (aloclList)

Lists the Location ID Data for LDM.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1 : Network address, 2 : Point code, 3 : Fusion Point code, 4 : Station Number, 17 : Network address and Connection Route Number exist, 18 : Point code and Connection Route Number exist, 19 : Fusion Point code and Connection Route Number exist}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
apadnListResponse.count	The count of items.	string
apadnListResponse[0].network_address	Net Mask {xxx.xxx.xxx.xxx}	string
apadnListResponse[0].mask_bit	The Number of Mask Bit {1-32}	string
apadnListResponse[0].loc_id	Location ID {0-4095}	string
apadnListResponse[0].tos_flag	ToS Data Validation Flag {0-1}	string
apadnListResponse[0].tos_type	ToS Type {1: IP Precedence, 2: Diffserv}	string
apadnListResponse[0].precedence	Precedence {0-7}	string
apadnListResponse[0].delay	Low Delay {0-1}	string
apadnListResponse[0].throughput	Through Put {0-1}	string
apadnListResponse[0].reliability	Reliability {0-1}	string
apadnListResponse[0].cost	Min Cost {0-1}	string
apadnListResponse[0].dscp	DSCP {0-63}	string
apadnListResponse[0].c_rt	Connection Route Number {1-1023}	string
apadnListResponse[0].pc	Point code {1-16383}	string
apadnListResponse[0].fpc	Fusion Point code {1-253}	string
apadnListResponse[0].tn	Tenant Number {0-15}	string
apadnListResponse[0].stn	Station Number {0-9,#,*} 5 digits max	string

ADPM-Set Data for PH Module (adpmSet)

Sets the Data for PH Module.

Request Properties

Name	Display	Description	Is Required	Type
type	TYPE	Request type {1 : IP Address, 2 : Options, 3 : PH Control, 4 : Internal SIP Handler Stop}	True	string
ipadr_act	IPADR_ACT	IPADR_ACT {xxx.xxx.xxx.xxx}	False	string
netmsk	NETMSK	NETMSK {xxx.xxx.xxx.xxx}	False	string
optn_kind	OPTN_KIND	Kind of TYPE=2 Options function {1 : PH module control, 2 : Configure application port number, 3 : Version Information}	False	string
cont	CONT	Kind of PH module control {1 : PH module initialize, 2 : PH module Reset}	False	string
port	PORT	Port Number of PH {1024-65534}	False	string
ph_kind	PH_KIND	PH Kind {1 : Internal SIP Handler, 2 : Internal PHI(BRI), 3 : Internal PHI(PRI), 4 : Internal PHE, 5 : Internal PHC, 6 : Internal PHF, 7 : Remote PIM over IP / PBUS over IP}	False	string
phd_cont	PHD_CONT	Kind of Internal PHD control {1 : Program non load initialize, 3 : Module stop instruction, 4 : Program non load initialize (LENS Specification), 5 : Module stop instruction (LENS Specification)}	False	string
lens	LENS	Line Equipment Number {XXXXXX}	False	string
phi_bri_cont	PHI_BRI_CONT	Kind of Internal PHI(BRI) control {1 : Internal PHI(BRI) Module Initialize, 2 : Internal PHI(BRI) Module Reset, 3 : Internal PHI(BRI) LENS Specification Module Initialize, 4 : Internal PHI(BRI) LENS Specification Module Reset}	False	string
phi_pri_cont	PHI_PRI_CONT	Kind of Internal PHI(PRI) control {1 : Internal PHI(PRI) Module Initialize, 2 : Internal PHI(PRI) Module Reset}	False	string
phe_cont	PHE_CONT	Kind of Internal PHE control {1 : Internal PHE Module Initialize, 2 : Internal PHE Module Reset, 3 : Internal PHE LENS Specification Module Initialize, 4 : Internal PHE LENS Specification Module Reset}	False	string
phc_cont	PHC_CONT	Kind of Internal PHC control {1 : Internal PHC Module Initialize, 2 : Internal PHC Module Reset, 3 : Internal PHC LENS Specification Module Initialize, 4 : Internal PHC LENS Specification Module Reset}	False	string
phf_cont	PHF_CONT	Kind of Internal PHF control {1 : Internal PHF Service type setting (signal packet), 2 : Internal PHF Module Initialize, 3 : Internal PHF Module Reset, 4 : Internal PHF Module stop}	False	string
rpi_cont	RPI_CONT	Kind of Remote PIM over IP / PBUS over IP {1 : Remote PIM over IP / PBUS over IP Service type setting (signal packet), 2 : Remote PIM over IP / PBUS over IP Module Initialize, 3 : Remote PIM over IP / PBUS over IP Module Reset, 4 : Remote PIM over IP / PBUS over IP Module stop}	False	string
tos_type	TOS_TYPE	ToS Type {1: IP Precedence, 2: Diffserv}	False	string
precedence	PRECEDENCE	Precedence {0-7}	False	string
delay	DELAY	Low Delay {0-1}	False	string
throughput	THROUGHPUT	Through Put {0-1}	False	string
reliability	RELIABILITY	Reliability {0-1}	False	string
cost	COST	Min Cost {0-1}	False	string
dscp	DSCP	DSCP {0-63}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ATIMN-Get Date and Time for The Fusion Network (atimnGet)

Gets the Date and Time for The Fusion Network.

Request Properties

Name	Display	Description	Is Required	Type
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
netfpcList.count	The count of items.	string
netfpcList[0].netfpc	The node assigned to LDM for the network	string
rcvfpcList.count	The count of items.	string
rcvfpcList[0].rcvfpc	The result received node	string
fpcList.count	The count of items.	string
fpcList[0].fpc	Fusion Point Code	string
fpcList[0].year	Data of the Year	string
fpcList[0].month	Data of the Month	string
fpcList[0].day	Data of the Day	string
fpcList[0].hour	Data of the Hour	string
fpcList[0].minute	Data of the Minute	string
fpcList[0].second	Data of the Second	string
fpcList[0].week	Data of the Week	string

MEM_HDD-Set Data Control Between Memory And Hdd 2 (memhddSet)

Sets the Data Control Between Memory And Hdd 2.

Request Properties

Name	Display	Description	Is Required	Type
cont	CONT	Data Control Type {1:The system memory save to HDD, 2:The HDD data load to the system memory, 3:The HDD data verify with the system memory}	True	string
drv	DRV	Drive {1:Drive B(Default), 2:Drive C, 3:Drive B/C}	False	string
data	DATA	Data Type {1:Data Memory, 2:Call Forwarding Data, 3:Speed Calling Data, 4:Wireless Call Forwarding, 5:Name Display Data, 6:User Assign Key Data, 7:Number Sharing Data, 8:ACD Data Memory, 9:Call Block Data, 12: Call Block Individual and Distinctive Ringing Data, 13: Expanded Speed Calling Data, 14: Logout Transfer Data, 15: One Touch Speed Calling Data for Dterm IP, 16: H.323 Terminal Transfer Data, 17: Message Area ID Data, 18: Backup MGC Initialize Data, 19: SIP Station Data, 20: SPD Name Data, 21: Not used(Internal process use), 22: Mobility Access Data, 23: Day Night Data, 24: Local Phone Book, 25: Soft Switch Data}	True	string
lpcnt	LPCNT	The number of LPNO {1-31}	False	string
lpno	LPNO	LP Number {0-255}	False	string
type	TYPE	Format Type of Response {0: Single Data of Response (CNT,LPNO invalidity), 1: Plural Data of Response (CNT,LPNO validity)}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
status	The status of the operation (0/1) (fail/success).	string
memhddResponse.count	The count of items.	string
memhddResponse[0].lpno	LP Number {0-255}	string
memhddResponse[0].response_status_act	RESPONSE_STATUS_ACT	string
memhddResponse[0].response_status_st_by	RESPONSE_STATUS_ST_BY	string
memhddResponse[0].err_drv_act	Error Drive for ACT side	string
memhddResponse[0].err_drv_st_by	Error Drive for STBY side	string

ADTM-Get Data for TCP/IP Module(SVNEXT) (adtmGet)

Gets the Data for TCP/IP Module(SVNEXT).

Request Properties

Name	Display	Description	Is Required	Type
lan_port	LAN_PORT	LAN Port number {1 : LAN1, 2 : LAN2, 3 : LAN3, 4 : LAN4}	True	string
type	TYPE	Signal type {1 : IP Address & Routing & NIC, 2 : Options, 3 : Status Check, 4 : IP Address Double Check for UMG, 5 : Internal LP IP Address Check, 6 : IP Address & Routing (version6)}	True	string
optn_kind	OPTN_KIND	Kind of TYPE=2 Options function {1 : TCP/IP module control, 2 : Trace function, 3 : Retrieve information, 4 : Configure SNMP, 5 : Configure application port number, 6 : Registration Service, 7 : PING, 8 : E-mail Fault Message, 9 : Static Routing, 10 : Default URL, 11 : FTP user account, 12 : DtermIP firmware update, 13 : DtrmIP MAC Registration Password, 14 : Configure DNS, 15 : Activation setting of Internal server, 16 : Associate Password, 17 : Fault Message output filter, 18 : Maintenance user account}	False	string
info	INFO	Kind of Retrieve information {2 : MAC address, 3 : log information}	False	string
side	SIDE	TCP/IP module side information {0 : Side-0, 1 : Side-1}	False	string
mail	MAIL	Kind of E-mail Fault Message {1 : Mail server, Reply Address, 2 : Destination Address}	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
ipadr_act	IP address(ACT)	string
netmsk	Subnet mask	string
ipadr_0	IP address(0 side)	string
ipadr_1	IP address(1 side)	string
gateway	IP address(default gateway)	string
rip	RIP information {0 : Invalid, 1 : Valid}	string
speed	SPEED {0 : Fixed 10Mbps, 1 : Fixed 100Mbps, 2 : Auto Negotiation(1Gbps Only), 4 : Auto Negotiation(10Mbps-1Gbps)}	string
duplex	DUPLEX MODE {0 : Half duplex, 1 : Full duplex}	string
ping_guard	Ping Guard {0 : There is ping guard, 1 : There is no ping guard}	string
arp_period	ARP Broadcasting Period {0 : Not sending, 1 : 30 seconds, 2 : 60 seconds, 3 : 120 seconds}	string
ipadr_act2	IP address(2ND ACT)	string
trace	Enable fault printer to output TCP/IP information {0 : Not output, 1 : Print warnings, 2 : Trace}	string
log_info	log information	string
mac_adr	MAC address	string
mat_lan_port	LAN port of MAT(TCP)	string
mat_port_no	Port Number of MAT(TCP)	string
smdr_lan_port	LAN port of SMDR(TCP)	string
smdr_port_no	Port Number of SMDR(TCP)	string
mci_lan_port	LAN port of MCI(TCP)	string
mci_port_no	Port Number of MCI(TCP)	string
oai_lan_port	LAN port of OAI(TCP)	string
oai_port_no	Port Number of OAI(TCP)	string
mis_lan_port	LAN port of MIS(TCP)	string
mis_port_no	Port Number of MIS(TCP)	string
cs_lan_port	LAN port of CS(TCP)	string
cs_port_no	Port Number of CS(TCP)	string
pms_lan_port	LAN port of PMS(TCP)	string
pms_port_no	Port Number of PMS(TCP)	string
mcc_lan_port	LAN port of MCC(TCP)	string
mcc_port_no	Port Number of MCC(TCP)	string
reg_lan_port	LAN port of REG(UDP)	string
reg_port_no	Port Number of REG(UDP)	string
ccis_lan_port	LAN port of CCIS(TCP)	string
CCIS_PORT_NO	Port Number of CCIS(TCP)	string
fccs_lan_port	LAN port of FCCS(TCP)	string
fccs_port_no	Port Number of FCCS(TCP)	string
internal_phi_pri_lan_port	LAN port of Internal PHI-PRI(TCP)	string
internal_phi_pri_port_no	Port Number of Internal PHI-PRI(TCP)	string
internal_phi_bri_lan_port	LAN port of Internal PHI-BRI(UDP)	string
internal_phi_bri_port_no	Port Number of Internal PHI-BRI(UDP)	string
internal_phe_lan_port	LAN port of Internal PHE(UDP)	string
internal_phe_port_no	Port Number of Internal PHE(UDP)	string
internal_phc_client_lan_port	LAN port of Internal PHC client(TCP)	string
internal_phc_client_port_no	Port Number of Internal PHC client(TCP)	string
internal_phc_server_lan_port	LAN port of Internal PHC server(TCP)	string
internal_phc_server_port_no	Port Number of Internal PHC server(TCP)	string
internal_phf_lan_port	LAN port of Internal PHF(UDP)	string
internal_phf_port_no	Port Number of Internal PHF(UDP)	string
nms_lan_port	LAN port of NMS(TCP)	string
nms_port_no	Port Number of NMS(TCP)	string
srmgc_health_check_server_lan_port	LAN port of Health check reception server between MGC and SR-MGC(UDP)	string
srmgc_health_check_server_port_no	Port Number of Health check reception server between MGC and SR-MGC(UDP)	string
srmgc_health_check_client_lan_port	LAN port of Health check transmission client between MGC and SR-MGC(UDP)	string
srmgc_health_check_client_port_no	Port Number of Health check transmission client between MGC and SR-MGC(UDP)	string
srmgc_charge_mgc_lan_port	LAN port of SR-MGC charge MGC side(TCP)	string
srmgc_charge_mgc_port_no	Port Number of SR-MGC charge MGC side(TCP)	string
srmgc_charge_srmgc_lan_port	LAN port of SR-MGC charge SR-MGC side(TCP)	string
srmgc_charge_srmgc_port_no	Port Number of SR-MGC charge SR-MGC side(TCP)	string
dns_lan_port	LAN port of DNS(UDP)	string
dns_port_no	Port Number of DNS(UDP)	string
sntp_lan_port	LAN port of SNTP(UDP)	string
sntp_port_no	Port Number of SNTP(UDP)	string
remote_node_lan_port	LAN port of Remote Node over IP / PBUS over IP(UDP)	string
remote_node_port_no	Port Number of Remote Node over IP / PBUS over IP(UDP)	string
internal_siph_sip_lan_port	LAN port of Internal SIP Handler SIP (UDP/TCP Server)	string
internal_siph_sip_port_no	Port Number of Internal SIP Handler SIP (UDP/TCP Server)	string
internal_siph_reg_lan_port	LAN port of Internal SIP Handler Registration (UDP)	string
internal_siph_reg_port_no	Port Number of Internal SIP Handler Registration (UDP)	string
internal_siph_nego_lan_port	LAN port of Internal SIP Handler Registration (UDP/TCP Server)	string
internal_siph_nego_port_no	Port Number of Internal SIP Handler Registration (UDP/TCP Server)	string
internal_siph_tls_lan_port	LAN port of Internal SIP Handler TLS (TCP Server)	string
internal_siph_tls_port_no	Port Number of Internal SIP Handler TLS (TCP Server)	string
mgc_ipadr1	MGC search address1	string
mgc_ipadr2	MGC search address2	string
login_fail	Consecutive Login Failure Threshold	string
encryption	Password Encryption {0 : MD5(default), 1 : Proprietary}	string
staticRoutingList.count	The count of items.	string
staticRoutingList[0].dest_ipadr	Destination IP address	string
staticRoutingList[0].dest_netmsk	Destination Subnet mask	string
staticRoutingList[0].router_ipadr	Router IP address	string
staticRoutingList[0].hops	Hops	string
default_url	Default URL	string
version	Firmware Version	string
fw_file_name	Firmware Filename	string
fw_user_name	Firmware User Name	string
fw_password	Firmware Password	string
fw_ftp_srv	Firmware FTP Server type {0 : No Data, 1 : ACT CPU, 2 : SBY CPU, 3 : External Server}	string
fw_ftp_srv_ipadr	Firmware FTP Server IP Address	string
fw_ftp_srv_dir	Firmware FTP Server Directory	string
password	Account Password	string
associate	Associate Server {0 : Invalid, 1 : Valid}	string
internal_flf	Internal FLF Server {0 : Invalid, 1 : Valid}	string
ftp	FTP Server {0 : Invalid, 1 : Valid}	string
internal_claim	Internal Claim Server {0 : Invalid, 1 : Valid}	string
remote_login	Remote Login {0 : Invalid, 1 : Valid}	string
ssh	Enable SSH Server {0 : Invalid, 1 : Valid}	string
telnet	Enable Telnet Server {0 : Invalid, 1 : Valid}	string
http	Enable HTTP Server {0 : Invalid, 1 : Valid}	string
mainteUserList.count	The count of items.	string
mainteUserList[0].mainte_user_name	Maintenance user name	string
mainteUserList[0].mainte_password	Maintenance user password	string
mainteUserList[0].mainte_level	Maintenance user level {5 : Low}	string
mainteUserList[0].ftp_access	Permission of FTP access {0 : Deny, 1 : Allow}	string
mainteUserList[0].ssh_access	Permission of SSH access {0 : Deny, 1 : Allow}	string
mainteUserList[0].telnet_access	Permission of TELNET access {0 : Deny, 1 : Allow}	string
ipv6_adr_act	IPv6 address(ACT)	string
ipv6_adr_0	IPv6 address(0 side)	string
ipv6_adr_1	IPv6 address(1 side)	string
ipv6_prefix_length	IPv6 address prefix length	string
ipv6_gateway	IPv6 address(default gateway)	string
snmp_active	SNMP activation {0 : Not activate, 1 : Activate}	string
sys_descr	System description	string
sysObjectIdList.count	The count of items.	string
sysObjectIdList[0].sys_objectid	Object ID	string
sys_contact	System contact	string
sys_name	System name	string
sys_location	System location	string
trap	Trap information {0 : Disable, 1 : Enable}	string
snmp1List.count	The count of items.	string
snmp1List[0].community_name	Community name	string
snmp1List[0].snmp_mgr_ipadr	IP address of SNMP Manager	string
snmp1List[0].privileges	Privileges mode {1 : Read only, 2 : Writing allowed}	string
snmp2List.count	The count of items.	string
snmp2List[0].trap_community_name	Trap community name	string
snmp2List[0].snmp_mgr_ipadr	IP address of SNMP Manager	string
snmp2List[0].agent_adr	Agent Address	string
mail_server_ipadr	IP address of mail server	string
host_name	Host name of MGC	string
reply_mailadr	Reply mail address	string
txt_size	Maximum Text Size	string
diff_time	Difference from GMT	string
sending	E-mail Fault Message information {0 : Not sending, 1 : Sending}	string
smtp_auth	SMTP Authentication type {0 : SMTP authentication not used, 1 : SMTP authentication is CRAM-MD5}	string
smtp_user_name	SMTP User name	string
smtp_password	SMTP Password	string
dest_mailadr1	Destination mail address1	string
dest_mailadr2	Destination mail address2	string
dest_mailadr3	Destination mail address3	string
userList.count	The count of items.	string
userList[0].user_name	User name	string
userList[0].password	Account Password	string
userList[0].default_dir	FTP Default Directory	string
userList[0].level	FTP User level {3 : High, 4 : Middle(Default), 5 : Low}	string
data_num	Number of DNS IP Address	string
dns_ipadr1	DNS IP Address1	string
dns_ipadr2	DNS IP Address2	string
dns_ipadr3	DNS IP Address3	string
e_mail	E-Mail output {0 : ALL, 1 : SUP, 2 : MINOR, 3 : MAJOR}	string
snmp_trap	SNTP TRAP output {0 : ALL, 1 : SUP, 2 : MINOR, 3 : MAJOR}	string
debug_console	DEBUG Console output {0 : ALL, 1 : SUP, 2 : MINOR, 3 : MAJOR}	string
oid	OID of SNMP TRAP sending {0 : Common to OID, 1 : Separate to OID}	string
enable_fccs	FCCS Status {0 : Disable, 1 : Enable}	string

ALRTN-Get Logical RT for NDM (alrtnGet)

Gets the Logical RT for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
alrtnGetResponse.count	The count of items.	string
alrtnGetResponse[0].fpc	Fusion Point Code	string
alrtnGetResponse[0].rt	Route Number	string

ALRTN-Set Logical RT for NDM (alrtnSet)

Sets the Logical RT for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
fpc	FPC	Fusion Point Code {1-253}	True	string
rt	RT	Route Number {1-255}	True	string
loc	LOC	Location data {0-2}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALRTN-Delete Logical RT for NDM (alrtnDel)

Deletes the Logical RT for NDM.

Request Properties

Name	Display	Description	Is Required	Type
lgrt	LGRT	Logical Route Number {0-899}	True	string
loc	LOC	Location data {0-2}	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
status	The status of the operation (0/1) (fail/success).	string

ALRTN-Lists Logical RT for NDM (alrtnList)

Lists the Logical RT for NDM.

Request Properties

Name	Display	Description	Is Required	Type
start_lgrt	Start LGRT	The starting Logical Route Number {0-899}	True	string
end_lgrt	End LGRT	The ending Logical Route Number {0-899}	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
alrtnListResponse.count	The count of items.	string
alrtnListResponse[0].lgrt	Logical Route Number	string
alrtnListResponse.items.count	The count of items.	string
alrtnListResponse[0].items[0].fpc	Fusion Point Code	string
alrtnListResponse[0].items[0].rt	Route Number	string

DLEN-Get Display of LEN Data (dlenGet)

Gets Display of LEN Data.

Request Properties

Name	Display	Description	Is Required	Type
lens	Line Equipment Number	The line equipment number location for the terminal.	True	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
lens	The line equipment number location for the terminal.	string
tn	Tenant Number	string
stn	Station Number	string
tec	Telephone Equipment Class	string
rsc	Route Restriction Class	string
sfc	Service Feature Restriction Class	string
room_class	Room Class	string
annex	Annex	string
ground	Ground/Underground	string
floor	Floor	string
rt	Route Number	string
tk	Trunk Number	string
c_rt	Connection Route Number	string
c_tk	Connection Trunk Number	string
pcn	PHS Community Number	string
ern	Calling Area Number	string
grn	Group Number	string
csn	CS/ZT Number	string
chno	Channel Number	string
available	Availability {0:vacant, 1:in use}	string

DLEN-Lists Display of LEN Data (dlenList)

Lists Display of LEN Data.

Request Properties

Name	Display	Description	Is Required	Type
start_lens	Start Line Equipment Number	The line equipment number location for the terminal.	True	string
end_lens	End Line Equipment Number	The line equipment number location for the terminal.	True	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string
dlenListResponse.count	The count of items.	string
dlenListResponse[0].lens	The line equipment number location for the terminal.	string
dlenListResponse[0].tn	Tenant Number	string
dlenListResponse[0].stn	Station Number	string
dlenListResponse[0].tec	Telephone Equipment Class	string
dlenListResponse[0].rsc	Route Restriction Class	string
dlenListResponse[0].sfc	Service Feature Restriction Class	string
dlenListResponse[0].room_class	Room Class	string
dlenListResponse[0].annex	Annex	string
dlenListResponse[0].ground	Ground/Underground	string
dlenListResponse[0].floor	Floor	string
dlenListResponse[0].rt	Route Number	string
dlenListResponse[0].tk	Trunk Number	string
dlenListResponse[0].c_rt	Connection Route Number	string
dlenListResponse[0].c_tk	Connection Trunk Number	string
dlenListResponse[0].pcn	PHS Community Number	string
dlenListResponse[0].ern	Calling Area Number	string
dlenListResponse[0].grn	Group Number	string
dlenListResponse[0].csn	CS/ZT Number	string
dlenListResponse[0].chno	Channel Number	string
dlenListResponse[0].available	Availability {0:vacant, 1:in use}	string

Execute Command (executeCommand)

Executes the specified command and operation.

Request Properties

Name	Display	Description	Is Required	Type
command	Command	Specifies the command to execute.	True	string
operation	Operation	Specifies the operation to execute.	True	string
parameters	Parameters	Specify request parameters in JSON format.	False	string
async	Async	Specify '1' to execute the command asynchronously, or '0' to execute the command synchronously.	False	string
pbxId	PBX ID (for API Mode)	Specify the PBX ID only when API Mode is enabled.	False	string

Response Properties

Name	Description	Type
requestId	If executed asynchronously, this parameter will be returned.	string

To JSON String (toJsonString)

Converts the specified object to a JSON string.

Request Properties

Name	Display	Description	Is Required	Type
value	Value	Object to convert to Json string.	True	string

Register PBX (registerPbx)

Register a PBX information.

Request Properties

Name	Display	Description	Is Required	Type
pbxId	PBX Id	ID that identifies the PBX	True	string
pbxAddress	IP-Address	The IP address of the SV95 PBX system.	True	string
pbxPort	Port	The SV95 port assigned as the MAT.	True	string
username	Username	The SV95 port assigned as the MAT.	False	string
password	Password	The password for the user to login to the SV95's MAT.	False	string
fpc	Fusion Point Code	The Fusion Point Code number assigned to this connection.	False	string
enableStatusChange	Enable Status Change	Notify PBX Connection Status Change event.	False	boolean

Register PBX in bulk (registerPbxs)

Register PBX information in bulk.

Request Properties

Name	Display	Description	Is Required	Type
pbxs	Multiple PBX	Property name of PBX information Object List. Object is included in pbxId, pbxAddress, pbxPort, username, password, fpc and enableStatusChange. e.g. 'pbxs[0].pbxId=1, pbxs[0].pbxAddress=10.1.1.1, pbxs[0].pbxPort=60000,pbxs[1].pbxId=2, pbxs[1].pbxAddress=10.1.1.2, pbxs[1].pbxPort=60000'	True	string

Response Properties

Name	Description	Type
fails.count	The count of items.	string
fails[0]	Pbx Id for Register Failed	string

Unegister PBX (unregisterPbx)

Unregister a PBX information.

Request Properties

Name	Display	Description	Is Required	Type
pbxId	PBX Id	ID that identifies the PBX	True	string

Unregister PBX in bulk (unregisterPbxs)

Unregister PBX information in bulk.

Request Properties

Name	Display	Description	Is Required	Type
pbxs	Multiple PBX ID	Property name of PBX information Object List. Object is included in pbxId. e.g. 'pbxs[0].pbxId=1, pbxs[1].pbxId=2'	True	string

Get PBX Status (getPbxStatus)

Get PBX Connection Status

Request Properties

Name	Display	Description	Is Required	Type
pbxId	PBX Id	ID that identifies the PBX	True	string

Response Properties

Name	Description	Type
connected	Connection status (true: connected, false: disconnected)	string

Get Register PBXs (getRegisterPbxs)

Get Register PBX list

Response Properties

Name	Description	Type
pbxs.count	The count of items.	string
pbxs[0].pbxId	ID that identifies the PBX	string
pbxs[0].connected	Connection status (true: connected, false: disconnected)	string
pbxs[0].pbxAddress	The IP address of the SV95 PBX system.	string
pbxs[0].pbxPort	The SV95 port assigned as the MAT.	string
pbxs[0].username	The SV95 port assigned as the MAT.	string
pbxs[0].password	The password for the user to login to the SV95's MAT.	string
pbxs[0].fpc	The Fusion Point Code number assigned to this connection.	string

Events

SV95 Connected (sv95Connected)

The connection to SV95 system has been established.

No properties defined

Async command complete (commandComplete)

Asynchronous command execution completed.

Event Properties

Name	Display	Description	Type
requestId	RequestId	ID that identifies the request	string
commandName	CommandName	Completed command name	string
pbxId	PBX ID (for API Mode)	PBX ID for command complete	string

API Mode Started (multipleModeStarted)

Adapter started as API Mode. this event is enabled on the API Mode.

No properties defined

SV95 Connection Status Changed (sv95StatusChanged)

The connection to SV95 system has been established or not. this event is enabled on the API Mode.

Event Properties

Name	Display	Description	Type
pbxId	PbxId	PBX ID that changed connection status.	string
connected	Connected	Connection status (true: connected, false: disconnected)	string

Release History

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.	NAP-18538
2.0.2	Feature	Add AAST, ADKS, AGST, AISTL, AKYD, ALGSN, AMACN, ANDD, ASDT, APSW, DISD Commands	NAP-23274
2.0.3	Maintenance	Updated third-party components and improved maintainability.	NAP-27635	2024-07-31