Adapter - NEC SV95 Commands
This page describes version 2.0.2 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:
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 |
|
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
MAC Address |
The MAC Address |
True |
string |
| ch |
The MAC Channel |
The MAC Channel. |
True |
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 |
MAC Address |
The MAC Address |
True |
string |
| ch |
The MAC Channel |
The MAC Channel. |
True |
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
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 |
Events
SV95 Connected (sv95Connected)
The connection to SV95 system has been established.
No properties defined
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 |
|
Categories