6 IAD digital class

• Note: For the number of slots available, refer to sys_info/oem for instructions.
• Note: The policy limits the number, refer to the sys_info/oem description.
• Note: This class interface can be called only if the current interface is digital, refer to sys_info/oem for instructions.
• Note: BRI, PRI, MFCR2 groups are shared.
• SS7 includes: SS7LINK SS7LINKSET

6.1 Digital global

6.1.1 Driver settings /digital/tel_set

Client→Server Request

KEY	VAL	REQ	DEF	Remark	Renew
driver_custom	string	N	unoccupied	(ALL) Driver Extension Parameters Format: up to 64 characters, nullable	240131
default_linemode	string	N	e1	(extraface=t1e1 valid) Digital trunk interface type Format: e1,t1,j1	240131
loadzone	string	N	cn	(ALL) LINE AUDIO REGIONAL CODE Optional: us, au, fr, nl, uk, fi, es, jp, no, at, nz, it, us-old, gr, tw, cl, se, be, sg, il, br, hu, lt, pl, za, pt, ee, mx, in, de, ch, dk, cz, cn, ar, my, th. bg, ve, ph, ru, tr, pa, mo, cr, ae	240131
language	string	N	cn	(ALL) Audio Area Codes Optional: at, au, bg, br, be, ch, cl, cn, cz, de, dk, ee, es, fi, fr, gr, hu, id, il, in, it, lt, jp, mx, my, nl, no, nz, ph, pl, pt, ru, se, sg, th, uk, us, us-old , tw, ve, za	240131
priindication	string	N	outofband	(BRI/PRI) Method of generating BUSY and CONGESTION notifications Format: inband (play tone without answering, not necessarily supported by the other end) outofband (send disconnect message, play tone on the other end)	240131
jbenable	string	N	no	(ALL) Jitter buffer on Optional: yes/no	240131
jbmaxsize	int	N	200	(ALL) Jitter Maximum Buffer Optional: 10-10000 units ms	240131
jbresyncthreshold	int	N	1000	(ALL) Jump frame timestamp on jitter resynchronisation Optional: 10-10000 units ms	240131
jbimpl	string	N	fixed	(ALL) jitter buffer method Optional: fixed (static buffer, jbmaxsize only), adaptive (variable buffer)	240131
jbtargetextra	int	N	40	(ALL) Jitter variable new buffer size (valid only in ADAPTIVE) for use in case of sudden peak jitter. Optional: 10-10000 units ms	240131
dtmf_to_total_energy	int	N	42	(ALL) DTMF total energy scaling factor Optional: 10-100	240131
dtmf_gsize	int	N	120	(ALL) DTMF Sampling Points per Detection Zone Optional: 80-160	240131
dtmf_threshold	int	N	80000000	(ALL) DTMF Energy Threshold Optional: 80000000-240000000	240131
				MFCR2 configuration (TODO Note that it will cause the interface board disk to be full, do not implement it for the time being)	240131
mfcr2_call_files	string	N	no	(MFCR2) Whether MFCR2 keeps a log Format: yes, no	240131
mfcr2_logging	string	N	nothing	(MFCR2) MFCR2 log level Format: all error warning debug notice cas mf stack nothing	240131

Server→Client Response

Request Example

Post:/controller/digital/tel_set
Host:172.16.6.79
Raw:{"driver_custom":"","default_linemode":"e1","loadzone":"cn","language":"cn","priindication":"outofband","jbenable":"no","jbmaxsize":200,"jbresyncthreshold":1000,"jbimpl":"fixed","jbtargetextra":40,"dtmf_to_total_energy":35,"dtmf_gsize":120,"dtmf_threshold":80000000,"mfcr2_call_files":"no","mfcr2_logging":"nothing","token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital/tel_set","msg":"","code":200,"data":[]}

6.1.2 Driver acquisition /digital/tel_get

Client→Server Request

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark
			Refer to /digital/tel_set description

Request Example

Post:/controller/digital/tel_get
Host:172.16.6.79
Raw:{ "token": "bb3bcfc8771679d3b80288a7ade46238"}

Response Example

{
"uri": "digital/tel_get",
"msg": "",
"code": 200,
"data": {
"driver_custom": "",
"default_linemode": "e1",
"loadzone": "cn",
"language": "cn",
"priindication": "outofband",
"jbenable": "no",
"jbmaxsize": 200,
"jbresyncthreshold": 1000,
"jbimpl": "fixed",
"jbtargetextra": 40,
"dtmf_to_total_energy": 35,
"dtmf_gsize": 120,
"dtmf_threshold": 80000000,
"mfcr2_call_files": "no",
"mfcr2_logging": "nothing"
}
}

6.1.3 VOIP settings /digital/voip_set

Client→Server Request

KEY	VAL	REQ	DEF	Remark	Renew
user_agent	string	N	OIAD	SIP protocol user-agent string Length: 1-64 Note: This parameter cannot be modified when the user_agent_force of UCI is not empty.	240228
quick_dnssrv_switch	string	N	no	Fast DNSSRV switching Format: yes (yes) no (no)	240418
timer_t1	int	N	500	Transmission time T1 value Format: (ms) 100-10000000	240131
timer_t2	int	N	4000	Transmission time T2 value Format: (ms) 800-10000000	240131
allow_tx_hash_in_uri	string	N	no	The “#” sign is not escaped Format: yes (yes) no (no)	240131
timers	string	N	yes	Session Timer (RFC4028) support method Format: yes/no/always/required	240131
timers_min_se	int	N	90	Session refresh minimum interval Format: (ms) 90-10000000	240131
timers_sess_expires	int	N	1800	Session refresh maximum interval (must be greater than or equal to the minimum value) Format: (ms) 90-10000000	240131
g723_rate	string	N	63	G723 Rate Optional: 63 (6.3kbps encoding rate) 53 (5.3kbps encoding rate) No field if the device does not support G723 codecs	240223
ilbc_mode	string	N	30	iLBC frame duration Optional: 20(20ms) 30(30ms) No field if the device does not support iLBC codecs	240223
in_ringtime	int	N	55	(dialplan) Incoming call wait timeout Optional: 10-1000 units of s	240131
out_ringtime	int	N	55	(dialplan) Outgoing wait timeout Optional: 10-1000 units of s	240131
sip_cid2	int	N	0	(dialplan) Calling number display priority: 0 (FROM), 1 (P-Asserted-Identity)	240131
calltimeout	int	N	43200000	Call Maximum Limit Format: 0-9999999999 Unit ms 0 for unlimited	240131

Server→Client Response

Request Example

Post:/controller/digital/voip_set
Host:172.16.6.79
Raw:{"in_ringtime":55,"out_ringtime":55,"user_agent":"OIAD","quick_dnssrv_switch":"no","timer_t1":500,"timer_t2":4000,"allow_tx_hash_in_uri":"no","timers":"yes","timers_min_se":90,"timers_sess_expires":1800,"sip_cid2":0,"calltimeout":43200000,"early_media":"no","g723_rate":"63","ilbc_mode":"30","token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital/voip_set","msg":"","code":200,"data":[]}

6.1.4 VOIP get /digital/voip_get

Client→Server Request

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
user_agent			Note: The value of this parameter is null when the user_agent_force of UCI is not null.	240228
			Reference /digital/voip_set

Request Example

