Adapter - NEC-SV9100-CTI
This page describes version 2.0.1 of the adapter.
Overview
This adapter provides basic call control of NEC's ASPIRE WX Plus/WX/UX or SV9100 platforms (the communication server).
The adapter connects directly to the CTI application port.
Limitations
- The adapter only supports Aspire WX Plus/WX/UX and SV9100 as the communication server.
- The communication server requires a 'CTI license' installed before a connection can be established.
- TLS is not supported for communication between adapter and the communication server.
- No other applications can be used while the adapter is in use as it occupies the only CTI port of the communication server.
- There may be cases when a command to the SV9100 responds without an error but the function may not have completed fully. For example, if one of the terminals has a network issue a call may not complete. Workflows that require complete verification may need to verify call events also.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| ctiIpAddress |
ASPIRE IP-Address |
True |
The IP Address of the communication server |
string |
|
|
|
15 |
1 |
| ctiServerPort |
CTI Server Port |
True |
The CTI port of the communication server. (System Default: 8181) |
integer |
|
|
|
5 |
1 |
| ctiKeepAlive |
Keep Alive interval (sec.) |
False |
Keep Alive interval (sec.) between CTI Adapter and the communication server. (Default: 30) |
integer |
30 |
|
|
5 |
1 |
| ctiReconnectInterval |
Reconnect interval (sec.) |
False |
Reconnect interval (sec.) to connect the communication server. (Default: 30) |
integer |
30 |
|
|
4 |
1 |
| ctiWaitResponseSpan |
Waiting time for response from the communication server (sec.) |
False |
Maximum time (sec.) to wait for response from the communication server. (Default: 6) |
integer |
6 |
|
|
3 |
1 |
| monitors |
Monitor extension numbers (comma-delimited) |
False |
Monitor extension numbers |
string |
|
|
|
10000 |
1 |
Commands
Start Station Monitor (startmonitorstation)
Start monitoring the specified station events.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| monitors |
Monitor station numbers |
Monitor station numbers (comma-delimited) |
True |
string |
Stop Station Monitor (stopmonitorstation)
Stop monitoring the specified station events.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| monitors |
Monitor station numbers |
Monitor station numbers (comma-delimited) |
True |
string |
Start Trunk Monitor (startmonitortrunk)
Start monitoring the specified trunk port events.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| monitors |
Monitor port numbers (0-4095) |
Monitor port numbers (comma-delimited) |
True |
string |
Stop Trunk Monitor (stopmonitortrunk)
Stop monitoring the specified trunk port events.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| monitors |
Monitor port numbers (0-4095) |
Monitor port numbers (comma-delimited) |
True |
string |
Get Station Status (getstationstatus)
Get station status.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station Number |
The station number to get the status. |
True |
string |
Response Properties
| Name |
Description |
Type |
| status |
Station status (IDLE, OFFERING, DIALTONE, DIALING, RINGBACK, BUSY, CONNECTED, CONFERENCED, HELD, PRIVATEHELD, SPECIALINFO, PROCEEDING, UNKNOWN, DISCONNECT, NONACTIVE) |
string |
Get Trunk Status (gettrunkstatus)
Get trunk status.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| portnumber |
Trunk Port Number (input 0-4094) |
The trunk port number to get the port status. |
True |
string |
Response Properties
| Name |
Description |
Type |
| status |
Trunk status (IDLE, OFFERING, DIALTONE, DIALING, RINGBACK, BUSY, CONNECTED, CONFERENCED, HELD, PRIVATEHELD, SPECIALINFO, PROCEEDING, UNKNOWN, DISCONNECT, NONACTIVE) |
string |
Make Call (makecall)
Make call command.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| callerstationnumber |
Caller station number |
The station number that will make a call. |
True |
string |
| dial |
Dial Number |
The number that will be dialed. |
True |
string |
| device |
Device Type |
Device type (Headset / Speaker) |
False |
string |
| key |
Key Number |
Key number (0-255) |
False |
string |
Answer Call (answercall)
Answer Call Command.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station Number |
The station number that will answer the call. |
True |
string |
| device |
Device Type |
Device type (Headset / Speaker) |
False |
string |
| key |
Key Number |
Key number (0-255) |
False |
string |
| partnerPortNumber |
Partner Port Number |
Partner port number |
False |
string |
Drop Call (dropcall)
Drop call command.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to drop call |
True |
string |
| key |
Key Number |
Key number (0-255) |
False |
string |
Set Call Forward All (setcallforwardall)
Set call forward all on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station Number |
The station number to set call forward all. |
True |
string |
| destnumber |
Destination Number |
The call forwarding destination. |
True |
string |
Cancel Call Forward All (cancelcallforwardall)
Cancel call forward all on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to cancel call forward all. |
True |
string |
Set Call Forward Busy (setcallforwardbusy)
Set call forward busy on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to set call forward busy. |
True |
string |
| destnumber |
Destination number |
The call forwarding destination. |
True |
string |
Cancel Call Forward Busy (cancelcallforwardbusy)
Cancel call forward busy on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to cancel call forward busy. |
True |
string |
Set Call Forward No Answer (setcallforwardnoanswer)
Set call forward no answer on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to set call forward no answer. |
True |
string |
| destnumber |
Destination number |
The call forwarding destination. |
True |
string |
Cancel Call Forward No Answer (cancelcallforwardnoanswer)
Cancel call forward no answer on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to cancel call forward no answer. |
True |
string |
Set Call Forward Dual Link (setcallforwardduallink)
Set to call forward dual link on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to set call forward dual link. |
True |
string |
| destnumber |
Destination number |
The call forwarding destination. |
True |
string |
Cancel Call Forward Dual Link (cancelcallforwardduallink)
Cancel to call forward dual link on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to cancel call forward dual link. |
True |
string |
Redirect Call (redirectcall)
Redirect a call.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number that will perform the redirect. |
True |
string |
| dial |
Dial Number |
The number that will be dialed. |
True |
string |
| key |
Key Number |
Key number |
False |
string |
| partnerPortNumber |
Partner Port Number |
Partner port number |
False |
string |
Get Call Forward All (getcallforwardall)
Get settings for call forward all on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to get settings for call forward all. |
True |
string |
Response Properties
| Name |
Description |
Type |
| Enabled |
Call forward setting is enabled or not. (True / False) |
string |
| extensionForwardAddress |
Setting of call forward all for internal call. Dial number should be returned. |
string |
| externalForwardAddress |
Setting of call forward all for external call. Dial number should be returned. |
string |
Get Call Forward Busy (getcallforwardbusy)
Get settings for call forward busy on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to get settings for call forward busy. |
True |
string |
Response Properties
| Name |
Description |
Type |
| Enabled |
Call forward setting is enabled or not. (True / False) |
string |
| extensionBusyForwardAddress |
Setting of call forward busy for internal call. Dial number should be returned. |
string |
| externalBusyForwardAddress |
Setting of call forward busy for external call. Dial number should be returned. |
string |
Get Call Forward NoAnswer (getcallforwardnoanswer)
Get settings for call forward no answer on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to get settings for call forward no answer. |
True |
string |
Response Properties
| Name |
Description |
Type |
| Enabled |
Call forward setting is enabled or not. (True / False) |
string |
| extensionUnansweredForwardAddress |
Setting of call forward no answer for internal call. Dial number should be returned. |
string |
| externalUnansweredForwardAddress |
Setting of call forward no answer for external call. Dial number should be returned. |
string |
Get Call Forward DualLink (getcallforwardduallink)
Get settings for call forward dual link on a station.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number to get settings for call forward dual link. |
True |
string |
Response Properties
| Name |
Description |
Type |
| Enabled |
Call forward setting is enabled or not. (True / False) |
string |
| extensionDuallinkForwardAddress |
Setting of call forward dual link for internal call. Dial number should be returned. |
string |
| externalDuallinkForwardAddress |
Setting of call forward dual link for external call. Dial number should be returned. |
string |
Transfer Call (transfercall)
Transfer call.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| stationnumber |
Station number |
The station number that will perform the transfer call. |
True |
string |
| dial |
Dial Strings |
Dial number |
True |
string |
| key |
Key Number |
Key number |
False |
string |
| devspecific |
Device Specific (SFT / ISDN) |
Device specific. input "SFT" or "ISDN" if a port specific is SFT or ISDN. |
False |
string |
Events
CTI Connected Event (cticonnectedevent)
This event is generated if the adapter is connected to the communication server.
No properties defined
CTI Disconnected Event (ctidisconnectedevent)
This event is generated if the adapter is disconnected from the communication server.
Event Properties
| Name |
Display |
Description |
Type |
| reason |
Reason for disconnection |
Reason for disconnection. |
string |
Incoming Call Event (incomingcallevent)
This event is generated if incoming call event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Ringing station number. |
string |
| callednumber |
Called Extension Number |
Called extension number. |
string |
| callernumber |
Caller Phone Number |
Caller phone number. |
string |
| key |
Key Number |
Key number |
string |
Connected Call Event (connectedcallevent)
This event is generated if connected call event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Stop offer station number. |
string |
| callednumber |
Called Extension Number |
Called extension number. |
string |
| callernumber |
Caller Phone Number |
Caller phone number. |
string |
| key |
Key Number |
Key number |
string |
Call Offer Stopped Event (stopoffercallevent)
This event is generated if call offer stopped event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Stop offer station number. |
string |
| callernumber |
Caller Extension Number |
Caller extension number. |
string |
| callednumber |
Called Phone Number |
Called phone number. |
string |
| key |
Key Number |
Key number |
string |
Disconnected Call Event (disconnectedcallevent)
This event is generated if disconnected call event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Disconnected station number. |
string |
| partnerphonenumber |
Partner Phone Number |
Partner phone number. |
string |
| key |
Key Number |
Key number |
string |
Held Call Event (heldcallevent)
This event is generated if held call event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Station number. |
string |
| partnerphonenumber |
Partner Phone Number |
Partner phone number. |
string |
| partnerportnumber |
Partner Port Number |
Partner port number. |
string |
| exclusivehold |
exclusive Hold |
Exclusive hold. |
boolean |
Ringback Event (ringbackevent)
This event is generated if ringback event is received.
Event Properties
| Name |
Display |
Description |
Type |
| stationnumber |
Station Number |
Station number. |
string |
| partnerphonenumber |
Partner Phone Number |
Partner phone number. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
|
2023-05-16 |
Categories