Adapter - NEC-SV-OAI

This page describes version 2.0.30 of the adapter.

Overview

This adapter provides basic call control of NEC's SV93/95 PBX platforms. The adapter connects directly to the PBX OAI application port.

Note

If your environment has a UCE-OW5000 platform, please use the UCE Adapter as it provides more features.

Note

If Tenant 0 is specified in the adapter configuration, a specific tenant value must be specified for commands that require a tenant value.  For single tenant systems, we recommend setting the Tenant value to 1.

Special Commands

This adapter implements two special commands that use multiple OAI facilities to connect one terminal to another. Both commands have support for optional Caller Identification (Caller-ID) information that can be used to identify the calling party. Some Central Offices do not allow Caller-ID values other than your assigned DID range. As a result, calls will fail. Please, contact your provider if you have any questions.

Dual Call

The dual call command has special built in logic that can make a call in parallel to a secondary terminal with an already ringing or connected primary terminal. The logic handles connecting the calling party to the first terminal that answers.

For Example:

1. Station (A) calls Station (B) -> Station (B) ringing
2. Dual Call ->
   • Called Station: Station (B) Extension Number
   • Dial TelephoneNumber: Terminal (C) Telephone Number
3. Terminal (C) starts ringing

(option 1)

• Terminal (C) answers
• Station (B) stops ringing
• Station (A) and Terminal (C) talking.

(option 2)

• Station (B) answers
• Terminal (C) stops ringing
• Station (A) and (B) talking

Remote Dial

The remote dial command also has special built in logic that can originate a call from an internal or external terminal and terminate to any dialed telephone number.

For Example:

1. Remote Dial ->
   • Source: Terminal (A) Telephone Number.
   • Destination: Terminal (B) Telephone Number.
2. Terminal (A) starts ringing
3. Terminal (A) answers
4. Terminal (B) starts ringing
5. Terminal (B) answer
6. Terminal (A) and (B) talking

Note

Both, Remote Dial and Dual Call use predictive dialing for call setup.   To cancel the predictive dial part of the operation, the command "Predictive Dial Cancel" may be ran with the original transaction identifier.  The cancel operation will fail if the Remote Dial or Dual Ring operation has completed or has already timed out.



Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
pbxSystemType	PBX System Type	True	The NEC PBX system type for this connection. (i.e. SV95, SV93)	string	SV95			15	1
pbxIpAddress	PBX IP-Address	True	The IP Address of the SV PBX System	string				15	1
oaiPort	PBX OAI Port	False	The PBX OAI port. (Default: 60030)	integer	60030			5	1
healthCheckFailCount	Health Check Failure Count	True	The number of times in a row that a health check from the PBX must fail before establishing a new connection (1-8).	integer	2			8	1
tenant	Tenant Number	False	The default tenant number to use when subscribing to facilities and running commands. If Tenant Number 0 or Empty is specified, a specific tenant number greater than 0 must be specified for commands that require a tenant value. Default: 0	integer	0			2	1
monitoredNumber	OAI Monitored Number	False	The OAI Monitored Number that will be used to perform call control.	string				1024	1



Commands

Station (Announce) (announceStation)

Connects a station terminal to an announcement.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to terminate to an announcement. The station must be connected to the monitored number.	True	string
messageKind	Message Kind	The kind of voice message. (1-58) The value is as per the Office Data of the PBX.	True	string
equipmentNumber	Equipment Number	The equipment number. (0-127) The value is as per the Office Data of the PBX.	True	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
answeredParty.terminalType	The answered party terminal type.	string
answeredParty.tenant	The answered party tenant number.	string
answeredParty.messageKind	The answered message kind.	string
answeredParty.equipmentNumber	The answered equipment number.	string

Trunk (Announce) (announceTrunk)

Connects a trunk terminal to an announcement as per PBX programming.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Tenant Number	The tenant number.	False	string
routeNumber	Route Number	The route number. The trunk route must be connected to the monitored number.	True	string
trunkNumber	Trunk Number	The trunk number. The trunk route must be connected to the monitored number.	True	string
messageKind	Message Kind	The kind of voice message. (1-58) The value is as per the Office Data of the PBX.	True	string
equipmentNumber	Equipment Number	The equipment number. (0-127) The value is as per the Office Data of the PBX.	True	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
answeredParty.terminalType	The answered party terminal type.	string
answeredParty.tenant	The answered party tenant number.	string
answeredParty.messageKind	The answered message kind.	string
answeredParty.equipmentNumber	The answered equipment number.	string

Answer Conference Call (ansConferenceCall)

Adds a third party to a call after answering Caller Number.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
addingStationNumber	Adding Station Number	The station number that will initiate the conference.	True	string
addingPhysicalStationNumber	Adding Physical Station Number	The physical station number that the adding station number appears on. A station number may appear on other physical station hardware.	False	string
addedStationNumber	Added Station Number	The station number or third party to add to the conference.	False	string
addedPhysicalStationNumber	Added Physical Station Number	The physical station number or third party that the added station number appears on. A station number may appear on other physical station hardware.	False	string
addedRouteNumber	Added Route Number	The route number or third party to add to the conference	False	string
addedTrunkNumber	Added Trunk Number	The trunk number or third party to add to the conference	False	string
answerCallOption	Answer Call Option	Whether exec answerCall command before transferCall command or not. If the station that will transfer is on hold, set this true.	False	string

Response Properties

Name	Description	Type
addingParty.terminalType	The adding party terminal type.	string
addingParty.tenant	The adding party tenant number.	string
addingParty.stationNumber	The adding party station number.	string
addingParty.stationType	The adding party station type.	string
addingParty.routeNumber	The adding party route number.	string
addingParty.trunkNumber	The adding party trunk number.	string
addingParty.trunkType	The adding party route/trunk type number.	string
addedParty.terminalType	The added party terminal type.	string
addedParty.tenant	The added party tenant number.	string
addedParty.stationNumber	The added party station number.	string
addedParty.stationType	The added party station type.	string
addedParty.routeNumber	The added party route number.	string
addedParty.trunkNumber	The added party trunk number.	string
addedParty.trunkType	The added party route/trunk type number.	string
isAnswered	0: not try to answer calling party. 1: tried to answer calling party and succeed. 2: tried to answer calling party and failed.	string

Answer Transfer Call (ansTransferCall)

Transfers a connected or ringing call to a station or outside line number after answering Caller Number.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number that will transfer connected call. (Controlling Party)	True	string
dialedNumber	Dialed Number	The number that will be dialed. Specify the station number or outside line number of destination.	True	string
callerName	Caller-ID Name	The caller-ID name to use for the calling party.	False	string
callerNumber	Caller-ID Number	The caller-ID number to use for the calling party	False	string
answerCallOption	Answer Call Option	Whether exec answerCall command before transferCall command or not. If the station that will transfer is on hold, set this true.	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string
heldParty.terminalType	The held party terminal type.	string
heldParty.tenant	The held party tenant number.	string
heldParty.stationNumber	The held party station number.	string
heldParty.stationType	The held party station type.	string
heldParty.routeNumber	The held party route number.	string
heldParty.trunkNumber	The held party trunk number.	string
heldParty.trunkType	The held party route/trunk type number.	string
isAnswered	0: not try to answer calling party. 1: tried to answer calling party and succeed. 2: tried to answer calling party and failed.	string

Answer Call (answerCall)