Post:/controller/digital/voip_get
Host:172.16.6.79
Raw:{ "token": "bb3bcfc8771679d3b80288a7ade46238"}

Response Example

{
"uri": "digital/voip_get",
"msg": "",
"code": 200,
"data": {
"in_ringtime": 55,
"out_ringtime": 55,
"user_agent": "OIAD",
"quick_dnssrv_switch": "no",
"timer_t1": 500,
"timer_t2": 4000,
"allow_tx_hash_in_uri": "no",
"timers": "yes",
"timers_min_se": 90,
"timers_sess_expires": 1800,
"sip_cid2": 0,
"calltimeout": 43200000,
"early_media": "no",
"g723_rate": "63",
"ilbc_mode": "30"
}
}

6.2 Digital interfaces

6.2.1 Full search /digital_span/span_list

• Note: The port configuration data read is the maximum supported data

Client→Server Request

KEY	VAL	Default	Remark	Renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230310
type	string	span	Type Format: span bri pri mfcr2 all	230515
enable	string	unoccupied	Filter number is enable Format: yes/no/empty	230515

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
slotnum	int		Slot number Format: not null, note limitations, invalid error report	230310
span	array		Format: [{KV}…] , refer to digital_span/span_set description	230314
bri	array		Format: [{KV}…] , refer to digital_span/bri_set description	230310
pri	array		Format: [{KV}…] , refer to digital_span/pri_set description	230310
mfcr2	array		Format: [{KV}…] , refer to digital_span/mfcr2_set description	230321

Request Example

Post:/controller/digital_span/span_list
Host:172.16.6.79
Raw:{"slotnum":0,"type":"span","enable":"","token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{
"uri": "digital_span/span_list",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"span": [
{
"slotnum": 0,
"span": 1,
"pcm_encoding": "",
"timing": "remote",
"hardhdlc": 0,
"bri_framing": "ccs",
"bri_coding": "ami",
"bri_dchan": 3,
"t1e1_lbo": 0,
"t1e1_framing": "ccs",
"t1e1_coding": "hdb3",
"t1e1_crc4": "no",
"t1e1_type": "pri",
"t1e1_dchan": 16
},
{
"slotnum": 0,
"span": 2,
"pcm_encoding": "",
"timing": "remote",
"hardhdlc": 0,
"bri_framing": "ccs",
"bri_coding": "ami",
"bri_dchan": 3,
"t1e1_lbo": 0,
"t1e1_framing": "ccs",
"t1e1_coding": "hdb3",
"t1e1_crc4": "no",
"t1e1_type": "pri",
"t1e1_dchan": 16
}
],
"bri": [],
"pri": [],
"mfcr2": [],
"ec_ranges": [
"yes",
"no"
]
}
}

6.2.2 Reserved positions /digital_span/xxx

6.2.3 SPAN Configuration /digital_span/span_set

• Fillable values for cable distance.

0: 0 db (CSU) / 0-133 feet (DSX-1) 1: 133-266 feet (DSX-1) 2: 266-399 feet (DSX-1) 3: 399-533 feet (DSX-1) 4: 533-655 feet (DSX-1) 5: -7.5db (CSU) 6: -15db ( CSU) 7: -22.5db (CSU)

Client→Server Request

KEY	VAL	REQ	Default	Remark	Renew
slotnum	int	Y	–	Slot number Format: not null, note limitations, invalid error report	230307
span	int	Y	–	Interface number Format: not null, note the restriction, invalid error report	230307
timing	string	N	remote	Clock source Format: local, remote	230307
pcm_encoding	string	N	unoccupied	PCM encoding Format: null (default) alaw mulaw Note: MFCR2 mandatory alaw	230315
hardhdlc	int	N	0	Whether to enable HDLC encoding and decoding Format: 0 (not enabled) 1 (enabled)	240612
bri_framing	string	N	ccs	(BRI) framing Format: ccs	230307
bri_coding	string	N	ami	(BRI) Line code Format: ami	230307
bri_dchan	int	N	3	(BRI) Channel D Format: 1-3	230308
t1e1_lbo	int	N	0	(T1/E1/J1) Cable distance Format: 0 1 2 3 4 5 6 7, fillable values for cable distance (refer to table description)	240612
t1e1_framing	string	N	ccs	(T1/E1/J1) Framing Format: cas(E1) ccs(E1) d4(T1) esf(T1) Note: MFCR2 forces cas to be framed.	230315
t1e1_coding	string	N	hdb3	(T1/E1/J1) Line code Format: ami(E1/T1) hdb3(E1) b8zs(T1)	230307
t1e1_crc4	string	N	no	(E1) CRC4 validation Format: yes (E1 only) no	230307
t1e1_type	string	N	pri	(T1/E1/J1) Signalling model Format: pri ss7 mfcr2 Note: mfcr2 can only be set when (digital interface is E1).	230307
t1e1_dchan	int	N	16	(T1/E1/J1) D channel PRI format: 1-31 (E1) 1-24 (T1) MFCR2 format: forced 16 SS7 format: forced 0	230315

Server→Client Response

Request Example

Post:/controller/digital_span/span_set
Host:172.16.6.79
Raw:{"slotnum":0,"span":1,"pcm_encoding":"alaw","timing":"local","hardhdlc":0,"bri_framing":"ccs","bri_coding":"ami","bri_dchan":3,"t1e1_lbo":0,"t1e1_framing":"ccs","t1e1_coding":"hdb3","t1e1_crc4":"no","t1e1_type":"pri","t1e1_dchan":16,"token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital_span/span_set","msg":"","code":200,"data":[]}

6.2.4 SPAN get /digital_span/span_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
span	int	–	Interface number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
			Reference /digital_span/span_set description

Request Example

Post:/controller/digital_span/span_get
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"span":1}

Response Example

{
"uri": "digital_span/span_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"span": 1,
"pcm_encoding": "alaw",
"timing": "local",
"hardhdlc": 0,
"bri_framing": "ccs",
"bri_coding": "ami",
"bri_dchan": 3,
"t1e1_lbo": 0,
"t1e1_framing": "ccs",
"t1e1_coding": "hdb3",
"t1e1_crc4": "no",
"t1e1_type": "pri",
"t1e1_dchan": 16
}
}

6.2.5 BRI configuration /digital_span/bri_set

• Can be effective condition: this SPAN has not been used
• Conditions for validity: Hardware SPAN is present
• Conditions for validity: type of span is digital-NT, digital-TE.
• DIGITAL exchange type.

a. national (National ISDN 2) b. ni1 (National ISDN 1) c. dms100 (Nortel DMS100) d. 4ess (AT&T 4ESS) e. 5ess (Lucent 5ESS) f. euroisdn (EuroISDN) g. qsig (Q.SIG)

• End-to-end dialling scheme:

a. from_channel (use CONNECTEDLINE(ton) value) b. unknown c. private d. local e. national f. international

• Send/Receive ISDN Display IE Options.

a. block (does not transmit display text data) b. name_initial (uses display text setup/connection message as group name) c. name_update (displays text notification/facility use in other messages to update name for COLP) d. name (combines initial and updated name options) e. text (passes any of the no text data during the call as an arbitrary display message) using text data as an arbitrary display message)

Client→Server Request

KEY	VAL	REQ	Default	Remark	renew
slotnum	int	Y	–	Slot number Format: not null, note limitations, invalid error report	240606
span	int	Y	–	Interface number Format: not null, note the restriction, invalid error report	240606
enable	string	N	no	Enable Format: yes/no	240606
				Primarily for dahdi_channels
nsf	string	N	none	ATT Operator Network Special Parameters Format: none sdn megacom tollfreemegacom accunet	240606
switchtype	string	N	euroisdn	DIGITAL exchange type Format: DIGITAL exchange type (refer to table description)	240606
service_message_support	string	N	yes	Enable message service support Format: yes/no	240606
facilityenable	string	N	no	Enable ISDN supplementary service option (e.g. CPE mode to get caller name from facility) Format: yes/no	240606
hold_disconnect_transfer	string	N	no	(PTMP-NT) Allow hold calls to become active when disconnected Format: yes/no	230321
layer1_presence	string	N	ignore	(PTMP) Layer1 mode line down on idle Format: required ignore	230321
layer2_persistence	string	N	unoccupied	(PTMP) Down on Layer2 mode line idle Format: empty (default) keep_up leave_down	230321
signalling	string	N	bri_cpe	Signalling type Format: bri_cpe bri_net bri_cpe_ptmp bri_net_ptmp	230321
pridialplan	string	N	unknown	Dialling plan Format: unknown private local national international	240606
prilocaldialplan	string	N	unknown	Local dialling plan (RARELY) Format: as above	240606
pricpndialplan	string	N	from_channel	End-to-end dialling plan Format: End-to-end dialling plan (refer to table description)	240606
internationalprefix	string	N	unoccupied	Number prefix International format: length 0-16	240606
nationalprefix	string	N	unoccupied	Number prefix Country Format: length 0-16	240606
localprefix	string	N	unoccupied	Number prefix Local Format: length 0-16	240606
privateprefix	string	N	unoccupied	Number Prefix Privacy Format: Length 0-16	240606
unknownprefix	string	N	unoccupied	Number prefix Unknown Format: length 0-16	240606
resetinterval	string	N	never	Unused B channel restart period Format: length 0-32 (in s) never (not switched on) Note: many not supported, e.g. Israel Bezeq/UK/China	240606
inband_on_setup_ack	string	N	no	Receive in-band audio at SETUP ACK (Q.SIG must be switched on if overlap is enabled) Format: yes/no	240606
inband_on_proceeding	string	N	no	Receive in-band audio while PROCEEDING Format: yes/no	240606
overlapdial	string	N	no	Stacked dialling Format: incoming outgoing no yes	240606
mcid_send	string	N	no	Send ISDN Malicious Caller ID request on SPAN Format: yes no	240606
force_restart_unavailable_chans	string	N	no	Automatic restart of unavailable channels Format: yes no	240606
hidecallerid	string	N	no	Hide Caller ID Format: yes no	240606
hidecalleridname	string	N	no	Hide caller name Format: yes no	240606
echocancel	string	N	no	Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no	240606
rxgain	string	N	0.0	Received energy gain Format: -12.0 to 12.0 in dB	240606
txgain	string	N	0.0	Send energy gain Format: -12.0 to 12.0 in dB	240606
group	string	N	4	Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63	240606
display_send	string	N	text	Send display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported	240606
display_receive	string	N	text	Receive display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported	240606
colp_send	string	N	update	Whether to send connect number information when sending connect Format: block connect update	240606
priindication	string	N	inband	PRI Busy and Congestion Indication Method Format: inband outofband	240606
qsigchannelmapping	string	N	physical	Q.SIG channel mapping method Format: physical logical Note: T1 force physical.	240606
cc_qsig_signaling_link_req	string	N	retain	Q.SIG caller signalling link Format: retain release do_not_care	240611
cc_qsig_signaling_link_rsp	string	N	retain	Q.SIG Responder Signalling Link Format: retention release	240611
datetime_send	string	N	no	NET side sends datetime to the CPE side Format: no date date_hh date_hhmm date_hhmmss Note: only NET side supports the	240606
				Mainly for AGI
callroute_profile	int	N	0	(AGI) Bind Call Routing Policy Format: policy number, non-nullable	240606

Server→Client Response

6.2.6 BRI Get /digital_span/bri_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
span	int	–	Interface number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
bri_tpl	string		template	230321
			Reference to /digital_span/bri_set description

6.2.7 PRI configuration /digital_span/pri_set

• Can be effective condition: this SPAN has not been used
• Conditions for validity: Hardware SPAN is present
• Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
• Can be effective condition: t1e1_type is pri
• DIGITAL exchange type.

a. national (National ISDN 2) b. ni1 (National ISDN 1) c. dms100 (Nortel DMS100) d. 4ess (AT&T 4ESS) e. 5ess (Lucent 5ESS) f. euroisdn (EuroISDN) g. qsig (Q.SIG)

• End-to-end dialling scheme:

a. from_channel (use CONNECTEDLINE(ton) value) b. unknown c. private d. local e. national f. international

• Send/Receive ISDN Display IE Options.

a. block (does not transmit display text data) b. name_initial (uses display text setup/connection message as group name) c. name_update (displays text notification/facility use in other messages to update name for COLP) d. name (combines initial and updated name options) e. text (passes any of the no text data during the call as an arbitrary display message) using text data as an arbitrary display message)

Client→Server Request

KEY	VAL	REQ	Default	Remark	renew
slotnum	int	Y	–	Slot number Format: not null, note limitations, invalid error report	240606
span	int	Y	–	Interface number Format: not null, note the restriction, invalid error report	240606
enable	string	N	no	Enable Format: yes/no	240606
				Primarily for dahdi_channels
nsf	string	N	none	ATT Operator Network Special Parameters Format: none sdn megacom tollfreemegacom accunet	240606
switchtype	string	N	euroisdn	DIGITAL exchange type Format: DIGITAL exchange type (refer to table description)	240606
service_message_support	string	N	yes	Enable message service support Format: yes/no	240606
facilityenable	string	N	no	Enable ISDN supplementary service option (e.g. CPE mode to get caller name from facility) Format: yes/no	240606
signalling	string	N	pri_cpe	Signalling type Format: pri_cpe pri_net	230321
pridialplan	string	N	unknown	Dialling plan Format: unknown private local national international	240606
prilocaldialplan	string	N	unknown	Local dialling plan (RARELY) Format: as above	240606
pricpndialplan	string	N	from_channel	End-to-end dialling plan Format: End-to-end dialling plan (refer to table description)	240606
internationalprefix	string	N	unoccupied	Number prefix International format: length 0-16	240606
nationalprefix	string	N	unoccupied	Number prefix Country Format: length 0-16	240606
localprefix	string	N	unoccupied	Number prefix Local Format: length 0-16	240606
privateprefix	string	N	unoccupied	Number Prefix Privacy Format: Length 0-16	240606
unknownprefix	string	N	unoccupied	Number prefix Unknown Format: length 0-16	240606
resetinterval	string	N	never	Unused B channel restart period Format: length 0-32 (in s) never (not switched on) Note: many not supported, e.g. Israel Bezeq/UK/China	240606
inband_on_setup_ack	string	N	no	Receive in-band audio at SETUP ACK (Q.SIG must be switched on if overlap is enabled) Format: yes/no	240606
inband_on_proceeding	string	N	no	Receive in-band audio while PROCEEDING Format: yes/no	240606
overlapdial	string	N	no	Stacked dialling Format: incoming outgoing no yes	240606
mcid_send	string	N	no	Send ISDN Malicious Caller ID request on SPAN Format: yes no	240606
force_restart_unavailable_chans	string	N	no	Automatic restart of unavailable channels Format: yes no	240606
hidecallerid	string	N	no	Hide Caller ID Format: yes no	240606
hidecalleridname	string	N	no	Hide caller name Format: yes no	240606
echocancel	string	N	no	Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no	240606
rxgain	string	N	0.0	Received energy gain Format: -12.0 to 12.0 in dB	240606
txgain	string	N	0.0	Send energy gain Format: -12.0 to 12.0 in dB	240606
group	string	N	4	Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63	240606
display_send	string	N	text	Send display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported	240606
display_receive	string	N	text	Receive display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported	240606
colp_send	string	N	update	Whether to send connect number information when sending connect Format: block connect update	240606
priindication	string	N	inband	PRI Busy and Congestion Indication Method Format: inband outofband	240606
qsigchannelmapping	string	N	physical	Q.SIG channel mapping method Format: physical logical Note: T1 force physical.	240606
cc_qsig_signaling_link_req	string	N	retain	QSIG Calling party retains signalling link after call completion Format: retain release do_not_care	240606
cc_qsig_signaling_link_rsp	string	N	retain	QSIG Responding party retains signalling after call completion Format: retain release	240606
datetime_send	string	N	no	NET side sends datetime to the CPE side Format: no date date_hh date_hhmm date_hhmmss Note: only NET side supports the	240606
				Mainly for AGI