Answers an incoming call on a DTERM station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number that will answer the call.	True	string
physicalStationNumber	Physical Station Number	The physical station number that the station number appears on. A station number may appear on other physical station hardware. By default, the physical station number is the same as the station number.	False	string
zipTonePattern	Zip Tone Pattern (0, 1 or 2)	The zip tone pattern the user hears when the call is answered. (0-none, 1-zip tone pattern 1, 2-zip tone pattern 2)	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
answeredParty.terminalType	The answered party terminal type.	string
answeredParty.tenant	The answered party tenant number.	string
answeredParty.stationNumber	The answered party station number.	string
answeredParty.stationType	The answered party station type.	string
answeredParty.routeNumber	The answered party route number.	string
answeredParty.trunkNumber	The answered party trunk number.	string
answeredParty.trunkType	The answered party route/trunk type number.	string

Station (Break) (breakStationConnection)

Breaks an existing connection on a station and moves it to the monitored number.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to break to the monitored number.	True	string
answerType	Answer Type	1st Party Status Check before requesting of SCF(FN=10). (1 = no status check, 2 = must be hearing RBT, 3 = must be connected)	False	string
answerTypeToneConnection	Answer Type Tone Connection	1st Party tone connection after SCF(FN=10) complete. (0 = ring back tone, 1 = music, 2 = no tone)	False	string

Response Properties

Name	Description	Type
callId	The internal OAI Call Kind Identifier.	string
droppedParty.terminalType	The dropped type of terminal.	string
droppedParty.tenant	The dropped tenant number.	string
droppedParty.stationNumber	The dropped station number.	string
droppedParty.stationType	The type of station dropped.	string
droppedParty.routeNumber	The dropped route number.	string
droppedPartytrunkNumber	The dropped trunk number.	string
droppedParty.trunkType	The dropped route/trunk type number.	string
connectedParty.terminalType	The connected type of terminal.	string
connectedParty.tenant	The connected tenant number.	string
connectedParty.stationNumber	The connected station number.	string
connectedParty.stationType	The type of station connected.	string
connectedParty.routeNumber	The connected route number.	string
connectedPartytrunkNumber	The connected trunk number.	string
connectedParty.trunkType	The connected route/trunk type number.	string

Trunk (Break) (breakTrunkConnection)