callroute_profile	int	N	0	(AGI) Bind Call Routing Policy Format: policy number, non-nullable	240606

Server→Client Response

Request Example

Post:/controller/digital_span/pri_set
Host:172.16.6.79
Raw:{"slotnum":0,"span":1,"enable":"yes","pri_tpl":"iadpri","nsf":"none","switchtype":"euroisdn","service_message_support":"yes","facilityenable":"no","signalling":"pri_cpe","pridialplan":"unknown","prilocaldialplan":"unknown","pricpndialplan":"from_channel","internationalprefix":"","nationalprefix":"","localprefix":"","privateprefix":"","unknownprefix":"","resetinterval":"never","inband_on_setup_ack":"no","inband_on_proceeding":"no","overlapdial":"no","mcid_send":"no","force_restart_unavailable_chans":"no","hidecallerid":"no","hidecalleridname":"no","echocancel":"yes","rxgain":"0.0","txgain":"0.0","group":"4","display_send":"text","display_receive":"text","colp_send":"update","priindication":"inband","qsigchannelmapping":"physical","cc_qsig_signaling_link_req":"retain","cc_qsig_signaling_link_rsp":"retain","datetime_send":"no","callroute_profile":0,"token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital_span/pri_set","msg":"","code":200,"data":[]}

6.2.8 PRI Get /digital_span/pri_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
span	int	–	Interface number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
pri_tpl	string		template	230321
			Refer to /digital_span/pri_set description

Request Example

Post:/controller/digital_span/pri_get
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"span":1}

Response Example

{
"uri": "digital_span/pri_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"span": 1,
"enable": "yes",
"pri_tpl": "iadpri",
"nsf": "none",
"switchtype": "euroisdn",
"service_message_support": "yes",
"facilityenable": "no",
"signalling": "pri_cpe",
"pridialplan": "unknown",
"prilocaldialplan": "unknown",
"pricpndialplan": "from_channel",
"internationalprefix": "",
"nationalprefix": "",
"localprefix": "",
"privateprefix": "",
"unknownprefix": "",
"resetinterval": "never",
"inband_on_setup_ack": "no",
"inband_on_proceeding": "no",
"overlapdial": "no",
"mcid_send": "no",
"force_restart_unavailable_chans": "no",
"hidecallerid": "no",
"hidecalleridname": "no",
"echocancel": "yes",
"rxgain": "0.0",
"txgain": "0.0",
"group": "4",
"display_send": "text",
"display_receive": "text",
"colp_send": "update",
"priindication": "inband",
"qsigchannelmapping": "physical",
"cc_qsig_signaling_link_req": "retain",
"cc_qsig_signaling_link_rsp": "retain",
"datetime_send": "no",
"callroute_profile": 0,
"ec_ranges": [
"yes",
"no"
]
}
}

6.2.9 MFCR2 configuration /digital_span/mfcr2_set

• Can be effective condition: this SPAN has not been used
• Conditions for validity: Hardware SPAN is present
• Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
• Can be effective condition: t1e1_type is mfcr2

Client→Server Request

KEY	VAL	Default	Remark	renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230321
span	int	–	Interface number Format: not null, note the restriction, invalid error report	230321
enable	string	no	Enable Format: yes/no	230321
			Primarily for dahdi_channels
group	string	4	Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63	230321
mfcr2_variant	string	cn	The accompanying signalling follows the international norms Format: ar br cn cz co ec id itu mx ph ve	230321
mfcr2_get_ani_first	string	no	Obtain an ANI before obtaining DNIS (required by some telcos) Format: yes no	230321
mfcr2_max_ani	int	10	Maximum number of ANI bits requested Format: 0-64	230321
mfcr2_max_dnis	int	6	Maximum number of DNIS bits requested Format: 0-64	230321
mfcr2_category	string	n_s…	Inbound Subscription Class Format: (default) national_subscriber national_priority_subscriber international_subscriber international_priority_subscriber	230321
mfcr2_mfback_timeout	int	-1	MF timeout Unit (ms) Format: -1 (default) Less than 500 not recommended Range -1 to 10000	230321
mfcr2_metering_pulse_timeout	int	-1	Pulse timeout Unit (ms) Format: -1 (default) Less than 500 is not recommended Range -1 to 10000	230321
mfcr2_skip_category	string	no	Skip Request Calling Class and ANI Format: yes no	230321
mfcr2_double_answer	string	no	Supports double answer format: yes no	230321
echocancel	string	no	Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no	230613
rxgain	string	0.0	Received energy gain Format: -12.0 to 12.0 in dB	230321
txgain	string	0.0	Send energy gain Format: -12.0 to 12.0 in dB	230321
			Mainly for AGI
callroute_profile	int	0	(AGI) Bind Call Routing Policy Format: policy number, non-nullable	230321

Server→Client Response

Request Example

Post:/controller/digital_span/mfcr2_set
Host:172.16.6.79
Raw:{"slotnum":0,"span":1,"enable":"yes","mfcr2_tpl":"iadmfcr2","group":"4","mfcr2_variant":"cn","mfcr2_get_ani_first":"no","mfcr2_max_ani":10,"mfcr2_max_dnis":6,"mfcr2_category":"national_subscriber","mfcr2_mfback_timeout":-1,"mfcr2_metering_pulse_timeout":-1,"mfcr2_skip_category":"no","mfcr2_double_answer":"no","echocancel":"no","rxgain":"0.0","txgain":"0.0","callroute_profile":0,"token":"149bf241dfc62cbae1848a9a815b0f43"}

Response Example

{"uri":"digital_span/mfcr2_set","msg":"","code":200,"data":[]}

6.2.8 MFCR2 get /digital_span/mfcr2_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
span	int	–	Interface number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
mfcr2_tpl	string		template	230321
			Reference /digital_span/mfcr2_set description	230321

Request Example

Post:/controller/digital_span/mfcr2_get
Host:172.16.6.79
Raw:{"slotnum":"0","span":1,"token":"149bf241dfc62cbae1848a9a815b0f43"}

Response Example

{
"uri": "digital_span/mfcr2_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"span": 1,
"enable": "yes",
"mfcr2_tpl": "iadmfcr2",
"group": "4",
"mfcr2_variant": "cn",
"mfcr2_get_ani_first": "no",
"mfcr2_max_ani": 10,
"mfcr2_max_dnis": 6,
"mfcr2_category": "national_subscriber",
"mfcr2_mfback_timeout": -1,
"mfcr2_metering_pulse_timeout": -1,
"mfcr2_skip_category": "no",
"mfcr2_double_answer": "no",
"echocancel": "no",
"rxgain": "0.0",
"txgain": "0.0",
"callroute_profile": 0,
"ec_ranges": [
"yes",
"no"
]
}
}

6.3 Digital SS7

6.3.1 Full search /digital_ss7/ss7_list

• Note: The port configuration data read is the maximum supported data

Client→Server Request

KEY	VAL	Default	Remark	Renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230320
type	string	linkset	Type Format: linkset link all	230515
enable	string	unoccupied	Filter number is enable Format: yes/no/empty	230515

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
slotnum	int		Slot number Format: not null, note limitations, invalid error report	230320
linkset	array		Format: [{KV}…] , refer to digital_ss7/linkset_set description	230320
link	array		Format: [{KV}…] , refer to digital_ss7/link_set description	230320

Request Example

Post:/controller/digital_ss7/ss7_list
Host:172.16.6.79
Raw:{"slotnum":0,"type":"link","enable":"","token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{
"uri": "digital_ss7/ss7_list",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"linkset": [],
"link": [
{
"slotnum": 0,
"span": 1,
"enable": "yes",
"link_tpl": "iadss7",
"linkset": 1,
"schannel": 16,
"channels": "auto",
"firstcic": "1",
"echocancel": "no",
"echocan_train": 300,
"echocan_taps": "128",
"rx_gain": "0.0",
"tx_gain": "0.0"
},
{
"slotnum": 0,
"span": 2,
"enable": "yes",
"link_tpl": "iadss7",
"linkset": 1,
"schannel": 16,
"channels": "auto",
"firstcic": "32",
"echocancel": "no",
"echocan_train": 300,
"echocan_taps": "128",
"rx_gain": "0.0",
"tx_gain": "0.0"
}
]
}
}

6.3.2 Reservation /digital_ss7/xxx

6.3.3 LINKSET settings /digital_ss7/linkset_set

• LINKSETs are numbered from 1 and the total number available is the same as maxspans in sys_info/interface
• LINKSET doesn’t need to set enable or not, it will be enabled automatically only when it is associated with a link and the link is in effect.

Client→Server Request

KEY	VAL	Default	Remark	renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230313
linkset	int	–	LINKSET NUMBER Format: not null, note restrictions, invalid report error	230313
			Primarily for ss7_linkset
enable_st	string	no	Enable end-of-pulsing (not required if receiving address is complete) Format: yes no	230313
use_connect	string	no	Replying to an incoming call using CON Format: yes(CON) no(ACM/ANM)	230313
hunting_policy	string	even_mru	CIC search principle Format: even_mru (nearest even number) odd_lru seq_lth seq_htl	230313
subservice	string	auto	Sub-service Format: national international auto or dec/hex value, auto means get from first received SLTM Length 1-16	230313
variant	string	itu	Dot-code digit variant Format: itu (14 bits) china (24 bits)	230313
opc	string	0x6	Source code value Format: DEC/HEX value Length 1-32	230315
dpc	string	0x5	Destination code value Format: DEC/HEX value Length 1-32	230315
			Mainly for AGI
callroute_profile	int	0	(AGI) Bind Call Routing Policy Format: policy number, non-nullable	230313

Server→Client Response

Request Example

Post:/controller/digital_ss7/linkset_set
Host:172.16.6.79
Raw:{"slotnum":0,"linkset":1,"linkset_tpl":"iadss7","enable_st":"no","use_connect":"no","hunting_policy":"even_mru","subservice":"auto","variant":"china","opc":"0x5","dpc":"0x6","callroute_profile":0,"token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital_ss7/linkset_set","msg":"","code":200,"data":[]}

6.3.4 LINKSET get /digital_ss7/linkset_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
linkset	int	–	LINKSET NUMBER Format: not null, note restrictions, invalid report error

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
linkset_tpl	string	–	Template type: iadss7	230315
			Refer to /digital_ss7/linkset_set description

Request Example

Post:/controller/digital_ss7/linkset_get
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"linkset":1}

Response Example

{
"uri": "digital_ss7/linkset_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"linkset": 1,
"linkset_tpl": "iadss7",
"enable_st": "no",
"use_connect": "no",
"hunting_policy": "even_mru",
"subservice": "auto",
"variant": "itu",
"opc": "0x5",
"dpc": "0x6",
"callroute_profile": 0
}
}

6.3.5 LINK settings /digital_ss7/link_set

• Can be effective condition: this SPAN has not been used
• Conditions for validity: Hardware SPAN is present
• Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
• Can be effective condition: t1e1_type is ss7
• SPANs are numbered from 1 and the total number available is the same as maxspans in sys_info/interface

Client→Server Request

KEY	VAL	Default	Remark	renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230315
span	int	–	Interface number Format: not null, note the restriction, invalid error report	230315
enable	string	no	Enable Format: yes/no	230315
			Mainly used for ss7_link ss7_host
linkset	int	1	Binding LINKSET number Format.	230315
schannel	int	16	Signalling channel Format: 0 (indicates none) Range 1-31 (E1) 1-24 (T1/J1)	230315
channels	string	auto	Audio channels Format: auto (automatic) Empty (means none) Custom (length 0-32) auto: auto-generated Empty: no channels Custom: range 1-31 (E1) 1-24 (T1) e.g. 1-15,17-31	230316
firstcic	string	auto	CIC start bit Format: auto (automatic) Custom (length 0-6) Remarks: under the same linkset (e1) one port is 1, two ports 33, etc.	230316
echocancel	string	no	Echo cancellation switch Format: no 31speech (transmission median 3.1khz) allways	230315
echocan_train	int	300	Echo training period Format: Range 10-1000 in msec.	230315
echocan_taps	string	128	Echo cancellation TAPS (ms=taps/8) Format: 32 64 128 256	230315
rx_gain	string	0.0	Received energy gain Format: -12.0 to 12.0 in dB	230315
tx_gain	string	0.0	Send energy gain Format: -12.0 to 12.0 in dB	230315

Server→Client Response

Request Example

Post:/controller/digital_ss7/link_set
Host:172.16.6.79
Raw:{"slotnum":0,"span":1,"enable":"yes","link_tpl":"iadss7","linkset":2,"schannel":16,"channels":"auto","firstcic":"1","echocancel":"no","echocan_train":300,"echocan_taps":"128","rx_gain":"0.0","tx_gain":"0.0","token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital_ss7/link_set","msg":"","code":200,"data":[]}

6.3.6 LINK get /digital_ss7/link_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
span	int	–	Interface number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
link_tpl	string	–	Template type: iadss7	230315
			Refer to /digital_ss7/link_set description

Request Example

Post:/controller/digital_ss7/link_get
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"span":1}

Response Example