Breaks an existing connection on a trunk and moves it to the monitored number.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
routeNumber	Route Number	The route number to break to the monitored number.	True	string
trunkNumber	Trunk Number	The trunk number to break to the monitored number.	True	string
answerType	Answer Type	1st Party Status Check before requesting of SCF(FN=10). (1 = no status check, 2 = must be hearing RBT, 3 = must be connected)	False	string
answerTypeToneConnection	Answer Type Tone Connection	1st Party tone connection after SCF(FN=10) complete. (0 = ring back tone, 1 = music, 2 = no tone	False	string

Response Properties

Name	Description	Type
callId	The internal OAI Call Kind Identifier.	string
droppedParty.terminalType	The dropped type of terminal.	string
droppedParty.tenant	The dropped tenant number.	string
droppedParty.stationNumber	The dropped station number.	string
droppedParty.stationType	The type of station dropped.	string
droppedParty.routeNumber	The dropped route number.	string
droppedPartytrunkNumber	The dropped trunk number.	string
droppedParty.trunkType	The dropped route/trunk type number.	string
connectedParty.terminalType	The connected type of terminal.	string
connectedParty.tenant	The connected tenant number.	string
connectedParty.stationNumber	The connected station number.	string
connectedParty.stationType	The type of station connected.	string
connectedParty.routeNumber	The connected route number.	string
connectedPartytrunkNumber	The connected trunk number.	string
connectedParty.trunkType	The connected route/trunk type number.	string

Call Forwarding (Monitor) (callForwardingMonitor)

Starts, stops Call Forwarding change events for a station and Gets the current Call Forwarding status.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve IP Registration information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring for Call Forwarding Change events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring for Call Forwarding Change events.	False	boolean
get	Get	Sends a request to the PBX to return the current Call Forwarding status for a station.	False	boolean

Response Properties

Name	Description	Type
cfa_destination	The incoming call forwarding all destination telephone number.	string
cfb_destination	The incoming call forwarding busy destination telephone number.	string
cfna_destination	The incoming call forwarding no answer destination telephone number.	string

Call Forward All (Cancel) (cancelCallForwardAll)

Cancels Call Forward All on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to cancel Call Forward All.	True	string

Call Forward Busy (Cancel) (cancelCallForwardBusy)

Cancels Call Forward Busy on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to cancel Call Forward Busy.	True	string

Call Forward No Answer (Cancel) (cancelCallForwardNoAnswer)

Cancels Call Forward No Answer on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to cancel Call Forward No Answer.	True	string

Conference (conferenceCall)

Adds a third party to a call

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
addingStationNumber	Adding Station Number	The station number that will initiate the conference.	True	string
addedStationNumber	Added Station Number	The station number or third party to add to the conference.	False	string
addedRouteNumber	Added Route Number	The route number or third party to add to the conference	False	string
addedTrunkNumber	Added Trunk Number	The trunk number or third party to add to the conference	False	string

Response Properties

Name	Description	Type
addingParty.terminalType	The adding party terminal type.	string
addingParty.tenant	The adding party tenant number.	string
addingParty.stationNumber	The adding party station number.	string
addingParty.stationType	The adding party station type.	string
addingParty.routeNumber	The adding party route number.	string
addingParty.trunkNumber	The adding party trunk number.	string
addingParty.trunkType	The adding party route/trunk type number.	string
addedParty.terminalType	The added party terminal type.	string
addedParty.tenant	The added party tenant number.	string
addedParty.stationNumber	The added party station number.	string
addedParty.stationType	The added party station type.	string
addedParty.routeNumber	The added party route number.	string
addedParty.trunkNumber	The added party trunk number.	string
addedParty.trunkType	The added party route/trunk type number.	string

Station (Dequeue) (dequeueStation)

Dequeue's a station connected to a monitored number and redirects it to a dialed number.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to dequeue.	True	string
dialedNumber	Dialed Number	The number that will be dialed after the dequeue is complete.	True	string
allowTransfer	Follow Forwarding	The dequeue operation will follow forwarding for the dialed party if set. (default: true)	False	string
callerName	Caller-ID Name	The caller-ID name to use for the calling party.	False	string
callerNumber	Caller-ID Number	The caller-ID number to use for the calling party	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string

Trunk (Dequeue) (dequeueTrunk)

Dequeue's a trunk connected to a monitored number and redirects it to a dialed number.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Tenant Number	The tenant number.	False	string
routeNumber	Route Number	The route number to dequeue.	True	string
trunkNumber	Trunk Number	The trunk number to dequeue.	True	string
dialedNumber	Dialed Number	The number that will be dialed after the dequeue is complete.	True	string
allowTransfer	Follow Forwarding	The dequeue operation will follow forwarding for the dialed party if set. (default: true)	False	string
callerName	Caller-ID Name	The caller-ID name to use for the calling party.	False	string
callerNumber	Caller-ID Number	The caller-ID number to use for the calling party	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string

Do Not Disturb (Cancel) (doNotDisturbCancel)

Cancel the Do Not Disturb (DND) setting for a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to set Do Not Disturb (DND).	True	string

Do Not Disturb (Set) (doNotDisturbSet)

Sets the Do Not Disturb (DND) setting for a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to set Do Not Disturb (DND).	True	string

Dual Call (dualCall)

Provides parallel calling to an internal or external dialed number that is actively ringing or connected to an internal station.

Request Properties

Name	Display	Description	Is Required	Type
calledStation	Called Station Number	The station number being actively called by another terminal (ringing or connected).	True	string
calledTenant	Called Station Tenant Number	The tenant number of the called station.	False	string
callerName	Caller-ID Name	The name to use for sending caller-ID information to the dual terminal.	False	string
callerNumber	Caller-ID Number	The number to use for sending caller-ID information to the dual terminal.	False	string
dialedNumber	Dialed Telephone Number	The telephone number that will be dialed in parallel with the called station.	True	string
transactionId	Transaction Identifier	The transaction Identifier for canceling or releasing the call. Cancellation must be performed from a separate workflow.	False	string
vmmaEarly	VMMA Minimum	Voice Mail Message Avoidance Min.: Dual call will fail if answered before VMMA Minimum. Otherwise, the call will be connected. (default 3 seconds).	False	string
vmmaLate	VMMA Maximum	Voice Mail Message Avoidance Max.: Dual call will fail if answered after VMMA Max. Otherwise, the call will be connected. (default 32 seconds)	False	string

Response Properties

Name	Description	Type
transactionId	The transaction Identifier to use for canceling or releasing the call	string
answerTime	The time in seconds for the call to be answered.	string
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
answeredParty.terminalType	The answered party terminal type.	string
answeredParty.tenant	The answered party tenant number.	string
answeredParty.stationNumber	The answered party station number.	string
answeredParty.stationType	The answered party station type.	string
answeredParty.routeNumber	The answered party route number.	string
answeredParty.trunkNumber	The answered party trunk number.	string
answeredParty.trunkType	The answered party route/trunk type number.	string

E911-Location (Monitor) (e911RegistrationMonitor)

Starts or Stops E911-Location Registration change events for an IP type station or Gets the current IP address.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve E911-Location Registration information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring for E911-Location Registration events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring for E911-Location Registration events.	False	boolean
get	Get	Sends a request to the PBX to return the current E911-Location Registration status for a station.	False	boolean

Response Properties

Name	Description	Type
ipAddress	The IP Address of the station.	string
macAddress	The MAC Address of the station.	string
locationIndex	The Location Index of the station.	string
locationNumber	The Location Number of the station.	string

Guest Name (Clear) (guestNameClear)

Clears the Guest Name for a hotel station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The station number assigned with the guest name	True	string

Guest Name (Set) (guestNameSet)

Sets the Guest Name for a hotel station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The station number assigned with the guest name	True	string
name	Guest Name	The guest name to assign to the hotel station number. (16 Chars max.)	True	string

Hold Call (holdCall)

Places the party or terminal connected the station on hold.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number that will perform the hold.	True	string
physicalStationNumber	Physical Station Number	The physical station number that the station number appears on. A station number may appear on other physical station hardware. By default, the physical station number is the same as the station number.	False	string

Response Properties

Name	Description	Type
heldParty.terminalType	The held party terminal type.	string
heldParty.tenant	The held party tenant number.	string
heldParty.stationNumber	The held party station number.	string
heldParty.stationType	The held party station type.	string
heldParty.routeNumber	The held party route number.	string
heldParty.trunkNumber	The held party trunk number.	string
heldParty.trunkType	The held party route/trunk type number.	string

Hotel CheckIn/Out (hotelCheckInOut)

Set CheckIn or CheckOut state for a hotel guest station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The guest station number.	True	string
checkInOut	CheckIn? (true/false)	Set to true for checked-in and set to false for checked-out.	True	string

Hotel Cleaning Status (Set) (hotelCleaningStatus)

Sets the hotel room cleaning status for a guest room.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The guest room station number to set.	True	string
cleaningStatus	Cleaning Status	The guest room cleaning status value. 1 = Begin Cleaning, 2 = End Cleaning, 3 = Vacant, 4 = Repair, 8 = End Repair Special, 9 = Start Repair Special	True	string

Hotel Room Reserve (hotelReserveRoom)

Reserve a room for a hotel guest station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The guest station number.	True	string
reserve	Reserve? (true/false)	Set to true to reserve and set to false to cancel.	True	string

Hotel Group No. Add (hotelGroupNumberAdd)

Adds a hotel guest station to a group.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The guest station number.	True	string
groupNumber	Group Number	The group number to change the station to. (1~999999)	True	string

Hotel Group No. Remove (hotelGroupNumberRemove)

Removes a hotel guest station from a group.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Guest Station Number	The guest station number.	True	string
groupNumber	Group Number	The group to remove the station from. (1~999999)	True	string

VIP Wakeup (Monitor) (hotelVipWakeupMonitor)

Starts or Stops Guest Room VIP Wakeup status change events for a hotel station or Gets the current VIP Wakeup information.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve VIP Wakeup Information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring a hotel station for VIP Wakeup events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring a hotel station for VIP Wakeup events.	False	boolean
get	Get State	Sends a request to the PBX to return the current VIP Wakeup status for a hotel station.	False	boolean

Hotel Wakeup (Cancel) (hotelWakeupCancel)

Cancels wakeup time for a hotel station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The hotel station number to cancel wakeup.	True	string
firstWakeupTime	First Wakeup	Cancel the first wakeup time setting.	False	boolean
secondWakeupTime	Second Wakeup	Cancel the second wakeup time setting.	False	boolean
groupWakeupTime	Group Wakeup	Cancel the group wakeup time setting.	False	boolean

Hotel Wakeup (Set) (hotelWakeupSet)

Configures wakeup time for a hotel station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The hotel station number to assign wakeup.	True	string
firstWakeupTime	First Wakeup Time	The time of day a first wakeup is to be executed. HH:mm	False	string
secondWakeupTime	Second Wakeup Time	The time of day a second wakeup is to be executed. HH:mm	False	string
groupWakeupTime	Group Wakeup Time	The time of day a group wakeup is to be executed. HH:mm	False	string

IP-Register (Monitor) (ipRegistrationMonitor)

Starts or Stops IP-Registration change events for an IP type station or Gets the current IP address.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve IP Registration information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring for IP Registration events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring for IP Registration events.	False	boolean
get	Get	Sends a request to the PBX to return the current IP Registration status for a station.	False	boolean

Response Properties

Name	Description	Type
ipAddress	The IP Address of the station.	string

Make Call (makeCall)

Makes a call from a DTERM type station using a dialed number.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Calling Tenant Number	The calling tenant number.	False	string
stationNumber	Calling Station Number	The calling station number to make a call from.	True	string
dialedNumber	Dialed Number	The number that will be dialed.	True	string
callerName	Caller-ID Name	The name to use for sending caller-ID information.	False	string
callerNumber	Caller-ID Number	The number to use for sending caller-ID information.	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string

Message Waiting (Monitor) (messageWaitingMonitor)

Starts or Stops Message Waiting change events for station or Gets the current message waiting status.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve message waiting information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring for message waiting events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring for message waiting events.	False	boolean
get	Get State	Sends a request to the PBX to return the current message waiting state for a station.	False	boolean

Response Properties

Name	Description	Type
messageIndication	The message waiting indicator that changed.	string

PBX Date Time (Get) (pbxDateTime)

Gets the current date and time setting on the PBX.

Response Properties

Name	Description	Type
longdateTime	The current PBX date and time formatted string.	string
dayOfWeek	The current day of the week.	string
year	The current year.	string
month	The current month.	string
day	The current day.	string
hour	The current hour.	string
minute	The current minute.	string
second	The current second.	string

Predictive Dial Call (predictiveDial)

Originates a call from an OAI monitored number to a destination telephone number.

Request Properties

Name	Display	Description	Is Required	Type
transactionId	Transaction Identifier	The transaction Identifier for canceling or releasing the call. Cancellation must be performed from a separate work-flow.	False	string
dialedNumber	Dialed Number	The number that will be dialed.	True	string
answerWait	Answer Wait	Waits for the dialed number terminal to answer the call before returning the results. (True/False default=True)	False	string
callerName	Caller-ID Name	The name to use for sending caller-ID information.	False	string
callerNumber	Caller-ID Number	The number to use for sending caller-ID information.	False	string
noanswerTimeoutFactor	No Answer Timeout (factor)	The dialed terminal is released if not answered within the timeout period. 1=(8s), 2=(16s) 3=(24s) 4=(32s) 5=(40s) Default=5	False	string
enableTimeoutEvent	Notify predictiveDialTimeout event	Raise predictiveDialTimeout event if the dialed party does not respond during timer. This property only enabled that answerWait property is false.	False	boolean

Response Properties

Name	Description	Type
callId	The internal OAI Call Kind Identifier.	string
transactionId	The transaction Identifier for canceling an Answer Wait operation.	string
dialedParty.terminalType	The dialed party terminal type.	string
dialedParty.tenant	The dialed party tenant number.	string
dialedParty.stationNumber	The dialed party station number.	string
dialedParty.stationType	The dialed party station type.	string
dialedParty.routeNumber	The dialed party route number.	string
dialedParty.trunkNumber	The dialed party trunk number.	string
dialedParty.trunkType	The dialed party route/trunk type number.	string

Predictive Dial Cancel (predictiveDialCancel)

Cancels a predictive dial call operation in progress.

Request Properties

Name	Display	Description	Is Required	Type
transactionId	Transaction Identifier UUID	The transaction Identifier UUID required for canceling the operation	True	string

Station (Release) (releaseStation)

Releases a station connection if the station is connected to another terminal.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to release.	True	string
connectBusyTone	Connect To Busy Tone	Connect Station to Busy Tone instead of releasing the connection.	False	boolean
droppedStation	Dropped Station Number	The known connected station number that will be dropped. Otherwise, any terminal connected will be dropped.	False	string
droppedRouteTrunk	Dropped RT/TK Number	The known connected route and trunk number that will be dropped. Otherwise, any terminal connected will be dropped.	False	string

Response Properties

Name	Description	Type
droppedParty.terminalType	The dropped type of terminal.	string
droppedParty.tenant	The dropped tenant number.	string
droppedParty.stationNumber	The dropped station number.	string
droppedParty.stationType	The type of station dropped.	string
droppedParty.routeNumber	The dropped route number (RT).	string
droppedPartytrunkNumber	The dropped trunk number (TK).	string
droppedParty.trunkType	The dropped RT/TK type number.	string

Trunk (Release) (releaseTrunk)

Releases the currently connected call for a trunk.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
routeNumber	Route Number	The route number (RT) to release.	True	string
trunkNumber	Trunk Number	The trunk number (TK) to release.	True	string
connectBusyTone	Connect To Busy Tone	Connect RT/TK to Busy Tone instead of releasing the connection.	False	boolean
droppedStation	Dropped Station Number	The known connected station number that will be dropped. Otherwise, any terminal connected will be dropped.	False	string
droppedRouteTrunk	Dropped RT/TK Number	The known connected route and trunk number that will be dropped. Otherwise, any terminal connected will be dropped.	False	string

Response Properties

Name	Description	Type
droppedParty.terminalType	The dropped type of terminal.	string
droppedParty.tenant	The dropped tenant number.	string
droppedParty.stationNumber	The dropped station number.	string
droppedParty.stationType	The type of station dropped.	string
droppedParty.routeNumber	The dropped route number.	string
droppedPartytrunkNumber	The dropped trunk number.	string
droppedParty.trunkType	The dropped route/trunk type number.	string

Remote Dial (remoteDial)

Makes a call from a remote party to any dialed number

Request Properties

Name	Display	Description	Is Required	Type
transactionId	Transaction Identifier	The transaction Identifier for canceling or releasing the call. Cancellation must be performed from a separate work-flow.	False	string
sourceNumber	Source Telephone Number	The source party's dialable telephone number (including access codes).	True	string
sourceCallerName	Source Caller-ID Name	The name to use for sending caller-ID information to the destination.	False	string
sourceCallerNumber	Source Caller-ID Number	The number to use for sending caller-ID information to the destination.	False	string
destinationNumber	Destination Telephone Number	The dialable telephone number used by the source to originate the call (including access codes).	True	string
destinationCallerName	Destination Caller-ID Name	The name to use for sending caller-ID information to the source.	False	string
destinationCallerNumber	Destination Caller-ID Number	The number to use for sending caller-ID information to the source.	False	string
noMonitorTerminal	No Monitor for Terminal	Do not monitor Outbound Terminal.	False	boolean
earlyAnswerTimeout	Early Answered Timeout	The dialed terminal is released if answered within the timeout second. 1-3 Default=3	False	string

Response Properties

Name	Description	Type
transactionId	The transaction Identifier to use for canceling or releasing the call	string
sourceAnswerTime	The time in seconds for the source party to answer the call.	string
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The answered party terminal type.	string
calledParty.tenant	The answered party tenant number.	string
calledParty.stationNumber	The answered party station number.	string
calledParty.stationType	The answered party station type.	string
calledParty.routeNumber	The answered party route number.	string
calledParty.trunkNumber	The answered party trunk number.	string
calledParty.trunkType	The answered party route/trunk type number.	string
oaiError	OAI Error	string
oaiOperation	OAI Operation for OAI Error. Value is 'PredictiveDial' or 'DequeueCall'	string

Ring Call (ringCall)

Makes a call from an station by first ringing the station, waiting for an answer and then dialing a specified number. Allows Analog station types to originate a call.

Request Properties

Name	Display	Description	Is Required	Type
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The ANALOG station number to make a call from.	True	string
dialedNumber	Dialed Number	The number that will be dialed by the station.	True	string
followForwarding	Follow Forwarding	Allows the call to follow forwarding.	False	boolean
checkDialRestriction	Check Dial Restriction	Checks dial restriction tables in PBX before attempting call.	False	boolean

Response Properties

Name	Description	Type
ringingParty.terminalType	The ringing party terminal type.	string
ringingParty.tenant	The ringing party tenant number.	string
ringingParty.stationNumber	The ringing party station number.	string
ringingParty.stationType	The ringing party station type.	string
ringingParty.routeNumber	The ringing party route number.	string
ringingParty.trunkNumber	The ringing party trunk number.	string
ringingParty.trunkType	The ringing party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string

Guest Room (Monitor) (roomStatusMonitor)

Starts or Stops Guest Room Status change events for a hotel station or Gets the current Guest Room information.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to monitor or retrieve room status information.	True	string
start	Start Monitor	Sends a request to the PBX to start monitoring a hotel station for room status events.	False	boolean
stop	Stop Monitor	Sends a request to the PBX to stop monitoring a hotel station for room status events.	False	boolean
get	Get State	Sends a request to the PBX to return the current room status for a hotel station.	False	boolean

Response Properties

Name	Description	Type
checkedIn	True, if the guest is checked in.	string
departureDay	True, if the guest departure day is today.	string
doNotDisturb	True, if the guest has Do Not Disturb set.	string
roomCutoff	True, if the guest has Room Cutoff set.	string
wakeupSet	True, if wakeup is set.	string
wakeupWasCleared	True, if wakeup was cleared.	string
wakeupSetByGuest	True, if the guest set wakeup.	string
firstWakeupTime	The first wakeup time setting.	string
firstWakeupResult	The result of the first wakeup.	string
secondWakeupTime	The Second wakeup time setting.	string
secondWakeupResult	The result of the second wakeup. Note: If the VIP feature (Attendant) is enabled, the second wakeup results will not be shown. See Hotel Programming Manual for more details.	string
groupNumber	The group number.	string
groupWakeupTime	The group wakeup time setting.	string
groupWakeupResult	The result of the Group wakeup.	string
groupWakeupKind	The kind of the Group wakeup.	string
roomReserved	True, if the guest room is reserved.	string
keyInRack	True, if the key to the room is hanging in the rack.	string
vip	True, if the guest is a very important person (VIP).	string
messageWaitingFrontDesk	True, if there is a message waiting for the guest at the front desk.	string
messageWaitingImage	True, if there is a message waiting for the guest at the imaging machine.	string
messageWaitingAttendant	True, if there is a message waiting for the guest with the attendant.	string
messageWaitingVoiceMail	True, if there is a voice mail message waiting for the guest.	string
language	The language setting for the guest room.	string
cleanStatus	The guest room cleaning status.	string
isAdmin	True, if the guest room station is an administrator type.	string
isGuest	True, if the guest room station is a guest type.	string
guestRoomClass	The guest room class value.	string
guestName	The guest name assigned to the station.	string
optionDataA	The Option Data A value.	string
optionDataB	The Option Data B value.	string
message1	True, if message 1 value is set.	string
message2	True, if message 2 value is set.	string
message3	True, if message 3 value is set.	string
message4	True, if message 4 value is set.	string

Call Forward All (Set) (setCallForwardAll)

Sets Call Forward All on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to set call forward all.	True	string
destinationNumber	Destination Number	The Call Forwarding destination.	True	string

Call Forward Busy (Set) (setCallForwardBusy)

Sets Call Forward Busy on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to set call forward busy.	True	string
destinationNumber	Destination Number	The Call Forwarding destination.	True	string

Call Forward No Answer (Set) (setCallForwardNoAnswer)

Sets Call Forward No Answer on a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station to set call forward no answer.	True	string
destinationNumber	Destination Number	The Call Forwarding destination.	True	string

Delay (sleep)

Provides a delay function to allow the PBX system to update memory.

Request Properties

Name	Display	Description	Is Required	Type
sleepTime	Delay Time (ms)	The delay time in milliseconds. (0-1000 ms)	True	string

Station (Query) (statusMonitorStationQuery)

Returns the connection state for a station.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number to query.	True	string

Response Properties

Name	Description	Type
stationStatus	The connection status of the Station Number.	string
connected.terminalType	The type of terminal connected to the station.	string
connected.tenant	The tenant number for the connected terminal.	string
connected.stationNumber	The connected station number.	string
connected.stationType	The type of station connected.	string
connected.routeNumber	The connected route number.	string
connected.trunkNumber	The connected trunk number.	string
connected.trunkType	The connected route/trunk type number.	string

Station (Monitor) (statusMonitorStationStart)

Monitors a station for events.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number of the station to monitor.	False	string
stationNumber	Station Number	The station number to monitor.	True	string

Response Properties

Name	Description	Type
stationMonitorFailure	Array of station monitor failure(s) that occurred.	array
stationMonitorFailure.error	The station monitor failure code received from PBX.	string
stationMonitorFailure.station	The station that failed.	string
stationMonitorFailure.function	The monitor function type code that failed.	string

Query Trunk (statusMonitorTrunkQuery)

Returns the connection state for a trunk.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
routeNumber	Route Number	The route number to query.	True	string
trunkNumber	trunk Number	The trunk number to query.	True	string

Response Properties

Name	Description	Type
trunkStatus	The connection status of the trunk Number.	string
connected.terminalType	The type of terminal connected to the station.	string
connected.tenant	The tenant number for the connected terminal.	string
connected.stationNumber	The connected station number.	string
connected.stationType	The type of station connected.	string
connected.routeNumber	The connected route number.	string
connected.trunkNumber	The connected trunk number.	string
connected.trunkType	The connected route/trunk type number.	string

Trunk (Monitor) (statusMonitorTrunkStart)

Monitors a trunk for events.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number of the route to monitor.	False	string
routeNumber	Route Number	The route number to monitor.	True	string
trunkStartNumber	Starting Trunk Number	The starting trunk number to monitor.	True	string
trunkEndNumber	Ending Trunk Number	The ending trunk number to monitor.	False	string

Response Properties

Name	Description	Type
trunkMonitorFailure	Array of trunk monitor failure(s) that occurred.	array
trunkMonitorFailure.error	The trunk monitor failure code received from PBX.	string
trunkMonitorFailure.routeTrunk	The route and trunk that failed.	string
trunkMonitorFailure.function	The monitor function type code that failed.	string

DTERM-Send Message (terminalControl)

Sends a message to a DTERM station's LCD screen

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The DTERM station to send a message to.	True	string
message	Message Text (16 character limit)	The message text to send to the DTERM station terminal.	True	string
alertTone	Alert Tone	Sounds an alert tone with the message on the DTERM.	False	boolean

Transfer Call (transferCall)

Transfers a connected or ringing call to a station or outside line number.

Request Properties

Name	Display	Description	Is Required	Type
tenantNumber	Tenant Number	The tenant number.	False	string
stationNumber	Station Number	The station number that will transfer connected call. (Controlling Party)	True	string
dialedNumber	Dialed Number	The number that will be dialed. Specify the station number or outside line number of destination.	True	string
callerName	Caller-ID Name	The caller-ID name to use for the calling party.	False	string
callerNumber	Caller-ID Number	The caller-ID number to use for the calling party	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string
heldParty.terminalType	The held party terminal type.	string
heldParty.tenant	The held party tenant number.	string
heldParty.stationNumber	The held party station number.	string
heldParty.stationType	The held party station type.	string
heldParty.routeNumber	The held party route number.	string
heldParty.trunkNumber	The held party trunk number.	string
heldParty.trunkType	The held party route/trunk type number.	string

Transfer Remote Call (transferRemoteCall)

Execute statusMonitorStationQuery/statusMonitorTrunkQuery -> breakStationConnection/breakTrunkConnection -> dequeueStation/dequeueTrunk to transfer the call to another extension.

Request Properties

Name	Display	Description	Is Required	Type
transferSourceType	Transfer Source Type	Transfer source type. (1: Station, 2:Trunk)	True	string
transferDestinationType	Transfer Destination Type	Transfer destination type. (1: Station, 2:Trunk)	True	string
queryStationNumber	Station Number to query	The station number to query.	False	string
stationNumber	Station Number	The station number.	False	string
routeNumber	Route Number	The route number.	False	string
trunkNumber	trunk Number	The trunk number.	False	string
answerType	Answer Type	1st Party Status Check before requesting of SCF(FN=10).(0: Undefined, 1: No Check, 2: Hearing Ringback Tone, 3: Connected)	False	string
answerTypeToneConnection	Answer Type(Tone Connection)	1st Party Tone Connection for SCF(FN=10).(0: Ringback Tone, 1: Music On Hold, 2: No Tone)	False	string
callId	Call Identifier	The internal OAI Call Kind Identifier.	False	string
dialedNumber	Dialed Number	The number that will be dialed after the dequeue is complete. Specify the station number or outside line number of the transferring destination.	True	string
allowTransfer	Follow Forwarding	The dequeue operation will follow forwarding for the dialed party if set. (default: true)	False	string
callerName	Caller-ID Name	The caller-ID name to use for the calling party.	False	string
callerNumber	Caller-ID Number	The caller-ID number to use for the calling party	False	string
recoveryDialedNumber	Recovery Dialed Number	Specifies the transfer source number to return if the dequeue fails.	False	string
waitCallIdTimeout	Wait CallId Timeout	For SV93, set the timeout second from the successful breakConnection to the receipt of callId. 1-10 Default=1	False	string

Response Properties

Name	Description	Type
callingParty.terminalType	The calling party terminal type.	string
callingParty.tenant	The calling party tenant number.	string
callingParty.stationNumber	The calling party station number.	string
callingParty.stationType	The calling party station type.	string
callingParty.routeNumber	The calling party route number.	string
callingParty.trunkNumber	The calling party trunk number.	string
callingParty.trunkType	The calling party route/trunk type number.	string
calledParty.terminalType	The called party terminal type.	string
calledParty.tenant	The called party tenant number.	string
calledParty.stationNumber	The called party station number.	string
calledParty.stationType	The called party station type.	string
calledParty.routeNumber	The called party route number.	string
calledParty.trunkNumber	The called party trunk number.	string
calledParty.trunkType	The called party route/trunk type number.	string

Events

Answer Call (answerCall)

Answer call notification.

Event Properties

Name	Display	Description	Type
detail	Answer Call Detail	The answer call event detail.	string
answeringParty.terminalType	Terminal Type	The terminal type of the answering party.	string
answeringParty.tenant	Tenant Number	The tenantNumber of the answering party.	string
answeringParty.stationType	Station Type	The station type of the answering party.	string
answeringParty.stationNumber	Station Number	The station or line number of the answering party.	string
answeringParty.physicalStationNumber	Physical Station Number	The physical station number of the answering party.	string
answeringParty.routeNumber	Route Number	The route number of the answering party.	string
answeringParty.trunkNumber	Trunk Number	The trunk number of the answering party.	string
answeringParty.trunkType	Trunk Type	The trunk type of the answering party.	string
answeredParty.terminalType	Terminal Type	The terminal type of the answered party.	string
answeredParty.tenant	Tenant Number	The tenantNumber of the answered party.	string
answeredParty.stationType	Station Type	The station type of the answered party.	string
answeredParty.stationNumber	Station Number	The station number of the answered party.	string
answeredParty.physicalStationNumber	Physical Station Number	The physical station number of the answered party.	string
answeredParty.routeNumber	Route Number	The route number of the answered party.	string
answeredParty.trunkNumber	Trunk Number	The trunk number of the answered party.	string
answeredParty.trunkType	Trunk Type	The trunk type of the answered party.	string
answeredParty.number	Calling Party Telephone Number	The trunk caller-ID telephone number received. (2ndParty additional-2 Info.).	string
answeredParty.name	Calling Party Name	The trunk caller-ID name received. (2ndParty additional-4 Info.).	string
heldParty.terminalType	Terminal Type	The terminal type of the held party.	string
heldParty.tenant	Tenant Number	The tenantNumber of the held party.	string
heldParty.stationType	Station Type	The station type of the held party.	string
heldParty.stationNumber	Station Number	The station number of the held party.	string
heldParty.routeNumber	Route Number	The route number of the held party.	string
heldParty.trunkNumber	Trunk Number	The trunk number of the held party.	string
heldParty.trunkType	Trunk Type	The trunk type of the held party.	string
thirdParty.terminalType	Terminal Type	The terminal type of the third party.	string
thirdParty.tenant	Tenant Number	The tenantNumber of the third party.	string
thirdParty.stationType	Station Type	The station type of the third party.	string
thirdParty.stationNumber	Station Number	The station number of the third party.	string
thirdParty.routeNumber	Route Number	The route number of the third party.	string
thirdParty.trunkNumber	Trunk Number	The trunk number of the third party.	string
thirdParty.trunkType	Trunk Type	The trunk type of the third party.	string
callId	Call ID	The internal call identifier.	string

Call Forwarding Change Notification (callForwarding)

Event that is received when station changes call forwarding state.

Event Properties

Name	Display	Description	Type
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string
callForwardingFunction	Call Forwarding Function	The Call Forwarding function that was changed. (CFA, CFB, CFNA)	string
eventType	Call Forwarding Event Type	The Call Forwarding event type that was performed. (set, cancel)	string
destination	Call Forwarding Destination	The IP Address of the station.	string

Hold Call (holdCall)

Hold call notification.

Event Properties

Name	Display	Description	Type
detail	Hold Call Detail	The hold call event detail.	string
heldParty.terminalType	Terminal Type	The terminal type of the held party.	string
heldParty.tenant	Tenant Number	The tenantNumber of the held party.	string
heldParty.stationType	Station Type	The station type of the held party.	string
heldParty.stationNumber	Station Number	The station number of the held party.	string
heldParty.physicalStationNumber	Physical Station Number	The physical station number of the held party.	string
heldParty.routeNumber	Route Number	The route number of the held party.	string
heldParty.trunkNumber	Trunk Number	The trunk number of the held party.	string
heldParty.trunkType	Trunk Type	The trunk type of the held party.	string
holdingParty.terminalType	Terminal Type	The terminal type of the holding party.	string
holdingParty.tenant	Tenant Number	The tenantNumber of the holding party.	string
holdingParty.stationType	Station Type	The station type of the holding party.	string
holdingParty.stationNumber	Station Number	The station number of the holding party.	string
holdingParty.physicalStationNumber	Physical Station Number	The physical station number of the holding party.	string
holdingParty.routeNumber	Route Number	The route number of the holding party.	string
holdingParty.trunkNumber	Trunk Number	The trunk number of the holding party.	string
holdingParty.trunkType	Trunk Type	The trunk type of the holding party.	string
fourthParty.terminalType	Terminal Type	The terminal type of the fourth party.	string
fourthParty.tenant	Tenant Number	The tenantNumber of the fourth party.	string
fourthParty.stationType	Station Type	The station type of the fourth party.	string
fourthParty.stationNumber	Station Number	The station number of the fourth party.	string
fourthParty.routeNumber	Route Number	The route number of the fourth party.	string
fourthParty.trunkNumber	Trunk Number	The trunk number of the fourth party.	string
fourthParty.trunkType	Trunk Type	The trunk type of the fourth party.	string
thirdParty.terminalType	Terminal Type	The terminal type of the third party.	string
thirdParty.tenant	Tenant Number	The tenantNumber of the third party.	string
thirdParty.stationType	Station Type	The station type of the third party.	string
thirdParty.stationNumber	Station Number	The station number of the third party.	string
thirdParty.routeNumber	Route Number	The route number of the third party.	string
thirdParty.trunkNumber	Trunk Number	The trunk number of the third party.	string
thirdParty.trunkType	Trunk Type	The trunk type of the third party.	string
callId	Call ID	The internal call identifier.	string

Incoming Call (incomingCall)

Incoming call notification.

Event Properties

Name	Display	Description	Type
detail	Incoming Call Detail	The incoming call event detail.	string
callingParty.terminalType	Terminal Type	The terminal type of the calling party.	string
callingParty.tenant	Tenant Number	The tenantNumber of the calling party.	string
callingParty.stationType	Station Type	The station type of the calling party.	string
callingParty.stationNumber	Station Number	The station number of the calling party.	string
callingParty.physicalStationNumber	Physical Station Number	The physical station number of the calling party.	string
callingParty.routeNumber	Route Number	The route number of the calling party.	string
callingParty.trunkNumber	Trunk Number	The trunk number of the calling party.	string
callingParty.trunkType	Trunk Type	The trunk type of the calling party.	string
callingParty.sentDigits	Digits Sent	The digits that were sent out.	string
callingParty.ipAddress	IP-Address	The IP-Address of the calling party.	string
callingParty.locationIndex	Location Index	The Location Index of the calling party.	string
callingParty.number	Calling Party Telephone Number	The trunk caller-ID telephone number received. (2ndParty additional-2 Info.).	string
callingParty.name	Calling Party Name	The trunk caller-ID name received. (2ndParty additional-4 Info.).	string
calledParty.terminalType	Terminal Type	The terminal type of the called party.	string
calledParty.tenant	Tenant Number	The tenantNumber of the called party.	string
calledParty.stationType	Station Type	The station type of the called party.	string
calledParty.stationNumber	Station Number	The station number of the called party.	string
calledParty.physicalStationNumber	Physical Station Number	The physical station number of the called party.	string
calledParty.routeNumber	Route Number	The route number of the called party.	string
calledParty.trunkNumber	Trunk Number	The trunk number of the called party.	string
calledParty.trunkType	Trunk Type	The trunk type of the called party.	string
heldParty.terminalType	Terminal Type	The terminal type of the held party.	string
heldParty.tenant	Tenant Number	The tenantNumber of the held party.	string
heldParty.stationType	Station Type	The station type of the held party.	string
heldParty.stationNumber	Station Number	The station number of the held party.	string
heldParty.routeNumber	Route Number	The route number of the held party.	string
heldParty.trunkNumber	Trunk Number	The trunk number of the held party.	string
heldParty.trunkType	Trunk Type	The trunk type of the held party.	string
thirdParty.terminalType	Terminal Type	The terminal type of the third party.	string
thirdParty.tenant	Tenant Number	The tenantNumber of the third party.	string
thirdParty.stationType	Station Type	The station type of the third party.	string
thirdParty.stationNumber	Station Number	The station number of the third party.	string
thirdParty.routeNumber	Route Number	The route number of the third party.	string
thirdParty.trunkNumber	Trunk Number	The trunk number of the third party.	string
thirdParty.trunkType	Trunk Type	The trunk type of the third party.	string
callId	Call ID	The internal call identifier.	string

OAI Connected (oaiConnected)

The connection to PBX's OAI interface has been established.

No properties defined

Off Hook (offHook)

Off Hook notification.

Event Properties

Name	Display	Description	Type
detail	Off Hook Detail	The Off Hook event detail.	string
stationNumber	Station	The station or line number that generated the off hook event.	string
physicalStationNumber	Physical Station Number	The physical station number.	string
stationType	Station Type	The station type that generated the off hook event.	string
tenant	Tenant Number	The tenant number that generated the off hook event.	string

Outgoing Call (outgoingCall)

Outgoing call notification.

Event Properties

Name	Display	Description	Type
detail	Outgoing Call Detail	The Outgoing call event detail.	string
callingParty.dialedDigits	Dialed Digits	The digits that were dialed by the calling party.	string
calledParty.terminalType	Terminal Type	The terminal type of the called party.	string
calledParty.tenant	Tenant Number	The tenantNumber of the called party.	string
calledParty.stationType	Station Type	The station type of the called party.	string
calledParty.stationNumber	Station Number	The station or line number of the called party.	string
calledParty.physicalStationNumber	Physical Station Number	The physical station number of the called party.	string
calledParty.routeNumber	Route Number	The route number of the called party.	string
calledParty.trunkNumber	Trunk Number	The trunk number of the called party.	string
calledParty.trunkType	Trunk Type	The trunk type of the called party.	string
callingParty.terminalType	Terminal Type	The terminal type of the calling party.	string
callingParty.tenant	Tenant Number	The tenantNumber of the calling party.	string
callingParty.stationType	Station Type	The station type of the calling party.	string
callingParty.stationNumber	Station Number	The station or line number of the calling party.	string
callingParty.physicalStationNumber	Physical Station Number	The physical station number of the calling party.	string
callingParty.routeNumber	Route Number	The route number of the calling party.	string
callingParty.trunkNumber	Trunk Number	The trunk number of the calling party.	string
callingParty.trunkType	Trunk Type	The trunk type of the calling party.	string
heldParty.terminalType	Terminal Type	The terminal type of the held party.	string
heldParty.tenant	Tenant Number	The tenantNumber of the held party.	string
heldParty.stationType	Station Type	The station type of the held party.	string
heldParty.stationNumber	Station Number	The station number of the held party.	string
heldParty.routeNumber	Route Number	The route number of the held party.	string
heldParty.trunkNumber	Trunk Number	The trunk number of the held party.	string
heldParty.trunkType	Trunk Type	The trunk type of the held party.	string
thirdParty.terminalType	Terminal Type	The terminal type of the third party.	string
thirdParty.tenant	Tenant Number	The tenantNumber of the third party.	string
thirdParty.stationType	Station Type	The station type of the third party.	string
thirdParty.stationNumber	Station Number	The station number of the third party.	string
thirdParty.routeNumber	Route Number	The route number of the third party.	string
thirdParty.trunkNumber	Trunk Number	The trunk number of the third party.	string
thirdParty.trunkType	Trunk Type	The trunk type of the third party.	string
callId	Call ID	The internal call identifier.	string

Release Call (releaseCall)

Release call notification.

Event Properties

Name	Display	Description	Type
detail	Release Call Detail	The release call event detail.	string
releasingParty.terminalType	Terminal Type	The terminal type of the releasing party.	string
releasingParty.tenant	Tenant Number	The tenantNumber of the releasing party.	string
releasingParty.stationType	Station Type	The station type of the releasing party.	string
releasingParty.stationNumber	Station Number	The station or line number of the releasing party.	string
releasingParty.physicalStationNumber	Physical Station Number	The physical station number of the releasing party.	string
releasingParty.routeNumber	Route Number	The route number of the releasing party.	string
releasingParty.trunkNumber	Trunk Number	The trunk number of the releasing party.	string
releasingParty.trunkType	Trunk Type	The trunk type of the releasing party.	string
releasedParty.terminalType	Terminal Type	The terminal type of the released party.	string
releasedParty.tenant	Tenant Number	The tenantNumber of the released party.	string
releasedParty.stationType	Station Type	The station type of the released party.	string
releasedParty.stationNumber	Station Number	The station number or line number of the released party.	string
releasedParty.physicalStationNumber	Physical Station Number	The physical station number of the released party.	string
releasedParty.routeNumber	Route Number	The route number of the released party.	string
releasedParty.trunkNumber	Trunk Number	The trunk number of the released party.	string
releasedParty.trunkType	Trunk Type	The trunk type of the released party.	string
heldParty.terminalType	Terminal Type	The terminal type of the held party.	string
heldParty.tenant	Tenant Number	The tenantNumber of the held party.	string
heldParty.stationType	Station Type	The station type of the held party.	string
heldParty.stationNumber	Station Number	The station number of the held party.	string
heldParty.routeNumber	Route Number	The route number of the held party.	string
heldParty.trunkNumber	Trunk Number	The trunk number of the held party.	string
heldParty.trunkType	Trunk Type	The trunk type of the held party.	string
thirdParty.terminalType	Terminal Type	The terminal type of the third party.	string
thirdParty.tenant	Tenant Number	The tenantNumber of the third party.	string
thirdParty.stationType	Station Type	The station type of the third party.	string
thirdParty.stationNumber	Station Number	The station number of the third party.	string
thirdParty.routeNumber	Route Number	The route number of the third party.	string
thirdParty.trunkNumber	Trunk Number	The trunk number of the third party.	string
thirdParty.trunkType	Trunk Type	The trunk type of the third party.	string
callId	Call ID	The internal call identifier.	string

Hotel Room Status Notification (roomStatus)

A hotel room status notification event has occurred for a station.

Event Properties

Name	Display	Description	Type
eventType	Event Type	The event type for the notification.	string
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string
checkedIn	Checked In	True, if the guest is checked in.	string
departureDay	Departure Day	True, if the guest departure day is today.	string
doNotDisturb	Do Not Disturb	True, if the guest has Do Not Disturb set.	string
roomCutoff	Room Cutoff	True, if the guest has Room Cutoff set.	string
wakeupSet	Wakeup Set	True, if wakeup is set.	string
wakeupWasCleared	Wakeup Was Cleared	True, if wakeup was cleared.	string
wakeupSetByGuest	Wakeup Set By Guest	True, if the guest set wakeup.	string
firstWakeupTime	First Wakeup Time	The first wakeup time setting.	string
firstWakeupResult	First Wakeup Result	The result of the first wakeup.	string
secondWakeupTime	Second Wakeup Time	The Second wakeup time setting.	string
secondWakeupResult	Second Wakeup Result	The result of the second wakeup. Note: If the VIP feature (Attendant) is enabled, the second wakeup results will not be shown. See Hotel Programming Manual for more details.	string
groupNumber	Group Number	The group number.	string
groupWakeupTime	Group Wakeup Time	The group wakeup time setting.	string
groupWakeupResult	Group Wakeup Result	The result of the Group wakeup.	string
groupWakeupKind	Group Wakeup Kind	The kind of the Group wakeup.	string
roomReserved	Room Reserved	True, if the guest room is reserved.	string
keyInRack	Key In Rack	True, if the key to the room is hanging in the rack.	string
vip	Very Important Person (VIP)	True, if the guest is a very important person (VIP).	string
messageWaitingFrontDesk	Message Waiting At Front Desk	True, if there is a message waiting for the guest at the front desk.	string
messageWaitingImage	Message Waiting At Image Machine	True, if there is a message waiting for the guest at the imaging machine.	string
messageWaitingAttendant	Message Waiting With Attendant	True, if there is a message waiting for the guest with the attendant.	string
messageWaitingVoiceMail	Message Waiting Voice Mail	True, if there is a voice mail message waiting for the guest.	string
language	Language	The language setting for the guest room.	string
cleanStatus	Room Cleaning Status	The guest room cleaning status.	string
isAdmin	Administrator Station	True, if the guest room station is an administrator type.	string
isGuest	Guest Station	True, if the guest room station is a guest type.	string
guestRoomClass	Guest Room Class	The guest room class value.	string
guestName	Guest Name	The guest name assigned to the station.	string
optionDataA	Option Data A	The Option Data A value.	string
optionDataB	Option Data B	The Option Data B value.	string
message1	Message 1	True, if message 1 value is set.	string
message2	Message 2	True, if message 2 value is set.	string
message3	Message 3	True, if message 3 value is set.	string
message4	Message 4	True, if message 4 value is set.	string

Hotel Wakeup Notification (wakeupStatus)

Event that is received when a wakeup setting is changed for a station.

Event Properties

Name	Display	Description	Type
eventType	Event Type	The event type for the notification.	string
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string

Do Not Disturb (DND) Notification (doNotDisturb)

Event that is received when a DND setting is changed for a station.

Event Properties

Name	Display	Description	Type
eventType	Event Type	The event type for the notification.	string
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string

IP-Address Registration Notification (ipRegister)

Event that is received when an IP station registers.

Event Properties

Name	Display	Description	Type
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string
ipAddress	IP-Address	The IP Address of the station.	string

E911 Registration Notification (e911Register)

Event that is received when an IP station registers.

Event Properties

Name	Display	Description	Type
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string
ipAddress	IP-Address	The IP Address of the station.	string
macAddress	MAC-Address	The MAC Address of the station.	string
locationIndex	Location Index	The Location Index of the station.	string
locationNumber	Location Number	The Location Number of the station.	string

Message Waiting Lamp Notification (messageWaitingLamp)

Event that is received when message waiting lamp has changed.

Event Properties

Name	Display	Description	Type
tenant	Tenant Number	The station tenant number.	string
stationType	Station Type	The station terminal type.	string
stationNumber	Station Number	The extension number.	string
eventType	Event Type	The event type for the notification.	string
mwlIndication	Lamp State	The message waiting lamp indication state.	string

predictiveDial Command Timeout Notification (predictiveDialTimeout)

Event that is received when PredictiveDial Command was timeout.

Event Properties

Name	Display	Description	Type
callingParty.terminalType	Terminal Type	The terminal type of the calling party.	string
callingParty.tenant	Tenant Number	The tenantNumber of the calling party.	string
callingParty.stationType	Station Type	The station type of the calling party.	string
callingParty.stationNumber	Station Number	The station number of the calling party.	string
callingParty.routeNumber	Route Number	The route number of the calling party.	string
callingParty.trunkNumber	Trunk Number	The trunk number of the calling party.	string
callingParty.trunkType	Trunk Type	The trunk type of the calling party.	string
calledParty.terminalType	Terminal Type	The terminal type of the called party.	string
calledParty.tenant	Tenant Number	The tenantNumber of the called party.	string
calledParty.stationType	Station Type	The station type of the called party.	string
calledParty.stationNumber	Station Number	The station number of the called party.	string

Release History

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.
2.0.9	Feature	Added Predictive Dial, Remote Dial and Dual Call Commands	NAP-11963
2.0.11	Maintenance	Updated third-party components and improved maintainability.	NAP-11518
2.0.13	Feature	Added Hotel Support.	NAP-20295
2.0.14	Feature	Enhance Break Station Command and Break Trunk Command. Add Trunk Query Command. Enhance Answer Call Event.	NAP-20371 NAP-22106
2.0.15	Feature	Updated Break Trunk Command, Trunk Query Command, Release Trunk Command, and Dequeue Trunk Command.	NAP-22345
2.0.16	Feature	Support for SV9300 / SV9300CT	NAP-22345
2.0.21	Feature	Add Transfer Remote Call Command. Enhance Remote Dial Command.	NAP-22583
2.0.22	Feature	Add CallForwardingBusy, CallForwardingNoAnswer set/cancel,  Tranfer, Conference, Hold commands. Add Physical Station property to event outputs. Add AnsTransfer, AnsConference commands.	NAP-23627 NAP-23622 NAP-23826
2.0.24	Bug fix	Add prefix to command response for StatusMonitorStartStation/StatusMonitorStartTrunk commands.	NAP-23865
2.0.25	Bug fix	Fix "statusMonitorStationStart" and "statusMonitorTrunkStartError" Fix "answeredParty" property in Answer Call Event Fix Transfer Remote Call SCF_CALLID_MISMATCH error for SV9300 Fix CallIdTerminalKeyComparer behavior	NAP-23821 NAP-23822 NAP-23823 NAP-23827
2.0.26	Maintenance	Reduce logs on OAI reconnection	NAP-23783
2.0.27	Bug fix	Transfer Remote Call command of NEC SV OAI adapter fails as SCF_CALLID_MISMATCH on sv9300.	NAP-23946
2.0.28	Bug fix	Transfer Remote Call command failed after Remote Dial command on CallIDMismatch error.	NAP-24442
2.0.30	Feature & Maintenance	Improved OAI connection recovery Updated dependencies to their latest versions Added more Hotel PMS Support functionality	NAP-26690 NAP-26531	2023-11-02

Categories

• NEC
• Notification
• Unified Communications