{
"uri": "digital_ss7/link_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"span": 1,
"enable": "yes",
"link_tpl": "iadss7",
"linkset": 2,
"schannel": 16,
"channels": "auto",
"firstcic": "1",
"echocancel": "no",
"echocan_train": 300,
"echocan_taps": "128",
"rx_gain": "0.0",
"tx_gain": "0.0"
}
}

6.4 VOIP Settings

6.4.1 Full search /digital_voip/voip_list

• Note: The port configuration data read is the maximum supported data

Client→Server Request

KEY	VAL	Default	Remark	Renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230309
type	string	trunk	Type Format: trunk all	230309
enable	string	unoccupied	Filter number is enable Format: yes/no/empty	230515

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
slotnum	int		Slot number Format: not null, note limitations, invalid error report	230309
trunk	array		TRUNK table Format: [{VTKV}…] Reference “VTKV”.	230309

VTKV	VAL	Default	Remark	Renew
			Refer to digital_trunk/trunk_get description	230309

Request Example

Post:/controller/digital_voip/voip_list
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"type":"trunk"}

Response Example

{
"uri": "digital_voip/voip_list",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"trunk": [
{
"slotnum": 0,
"trunk": 0,
"sip_listen_port": 30000,
"enable": "yes",
"sip_tpl": "iadtrunk",
"callerid_num": "10000",
"from_user": "",
"auth_username": "10000",
"auth_password": "10000",
"register": "yes",
"sip_server_profile": 0,
"voip_profile": 0,
"identify": "",
"callroute_profile": 0
}
]
}
}

6.4.2 VOIP actions /digital_voip/voip_action

Client→Server Request

KEY	VAL	Default	Remark	Renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230309
sipid	string	–	String SIP number Format: SIP number (trunk) No.	230309
cmd_register	int	0	Corresponding SIP registration action Format: 0 no action, 1 registration, 2 cancellation	230309

Server→Client Response

Request Example

Post:/controller/digital_voip/voip_action
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"sipid":0
,"cmd_register":1}

Response Example

{
"uri": "digital_voip/voip_action",
"msg": "",
"code": 200,
"data": []
}

6.4.3 TRUNK configuration /digital_voip/trunk_set

• sys_info/maxsiptrunk limits total amount that can be set

Client→Server Request

KEY	VAL	Default	Remark	renew
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report	230309
trunk	int	–	Relay number Format: non-null, note restrictions, invalid error message	230309
enable	string	no	Enable Format: yes/no	230309
			Mainly used for pjsip_accounts account
callerid_num	string	unoccupied	(SIP) Account name Format: 32-bit length	230309
from_user	string	unoccupied	(SIP) FROM mandatory account Format: 32-bit length, null (not mandatory)	230309
auth_username	string	unoccupied	(SIP) Authentication Account Format: 64-bit length, null	230309
auth_password	string	unoccupied	(SIP) Authentication Password Format: 64-bit length, empty	230309
register	string	yes	(SIP) Enable Registration Format: yes/no	230309
identify	string	unoccupied	(SIP) IP Direct Table Format: address[:0-65535] Note: comma separated, max 8 entries	230309
sip_server_profile	int	0	(SIP) Binding Service Policy Format: policy number, not nullable	230309
voip_profile	int	0	(SIP) Bind VOIP policy Format: policy number, non-nullable	230309
			Mainly for AGI
callroute_profile	int	0	(AGI) Bind Call Routing Policy Format: policy number, non-nullable	230309

Server→Client Response

Request Example

Post:/controller/digital_voip/trunk_set
Host:172.16.6.79
Raw:{"slotnum":0,"trunk":0,"sip_listen_port":30000,"enable":"yes","sip_tpl":"iadtrunk","callerid_num":"10000","from_user":"","auth_username":"10000","auth_password":"10000","register":"yes","sip_server_profile":0,"voip_profile":0,"identify":"","callroute_profile":0,"token":"b3f701474129ae36e03271fdfb1e6e54"}

Response Example

{"uri":"digital_voip/trunk_set","msg":"","code":200,"data":[]}

6.4.4 TRUNK get /digital_voip/trunk_get

Client→Server Request

KEY	VAL	Default	Remark
slotnum	int	–	Slot number Format: not null, note limitations, invalid error report
trunk	int	–	Relay number Format: non-null, note restrictions, invalid error message

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
sip_listen_port	int	–	(SIP) SIP signalling port	230309
sip_tpl	string	–	Template type: iadtrunk	230309
			Refer to /digital_voip/trunk_set for instructions.

Request Example

Post:/controller/digital_voip/trunk_get
Host:172.16.6.79
Raw:{"token":"b3f701474129ae36e03271fdfb1e6e54","slotnum":0,"trunk":0}

Response Example

{
"uri": "digital_voip/trunk_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"trunk": 0,
"sip_listen_port": 30000,
"enable": "yes",
"sip_tpl": "iadtrunk",
"callerid_num": "10000",
"from_user": "",
"auth_username": "10000",
"auth_password": "10000",
"register": "yes",
"sip_server_profile": 0,
"voip_profile": 0,
"identify": "",
"callroute_profile": 0
}
}

6.5 Digital Strategy

6.5.1 Service policy settings /digital_profile/sip_server_set

Client→Server Request

KEY	VAL	Default	Remark	Renew
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report	230309
name	string	unoccupied	Strategy name Format: 32 characters, nullable	230309
media_encryption	string	no	(RTP) Media enable SRTP format: sdes, no	230309
media_encryption_optimistic	string	no	(RTP) Media forced SRTP format: yes/no (auto)	230309
registration_expiration	int	3600	(SIP) Registration expiry time Format: 10-10000 units s	230309
registration_retry_interval	int	30	(SIP) Registration Retry Interval Format: 0-2147483647 Units s	240105
registration_max_retries	int	2147483647	(SIP) Number of registration retries Format: 0-2147483647	240105
auth_realm	string	*	(SIP) Authentication domain Format: *(peer-based), other, length 1-64	230309
aor_qualify_frequency	int	0	(SIP) Signalling Incoming Heartbeat Time Format: 0-10000 Unit s	230309
aor_qualify_timeout	int	60	(SIP) Signalling heartbeat timeout interval Format: 1-10000 units s	230309
aor_authenticate_qualify	string	no	(SIP) qualify authentication Format: yes/no	230309
sip_port_mode	string	udp	(SIP) Signalling port type Format: udp/tcp/tls	230309
primary_ipaddr	string	unoccupied	(SIP) Primary server address Format: (domain name and IP address standard) 63 characters, nullable	230309
primary_sip_port	int	5060	(SIP) Primary server signalling port Format: 100-65535	230309
second_ipaddr	string	unoccupied	(SIP) Backup server address Format: (domain name and IP address standard) 63 characters, nullable Primary is null second is automatically forced to null	230309
second_sip_port	int	5060	(SIP) Standby server signalling port Format: 100-65535	230309
from_domain	string	unoccupied	(SIP) Field to use the specified URI as the From Header Length: 0-64	230605
external_boundle	string	unoccupied	(SIP) Service Binding Interface (Basic, Logical, Virtual) Format: wan lan vpn1 alias1 alias2 null	240202
dns_mode	string	unoccupied	(SIP) DNS mode Format: null (automatically recognises A Record or IP) srv (dnssrv mode)	230309
outbound_proxy	string	unoccupied	(SIP) Outgoing Proxy Server Format: (address):(port) address is the address or domain name port is the port Length 0-63 null means no	230427
ice_support	string	no	(SIP) Enable STUN for this server Format: yes/no Remarks: You need to configure the STUN address and enable this parameter to make it valid.	230504
method	string	unoccupied	(SIP) TLS version Format: empty (tlsv1) tlsv1 tlsv1_1 tlsv1_2 sslv2 sslv3 ssv23	230508
tls_uri	int	0	(SIP) URI pattern for TLS Format: 0 (SIP) 1 (SIPS)	230508
tls_pem	int	-1	(SIP) Device certificate PEM selection for TLS Format: -1 (none) 0 (default) 1 2 3 4	230508
tls_calist	int	-1	(SIP) CA certificate chain selection for TLS Format: -1 (off) 0 (enabled)	230508
verify_server	string	no	(SIP) UAC behaviour for TLS verifies the validity of the peer’s certificate Format: yes/no	230508
require_client_cert	string	no	(SIP) UAS behaviour for TLS verifies the validity of the counterpart’s certificate Format: yes/no	230508

Server→Client Response

Request Example

Post:/controller/digital_profile/sip_server_set
Host:172.16.6.79
Raw:{"name":"sip_server","media_encryption":"no","media_encryption_optimistic":"no","registration_expiration":3600,"registration_retry_interval":30,"registration_max_retries":2147483647,"auth_realm":"*","aor_qualify_frequency":0,"aor_qualify_timeout":60,"aor_authenticate_qualify":"no","sip_port_mode":"udp","primary_ipaddr":"172.16.6.197","primary_sip_port":5060,"second_ipaddr":"","second_sip_port":5060,"from_domain":"","external_boundle":"","dns_mode":"","outbound_proxy":"","ice_support":"no","method":"","tls_uri":0,"tls_pem":-1,"tls_calist":-1,"verify_server":"no","require_client_cert":"no","profile":0,"token":"64d7beaeb91d0b4973196f6e41eef18a"}

Response Example

{"uri":"digital_profile/sip_server_set","msg":"","code":200,"data":[]}

6.5.2 Service Policy Get /digital_profile/sip_server_get

Client→Server Request

KEY	VAL	Default	Remark
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark
			Refer to /digital_profile/sip_server_get for instructions.

Request Example

Post:/controller/digital_profile/sip_server_get
Host:172.16.6.79
Raw:{"profile":0,"token":"64d7beaeb91d0b4973196f6e41eef18a"}

Response Example

{
"uri": "digital_profile/sip_server_get",
"msg": "",
"code": 200,
"data": {
"name": "sip_server",
"media_encryption": "no",
"media_encryption_optimistic": "no",
"registration_expiration": 3600,
"registration_retry_interval": 30,
"registration_max_retries": 2147483647,
"auth_realm": "*",
"aor_qualify_frequency": 0,
"aor_qualify_timeout": 60,
"aor_authenticate_qualify": "no",
"sip_port_mode": "udp",
"primary_ipaddr": "172.16.6.197",
"primary_sip_port": 5060,
"second_ipaddr": "",
"second_sip_port": 5060,
"from_domain": "",
"external_boundle": "",
"dns_mode": "",
"outbound_proxy": "",
"ice_support": "no",
"method": "",
"tls_uri": 0,
"tls_pem": -1,
"tls_calist": -1,
"verify_server": "no",
"require_client_cert": "no",
"profile": 0
}
}

6.5.3 VOIP policy settings /digital_profile/voip_set

Client→Server Request

KEY	VAL	Default	Remark	Renew
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report	230309
name	string	unoccupied	Strategy name Format: 32 characters, nullable	230309
allow_transfer	string	yes	(SIP) Allow REFER Format: yes/no	230309
sip_udptl	string	yes	(SIP) Enable UDPTL Format: yes/no	230309
sip_udptl_ec	string	redundancy	(SIP) UDPTL error correction Format: none/fec/redundancy	230309
dtmf_mode	string	rfc4733	(RTP) DTMF mode Format: rfc4733 (improves rfc2833), inband (in-band audio), info (signalling send), auto (prioritises rfc4733 over inband), auto_info (prioritises rfc4733 over info)	230309
use_ptime	string	no	(RTP) Use the requested coded packing duration Format: yes/no	230309
allow	string	ulaw, alaw, g729, g722	(RTP) Encoding Preferred Format: 1. Multiple options are comma-separated and sequential 2. Default models: ulaw, alaw, g729, g722 3. Optional models are retrieved from available_codecs in voip_get 4. The page removes the packet duration model configuration	240506
voice_frames_per_tx	int	2	Speech frame/TX format: selectable 1, 2, 3, 4, 6	240506
rtp_keepalive	int	0	(RTP) Media Revival Transmission Interval Format: 0-10000 units s	230309
rtp_timeout	int	0	(RTP) Inactive hang time in OFF HOLD Format: 0-10000 Unit s	230309
rtp_timeout_hold	int	0	(RTP) Inactive hang time in ON HOLD Format: 0-10000 Unit s	230309

Server→Client Response

Request Example

Post:/controller/digital_profile/voip_set
Host:172.16.6.79
Raw:{"name":"模板1","allow_transfer":"yes","sip_udptl":"yes","sip_udptl_ec":"redundancy","dtmf_mode":"rfc4733","use_ptime":"no","allow":"ulaw,alaw,g729,g722,g723,g726,ilbc,opus,amr,amrwb","rtp_keepalive":0,"rtp_timeout":0,"rtp_timeout_hold":0,"voice_frames_per_tx":2,"profile":0,"available_codecs":"ulaw,alaw,g729,g722,g723,g726,ilbc,opus,amr,amrwb","token":"64d7beaeb91d0b4973196f6e41eef18a"}

Response Example

{"uri":"digital_profile/voip_set","msg":"","code":200,"data":[]}

6.5.4 VOIP Policy Get /digital_profile/voip_get

Client→Server Request

KEY	VAL	Default	Remark	Renew
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report
available_codecs	string	–	Optional codecs model Example:ulaw,alaw,g729,g722,g723,g726	240506

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark
			References /digital_profile/voip_set

Request Example

Post:/controller/digital_profile/voip_get
Host:172.16.6.79
Raw:{"profile":0,"token":"64d7beaeb91d0b4973196f6e41eef18a"}

Response Example

{
"uri": "digital_profile/voip_get",
"msg": "",
"code": 200,
"data": {
"name": "\u6a21\u677f1",
"allow_transfer": "yes",
"sip_udptl": "yes",
"sip_udptl_ec": "redundancy",
"dtmf_mode": "rfc4733",
"use_ptime": "no",
"allow": "ulaw,alaw,g729,g722,g723,g726,ilbc,opus,amr,amrwb",
"rtp_keepalive": 0,
"rtp_timeout": 0,
"rtp_timeout_hold": 0,
"voice_frames_per_tx": 2,
"profile": 0,
"available_codecs": "ulaw,alaw,g729,g722,g723,g726,ilbc,opus,amr,amrwb"
}
}

6.5.5 Call Route Settings /digital_profile/callroute_set

• Note: This interface needs to be in effect after setting up.
• Note: the relationship between the matching conditions is “and”, matching conditions are in order.
• Note: Similar to the iptables design, once a match is made, the match is closed and no further matches are processed.

Client→Server Request

KEY	VAL	Default	Remark	Renew
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report	230309
name	string	unoccupied	Name Format: 32 characters, nullable	230309
match_tech	string	unoccupied	(AGI static) Failed spare line Format: null (disabled) DAHDI (contains bri/pri/mfcr2) SS7 PJSIP	230322
match_dest	string	unoccupied	(AGI static) Destination device Format: null (forbidden) Length 0-33 DAHDI channel: (chid), e.g. 33 DAHDI grouping: (g/G/r/R)(group), e.g. g4 SS7 format: (linksetid), e.g. 0 PJSIP format: (sipid), e.g. 1	230322
rules	array	–	(AGI static) Routing rule Format: [{CRRKV}…]. Reference “CRRKV” Empty array means empty Priority order, quantity limit sys_info/oem maxcallrouterule	230322

Routing Rules CRRKV	VAL	Default	Remark	Renew
rule_name	string	unoccupied	Rule name Format: 32 characters, nullable	240605
src_tech	string	unoccupied	Call source type Format: null (forbidden) DAHDI (contains bri/pri/mfcr2) SS7 PJSIP	240605
src	string	unoccupied	Call source device Format: null (ignore)/other (content), length 0-33	230309
match_callerprefix	string	unoccupied	Calling prefix match Format: empty (ignore)/any (any)/other (content), length 0-33	230309
match_calleeprefix	string	unoccupied	Called prefix match Format: null (ignore)/any (any)/other (content), length 0-33	230309
target	int	0	Routing Action Format: 0 deny 1 permit	230309
replace_callerdel_prefix	int	0	Calling Prefix deletion Format: 0-128	230309
replace_callerdel_suffix	int	0	Caller Suffix Deletion Format: 0-128	230309
replace_calleradd_prefix	string	unoccupied	Calling Prefix added Format: null (ignore)/other (content), length 0-33	230309
replace_calleradd_suffix	string	unoccupied	Caller Suffix added Format: null (ignore)/other (content), length 0-33	230309
replace_calleedel_prefix	int	0	Called Prefix Deletion Format: 0-64	230309
replace_calleedel_suffix	int	0	Called Suffix deletion Format: 0-64	230309
replace_calleeadd_prefix	string	unoccupied	Called Prefix added Format: null (ignore)/other (content), length 0-33	230309
replace_calleeadd_suffix	string	unoccupied	Called Suffix added Format: null (ignore)/other (content), length 0-33	230309
dest_tech	string	unoccupied	Destination device type Format: null (forbidden) DAHDI (includes bri/pri/mfcr2) SS7 PJSIP	230322
dest	string	unoccupied	Destination device Format: null (forbidden) Length 0-33 DAHDI channel: (chid), e.g. 33 DAHDI group: (g/G/r/R)(group), e.g. g4 SS7 format: (linksetid), e.g. 0 PJSIP format: (sipid), e.g. 1	230322

Server→Client Response

Request Example

Post:/controller/digital_profile/callroute_set
Host:172.16.6.79
Raw:{"profile":0,"name":"callroute","match_tech":"PORT","match_dest":"i","rules":[{"rule_name":"ip2tel","src_tech":"SIP","src":"0","dest":"i1","target":1,"dest_tech":"PORT","match_callerprefix":"any","match_calleeprefix":"any","replace_callerdel_prefix":0,"replace_callerdel_suffix":0,"replace_calleradd_prefix":"","replace_calleradd_suffix":"","replace_calleedel_prefix":0,"replace_calleedel_suffix":0,"replace_calleeadd_prefix":"","replace_calleeadd_suffix":""},{"rule_name":"ip2tel","src_tech":"","src":"","dest":"","target":1,"dest_tech":"","match_callerprefix":"any","match_calleeprefix":"any","replace_callerdel_prefix":0,"replace_callerdel_suffix":0,"replace_calleradd_prefix":"","replace_calleradd_suffix":"","replace_calleedel_prefix":0,"replace_calleedel_suffix":0,"replace_calleeadd_prefix":"","replace_calleeadd_suffix":""}],"token":"1887f0fed97cadc60143e1f7ed7d1e30"}

Response Example

{"uri":"digital_profile/callroute_set","msg":"","code":200,"data":[]}

6.5.6 Call Route Get /digital_profile/callroute_get

Client→Server Request

KEY	VAL	Default	Remark
profile	int	–	Strategy number Format: not null, note the restriction, invalid error report

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark
			Refer to /digital_profile/callroute_set for instructions.

Request Example

Post:/controller/digital_profile/callroute_get
Host:172.16.6.79
Raw:{"profile":0,"token":"1887f0fed97cadc60143e1f7ed7d1e30"}

Response Example

{
"uri": "digital_profile/callroute_get",
"msg": "",
"code": 200,
"data": {
"name": "callroute",
"match_tech": "PORT",
"match_dest": "i",
"rules": [
{
"rule_name": "ip2tel",
"src_tech": "SIP",
"src": "0",
"dest": "i1",
"target": 1,
"dest_tech": "PORT",
"match_callerprefix": "any",
"match_calleeprefix": "any",
"replace_callerdel_prefix": 0,
"replace_callerdel_suffix": 0,
"replace_calleradd_prefix": "",
"replace_calleradd_suffix": "",
"replace_calleedel_prefix": 0,
"replace_calleedel_suffix": 0,
"replace_calleeadd_prefix": "",
"replace_calleeadd_suffix": ""
}
],
"profile": 0
}
}

6.5 Numerical statistical tests

6.5.1 Signalling capture /digital_analysis/signaling_capture_do

• The results are obtained after the test is sent using the /digital_analysis/signaling_capture_result interface.
• Maximum packet size 2M

Client→Server Request

KEY	VAL	REQ	DEF	Remark	Renew
slotnum	int	Y	–	Slot number Format: not null, note limitations, invalid error report	240611
signaling_capture	int	N	2	Action Format: 1 Start 2 Stop	240611
type	string	N	pri	Type Format: pri ss7	240611

Server→Client Response

Request Example

Post:/controller/digital_analysis/signaling_capture_do
Host:172.16.6.79
Raw:{"slotnum":0,"signaling_capture":1,"type":"pri","token":"1887f0fed97cadc60143e1f7ed7d1e30"}

Response Example

{"uri":"digital_analysis/signaling_capture_do","msg":"","code":200,"data":[]}

6.5.2 Signalling capture results /digital_analysis/signaling_capture_result

If a record task has been issued, confirm that the data is ready by calling this interface several times to get the status.

Client→Server Request

Server→Client Response

DATA_SUBKEY	VAL	Default	Remark	Renew
status	int	0	Status Format: 0 None 1 In Progress 2 Finished Note: One-time reading is completed after completion.	240611
result	string	unoccupied	URL to download relative address	240611
slotnum	int	0	slot number	240611
signaling_capture_channel	string	unoccupied	Signalling channels for grabbing packets, multiple separated by commas	240611
type	string	pri	Catch type	240611

Request Example

Post:/controller/digital_analysis/signaling_capture_result
Host:172.16.6.79
Raw:{ "token": "bb3bcfc8771679d3b80288a7ade46238"}

Response Example

{
"uri": "digital_analysis/signaling_capture_result",
"msg": "",
"code": 200,
"data": {
"status": 1,
"result": "/download/signaling_capture_result.pcap",
"slotnum": 0,
"signaling_capture_channel": "16",
"type": "pri"
}
}