Panasonic Selection 470 Programmer'S Manual Download Page 30 | Manualshive

Page: 30 / 126

background image

Section 470 - TSAPI Programmer’s Guide

22

Issued April 2000

DBS-92-470

Chapter 5. Monitor Service Group

Overview

Services in this group allow a client application to request and cancel the reporting of state-
changing events. Panadrvr Release 1.0 supports the following Call-Control Services:

• Monitor Device Service

• Monitor Stop Service

• Monitor Ended Event

• Change Monitor Filter Service

The following Monitor Services are

not

supported by Panadrvr Release 1.0.

• Monitor Call Service

• Monitor Calls Via Device Service

Monitor Device Service

Function: cstaMonitorDevice(), CSTAMonitorConfEvent
Direction: C

→

S

Functional Description:

This service provides call event reports for all devices on all calls at a device. Event
reports are provided for calls that occurred previous to the monitor request and arrive at
the device after the monitor request is acknowledged. No further events of a call are
reported if that call is dropped, forwarded, or transferred and the device no longer is par-
ticipating in the call.

There are no subsequent event reports for a call after a Call Cleared or a Connection
Cleared or a Diverted Event Report has been received for this service. Reporting of the
subsequent call event reports after a Transferred Event Report is dependent on whether the
call is merged-in or merged-out from the monitored device.

Service Parameters:

deviceID

[mandatory] must be a valid digital DBS extension. Analog
devices are not supported in release 1.0.

monitorFilter

[optional - not supported] specifies the filters to be used with

deviceID. Call Filter/Event Reports and Feature Filter/Event
Reports are supported for station device.

Ack Parameters:

monitorCrossRefID

[mandatory] contains the handle chosen by the DBS Driver.

This handle is a unique value within an

acsOpenStream

session for the duration of the monitor and is used by the
application to correlate subsequent event reports to the monitor
request that initiated them. It is also allows the correlation of

the Monitor Stop to the original Monitor Service request.

monitorFilter

[optional - not supported] specifies the event reports that are to
be filtered out on the object being monitored by the

application. This may not be the

monitorFilter

specified in the

«
...
28
29
30
31
32
...
»

Summary of Contents for Selection 470

Page 1: ......

Page 2: ...ocument However due to ongoing product improvements and revisions Panasonic cannot guarantee the accuracy of printed material after the date of publication nor can it accept responsibility for errors or omissions Panasonic will update and revise this document as needed The software and hardware described in this document may be used or copied only in accordance with the terms of the license pertai...

Page 3: ...Service 10 Retrieve Call Service 12 Transfer Call Service 13 Chapter 3 Set Feature Service Group 16 Overview 16 Set Do Not Disturb Feature Service 16 Set Forwarding Feature Service 17 Set Message Waiting Indicator Feature Service 17 Chapter 4 Set Query Service Group 19 Overview 19 Query Do Not Disturb Service 19 Query Forwarding Service 20 Query Message Waiting Service 20 Query Last Number Service...

Page 4: ...vent Report 38 Established Event Report 39 Failed Event Report 40 Held Event Report 40 Network Reached Event 41 Retrieved Event Report 41 Service Initiated Report 42 Transferred Event Report 42 Monitor Ended Event Report 43 Chapter 8 Driver Application Interface Services 44 Universal Failure Confirmation 44 Answer Call Service 44 Clear Call Service 45 Clear Connection Service 45 Conference Call Se...

Page 5: ...ontrol Service Group 69 cstaAnswerCall intercom call 69 cstaAnswerCall trunk call 70 cstaClearCall intercom call 71 cstaClearCall trunk call 72 cstaClearConnection intercom call 73 cstaClearConnection trunk call 74 cstaConferenceCall intercom call 75 cstaConferenceCall trunk intercom call 76 cstaHoldCall intercom call 77 cstaHoldCall trunk call 78 cstaMakeCall intercom call 79 cstaMakeCall trunk c...

Page 6: ... Hold Intercom 101 Hold CO 102 Intercom Call 103 Off Hook Voice Announce 104 Paging Meet Me Answer 105 Transfer Supervised 106 Transfer Unsupervised 107 Trunk Queuing 108 Additional DBS Feature Handling 109 Absence Message 109 Account Codes 109 Auto Redial 109 Barge in for Direct Line 109 Call Coverage 109 Caller ID 109 Caller ID Call Log 109 Call Waiting OHVA Text Reply 109 CO Line Key Trunk Acce...

Page 7: ... Music on Hold 111 One Touch Keys 111 One Touch VM Access 112 Paging 112 Pooled Trunk Access 112 Prime Line Preference 112 Private Line 112 Reminder Call 112 Ringing Line Preference 112 Saved Number Redial 112 SMDR 112 Speed Dials 112 Station Class of Service 113 Station Hunting 113 Station Lockout 113 T1 Trunks 113 Trunk to Trunk Transfer 113 Voice Mail Transfer Key 113 UNA 113 ...

Page 8: ...viii Issued April 2000 DBS 92 470 Section 470 TSAPI Programmer s Guide ...

Page 9: ...00 Installation Manual Panasonic DBS Section 400 Programming Guide Panasonic DBS Section 700 Feature Operation Panasonic DBS TSAPI Overview The essence of Computer Telephony Integration CTI is the ability for computing and switching networks to use the capabilities of the other For instance a computer can control call distribution on the switch network routing calls to the most appropriate agent b...

Page 10: ...l Control Service Group enables a telephony client application to control a call or connection on the DBS Set Feature Service Group allows a client application to set switch controlled features and parameters on a DBS device Query Service Group allows a client application to query the switch for device features and static attributes of a device Monitor Service Group allows a client application to ...

Page 11: ...ase 1 0 Alternate Call Service Consultation Call Service Make Predictive Call Service Reconnect Call Service Functional Descriptions The following pages contain functional descriptions of each Call Control Service item along with illustrations depicting conditions before and after a successful service request Please note the following conventions D1 DX represent deviceIDs Circles represent calls a...

Page 12: ...l may be dropped or placed on hold when the new call is answered depending on how the extension is programmed The deviceID in alertingCall must contain the station extension of the endpoint to be answered on the call A Delivered Event Report must have been received by the applica tion prior to this request The Answer Call Service can be used to answer calls presented to digital telephones only The...

Page 13: ...ice associated with a call C1 to be released The conditions applied to individual extensions concerning the Clear Connection Service apply to each con nection in the call Function cstaClearCall CSTAClearCallConfEvent Direction C S Functional Description The Clear Call Service disconnects all connections from the specified call and terminates the call itself All connection identifiers previously as...

Page 14: ...d 2 One on the connections in the call is being alerted by another monitored extension Notes Switch operation After a successful Clear Call Service request Every station dropped will be in the on hook idle state Any lamps associated with the call are off Displays are cleared Clear Connection Service This service releases the specified connection call C1 D3 and its connectionID from the specified c...

Page 15: ...CallID may be correct but devi ceID is wrong RESOURCE_OUT_OF_SERVICE 34 The DBS is off line OUTSTANDING_REQUEST_LIMIT_EXCEEDED 44 The application has too many outstanding CSTA requests MISTYPED_ARGUMENT_REJECTION 74 DYNAMIC_ID is specified in alertingCall GENERIC_UNSPECIFIED 0 Internal driver error Notes Switch Operation When a party is dropped from an existing conference call with three or more p...

Page 16: ...ction identifier for the call which is active at the controlling device and is to be conferenced with the heldCall The deviceID in activeCall must contain the station extension of the controlling device Ack Parameters newCall mandatory partially supported a connection identifier specifies the resulting new call identifier for the calls which were conferenced at the conference controlling device Th...

Page 17: ...taHoldCall CSTAHoldCallConfEvent Direction C S Functional Description The Hold Call Service places a call on hold at a DBS station The effect is as if the speci fied party depressed the hold button on their station to locally place the call on hold Service Parameters activeCall mandatory a valid connection identifier indicates the connection to be placed on hold This party must be in the active ta...

Page 18: ...d tones if administered will be given to a trunk party placed on hold from the other end either manually or via the Hold Call Service Switch Operation After a party is placed on hold through a Hold Call Service request the user will receive dial tone Subsequent calls can be placed directly or through the Make Call Service request Make Call Service The Make Call Service originates a call between tw...

Page 19: ...ced and the request is denied If the originator is unable to originate for other reasons see universalFailure the switch denies the request Service Parameters callingDevice mandatory must be a valid station extension calledDevice mandatory must be a valid on DBS extension or off DBS number as if they were entered from the telephone using the key pad Ack Parameters newCall mandatory a connection id...

Page 20: ...play Most extension indicators and displays will function identically whether under user or CSTA control However CSTAMakeCall dialed digits will not appear on an extensions display Last Number Dialed Sends the same events as the original call SMDR Any calls made via a CSTAMakeCall request and any call answered via a CSTAAnswerCall request will produce SMDR records when appropriate Switch Operation...

Page 21: ...F_SERVICE 34 The DBS is not on line OUTSTANDING_REQUEST_LIMIT_EXCEEDED 44 The application has a pending CSTA request GENERIC_UNSPECIFIED 0 Internal driver error Notes If the user is listening to dial tone while a request for Retrieve Call Service is received the dial tone will be dropped and the user reconnected to the held call Transfer Call Service This service provides the transfer of a heldCal...

Page 22: ... deviceID in activeCall must contain the station extension of the controlling device Ack Parameters newCall mandatory a connection identifier that specifies the resulting new call identifier for the transferred call connList optional supported specifies the devices on the resulting newCall This includes a count of the number of devices in the new call and a list of up to four connectionIDs and up ...

Page 23: ...emain unchanged for application monitored calls In such cases transfer requested via Transfer Call Service will be denied When this feature is enabled application monitored calls transferred from trunk to trunk will be allowed but there will be no further event reports except for the Network Reached Established Con nection Cleared Event Reports sent to the application ...

Page 24: ...ion This service turns on or off the Do Not Disturb feature for a user station Service Parameters device mandatory must be a valid DBS extension doNotDisturb mandatory specifies either on TRUE or off FALSE Ack Parameters noData None for this service Nak Parameter universalFailure INVALID_CSTA_DEVICE_IDENTIFIER 12 An invalid device identifier has been specified in device RESOURCE_OUT_OF_SERVICE 34 ...

Page 25: ...forwardingOn is set to on It is ignored if the forwardingOn is set to off Ack Parameters noData None for this service Nak Parameter universalFailure INVALID_CSTA_DEVICE_IDENTIFIER 12 An invalid device identifier has been specified in device RESOURCE_OUT_OF_SERVICE 34 The DBS is off line OUTSTANDING_REQUEST_LIMIT_EXCEEDED 44 The application has too many outstanding CSTA requests GENERIC_UNSPECIFIED...

Page 26: ...IMIT_EXCEEDED 44 The application has too many outstanding CSTA requests GENERIC_UNSPECIFIED 0 Internal driver error GENERIC_OPERATION_REJECTION 71 The Panasonic Telephony Services driver Panadrvr does not have a legal message waiting indicator value The DBS requires the driver to indicate which extension port is activating an extension s message waiting lamp In Release 1 0 their value is sup plied...

Page 27: ...Not Disturb Service Function cstaQueryDoNotDisturb CSTAQueryDoNotDisturbConfEvent Direction C S Functional Description This service provides the status of the do not disturb feature expressed as on or off on a device Service Parameters device mandatory Must be a valid DBS station extension that supports the do not disturb feature Ack Parameters doNotDisturb mandatory Status of the do not disturb f...

Page 28: ...ess the list is of length one and the count is one Each element in the list contains the following forwardingType forwardingOn and forwardDN ForwardingType will be one of the values mentioned above ForwardingOn will indicate on off status and forwardDN will contain the forward to number Nak Parameter universalFailure INVALID_CSTA_DEVICE_IDENTIFIER 12 AN invalid device identifier has been specified...

Page 29: ...the driver is loaded or during runtime using the driver s command line switches and or runtime menus Query Last Number Service Function cstaQueryLastNumber CSTAQueryLastNumberEvent Direction C S Functional Description The Query Last Number Service provides last number dialed information for the specified device in the DBS This number may be an internal extension or an outside trunk accessed number...

Page 30: ...e are no subsequent event reports for a call after a Call Cleared or a Connection Cleared or a Diverted Event Report has been received for this service Reporting of the subsequent call event reports after a Transferred Event Report is dependent on whether the call is merged in or merged out from the monitored device Service Parameters deviceID mandatory must be a valid digital DBS extension Analog...

Page 31: ...evice request on multiple objects Monitor Ended Event Report Function CSTAMonitorEndedEvent Direction C S Functional Description The DBS uses the Monitor Ended Event Report to cancel a subscription to a previously requested when a monitor object is removed or changed to become an invalid object Once a Monitor Ended Event Report is generated event reports cease to be sent to the client application ...

Page 32: ...lid Cross Reference ID that was returned in a previous CSTAMonitorConfEvent of this acsOpenStream session Ack Parameters noData None for this service Nak Parameter universalFailure INVALID_CROSS_REF_ID 17 The service request specified a Cross Reference ID that is not in use at this time RESOURCE_OUT_OF_SERVICE 34 The DBS is not on line OUTSTANDING_REQUEST_LIMIT_EXCEEDED 44 The application has a pe...

Page 33: ...Retrieved Event Service Initiated Event Transferred Event The following Event Report Services are not supported by Panadrvr Release 1 0 Queued Event Logged On Event Logged Off Event Definitions Following are the definitions of the enumerated types CSTAEventCause and LocalConnectionState These data structures are used extensively by the Event Report Service Group members described in this chapter t...

Page 34: ...ERFLOW 26 EC_RECALL 27 EC_REDIRECTED 28 EC_REORDER_TONE 29 EC_RESOURCES_NOT_AVAILABLE 30 EC_SILENT_MONITOR 31 EC_TRANSFER 32 EC_TRUNKS_BUSY 33 EC_VOICE_UNIT_INITIATOR 34 CSTAEventCause_t typedef enum LocalConnectionState_t CS_UNKNOWN 2 CS_NONE 1 CS_NULL 0 CS_INITIATE 1 CS_ALERTING 2 CS_CONNECT 3 CS_HOLD 4 CS_QUEUED 5 CS_FAIL 6 LocalConnectionState_t Call Cleared Event Function CSTACallClearedEvent...

Page 35: ...ion CSTAConferencedEvent Direction C S Functional Description The Conference Event Report indicates that two calls are conferenced merged into one and no parties are removed from the resulting call in the process The event may include up to four parties on the resulting call The Conferenced Event Report is generated for the following circumstances When DBS extension completes a conference by press...

Page 36: ... number of devices and a list of up to four connectionIDs and up to four deviceIDs which resulted from the conference If a device is a DBS extension the extension is specified If a device is a DBS trunk the trunk identifier is given localConnectionInfo optional not supported specifies the connection state of the monitored device for this call cause optional not supported specifies the reason for t...

Page 37: ...vents may be sent to the calling party and the called parties The DBS generates the Delivered Event Report when the following events occur Alerting tone is applied to a DBS extension The originator of a cstaMakeCall call is a DBS extension and ringback tone is heard or the voice path is active for voice calls A monitored DBS extension makes a intercom call via the phone The Delivered Event Report ...

Page 38: ...d from a mon itored device It indicates that the call is no longer present at the device The Diverted Event Report is sent to notify the client application that event reports for a call will no longer be provided This event report is sent to a cstaMonitorDevice monitored station when a call leaves the station without the call having been dropped disconnected Examples of this are call forwarding an...

Page 39: ...which joined the call callingDevice mandatory specifies the calling device The following rules apply For internal calls originated at a DBS station the station s extension is specified For incoming calls over a trunk the trunk number is speci fied calledDevice optional partially supported specifies the originally called device lastRedirectionDevice optional not supported specifies the previously a...

Page 40: ...is call cause optional supported specifies the reason for this event Held Event Function CSTAHeldEvent Direction C S Functional Description The Held Event Report indicates that a DBS extension places a call on hold This includes the hold for conference and transfer Placing a call on hold can be done either manually at the station or via a Hold Service request Service Parameters monitorCrossRefID m...

Page 41: ...tbound connection to another network trunkUsed mandatory specifies the trunk identifier that was used to establish the connection calledDevice mandatory not supported specifies the destination device of the call The deviceID is not supported ID_NOT_REQUIRED localConnectionInfo optional supported specifies the connection state of the monitored device for this call cause optional supported specifies...

Page 42: ...ated Event Report indicates that telecommunication service is initiated This event is generated as follows When a DBS extension begins to receive intercom dial tone When a station is forced off hook because a cstaMakeCall is requested on that station When a DBS extension receives intercom dial tone after placing a call on hold After transferring a call via the prog button on the phone After parkin...

Page 43: ... transfer This call ended as a result of the transfer secondaryOldCall mandatory specifies the callID of the call that was transferred This is usually the active call before the transfer This call is ended as a result of the transfer transferringDevice mandatory specifies the device which is controlling the transfer This is the device which did the transfer transferredDevice mandatory specifies th...

Page 44: ...ring Event Report Option Data Type Data Type Value primaryOldCall mandatory ConnectionID_t long callID call_id DeviceID_t device ID controlling extension ConnectionID_device_t deviceIDType STATIC_ID secondaryOldCall mandatory ConnectionID_t long callID call_id DeviceID_t device ID controlling extension ConnectionID_device_t deviceIDType STATIC_ID confController mandatory SubjectDeviceID_t DeviceID...

Page 45: ...ocalConnectionInfo optional LocalConnectionState_t enum CS_CONNECT cause optional CSTAEventCause_t enum EC_KEY_CONFERENCE Event Report Option Data Type Data Type Value droppedConnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID initiator of call extension or turnk ConnectionID_device_t deviceIDType STATIC_ID extension DYNAMIC_ID trunk releasingDevice mandatory SubjectDevice...

Page 46: ...eID_t deviceID extension or trunk that initiated the call ConnectionID_device_t devIDType DEVICE_IDENTIFIER extension TRUNK_IDENTIFIER trunk DeviceIDStatus_t deviceIDStatus ID_PROVIDED calledDevice mandatory CalledDeviceID_t DeviceID_t deviceID extension or trunk that was initially called ConnectionID_device_t devIDType DEVICE_IDENTIFIER extension TRUNK_IDENTIFIER trunk DeviceIDStatus_t deviceIDSt...

Page 47: ...y CallingDeviceID_t DeviceID_t deviceID extension or trunk that initiated the call ConnectionID_device_t devIDType DEVICE_IDENTIFIER extension TRUNK_IDENTIFIER trunk DeviceIDStatus_t deviceIDStatus ID_PROVIDED calledDevice mandatory CalledDeviceID_t DeviceID_t deviceID extension that was initially called ConnectionID_device_t devIDType DEVICE_IDENTIFIER DeviceIDStatus_t deviceIDStatus ID_PROVIDED ...

Page 48: ..._t devIDType DEVICE_IDENTIFIER extension TRUNK_IDENTIFIER trunk DeviceIDStatus_t deviceIDStatus ID_PROVIDED LocalConnectionInfo optional LocalConnectionState_t enum CS_FAIL cause optional CSTAEventCause_t enum cause_value Event Report Option Data Type Data Type Value heldconnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID initiator of call extension or trunk ConnectionID_d...

Page 49: ...L DonnectionID_device_t devIDType EXPLICIT_PUBLIC_UNKNOWN DeviceIDStatus_t deviceIDStatus ID_NOT_REQUIRED LocalConnectionInfo optional LocalConnectionState_t enum CS_CONNECT cause optional CSTAEventCause_t enum EC_NEWCALL Event Report Option Data Type Data Type Value retrievedconnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID extension retrieving the call ConnectionID_dev...

Page 50: ...pe Value primaryOldCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_device_t deviceIDType STATIC_ID secondaryOldCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extensio ConnectionID_device_t deviceIDType STATIC_ID transferringDevice mandatory SubjectDeviceID_t DeviceID_t deviceID controlling extension Connect...

Page 51: ...onID_Device_t devIDType STATIC_ID extension or DYNAMIC_ID trunk SubjectDeviceID_t DeviceID_t deviceID extension or trunk ConnectionID_Device_t devIDType DEVICE_IDENTIFIER or TRUNK _IDENTIFIER DeviceIDStatus_t deviceIDStatus ID_PROVIDED LocalConnectionInfo optional LocalConnectionState_t enum CS_CONNECT or CS_ALERTING cause optional CSTAEventCause_t enum EC_TRANSFER Event Report Option Data Type Da...

Page 52: ...IRMATION EventType_t unsigned short CSTA_UNIVERSAL_FAILURE_ CONF invokeID mandatory InvokeID_t unsigned long invoke_id universalFailure mandatory CSTAUniversalFailure ConfEvent_t CSTAUniversalFailure_ t error CSTAUniversalFailure_ t enum error_code privateData optional not supported Service Request Option Data Type Data Type Value alertingCall mandatory ConnectionID_t long callID call_id DeviceID_...

Page 53: ...ce_t devIDType not used Confirmation Option Data Type Data Type Value clearCall mandatory CSTAClearCallConfEvent_t Nulltype null char NULL Service Request Option Data Type Data Type Value call mandatory ConnectionID_t long callID call_id DeviceID_t deviceID extension dropping from the call ConnectionID_device_t devIDType STATIC_ID Confirmation Option Data Type Data Type Value clearConnection manda...

Page 54: ...nectionID_t newcall ConnectionList_t connList newCall mandatory ConnectionID_t long callID call_id DeviceID_t device ID controlling extension ConnectionID_Device_t devIDType STATIC_ID connList optional ConnectionList_t int count count up to 4 Connection_t connection array of Connection_t structures Connection_t ConnectionID_t party connection i DeviceID_t staticDevice ConnectionID_t long callID ca...

Page 55: ...ed Boolean ON Confirmation Option Data Type Data Type Value heldCall mandatory CSTAHoldConnectionConfEvent_t Nulltype null char NULL Service Request Option Data Type Data Type Value callingDevice mandatory DeviceID_t char 64 source ext calledDevice mandatory DeviceID_t char 64 dest digits Confirmation Option Data Type Data Type Value makeCall mandatory CSTAMakeCallConfEvent_t ConnectionID_t newCal...

Page 56: ... NULL Service Request Option Data Type Data Type Value heldCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_Device_t devIDType STATIC_ID activeCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_Device_t devIDType STATIC_ID Confirmation Option Data Type Data Type Value transferCall mandator...

Page 57: ...e call ConnectionID_Device_t devIDType STATIC_ID extension DYNAMIC_ID trunk SubjectDeviceID_t DeviceID_t deviceID extension or trunk_id on the call ConnectionID_Device_t devIDType DEVICE_IDENTIFIER extension TRUNK_IDENTIFIER trunk DeviceIDStatus_t deviceIDStatus ID_PROVIDED Service Request Option Data Type Data Type Value device mandatory DeviceID_t char 64 extension doNotDisturb mandatory Boolean...

Page 58: ...ANS forwardingOn mandatory Boolean TRUE or FALSE forwardingDN mandatory DeviceID_t char 64 forwarding destination ignored if FALSE Confirmation Option Data Type Data Type Value setFwd mandatory CSTASetFwdConfEvent_t Nulltype null char NULL Service Request Option Data Type Data Type Value device mandatory DeviceID_t char 64 extension where light is to be turned on or off messages mandatory Boolean ...

Page 59: ...d Confirmation Option Data Type Data Type Value monitorStart mandatory CSTAMonitorCallConfEvent_t monitorCrossRefID monitorFilter monitorCrossRefID mandatory CSTAMonitorCrossRefID long cross_ref_id monitorFilter optional supported CSTAMonitorFilter_t CSTACallFilter_t call CSTAFeatureFilter_t feature CSTAAgentFilter_t agent CSTAMaintenanceFilter_ t maintenance CSTACallFilter_t unsigned short 0x0060...

Page 60: ...AQueryDNDConfEvent_t Boolean doNotDisturb TRUE or FALSE Service Request Option Data Type Data Type Value device mandatory DeviceID_t char 64 extension Confirmation Option Data Type Data Type Value queryFwd mandatory CSTAQueryFwdConfEvent_t ListForwardParameters_t forward forward mandatory ListForwardParameters_t short count count 1 ForwardingInfo_t param 7 ForwardingInfo_t ForwardingType_t forward...

Page 61: ...iceID_t char 64 extension Confirmation Option Data Type Data Type Value queryMwi mandatory CSTAQueryMwiConfEvent_t Boolean messages TRUE or FALSE Service Request Option Data Type Data Type Value device mandatory DeviceID_t char 64 extension Confirmation Option Data Type Data Type Value queryLastNumber mandatory CSTAQueryLastNumberConfEvent_ t DeviceID_t lastNumber digits from this extension s last...

Page 62: ...g key should be used to interpret SDL symbols Description A DBS CSTA call state of the described call Point of view is from a monitor request An unknown state indicates that the state of the call is no longer of concern to the described device and event reporting has stopped the device is no longer connected to the call Description A stimulus to a call includes the following Button pushes flash ho...

Page 63: ...on State reflects the Local Connection State of the device that actually receives the call The state is therefore Null until the device is alerted During call setup if the call is passing through an ACD device the Local Connection State does not represent the ACD device s Local Connection State During outbound calls the Local Connection State reflects the Local Connection State of the calling devi...

Page 64: ...ssued April 2000 DBS 92 470 Description Connectors are used to reflect an extension of a state diagram Descriptions that follow the connector are part of the state diagram showing the state to which it is connected SDL Connector SDL Connector ...

Page 65: ... TSAPI Programmer s Guide DBS 92 470 Issued April 2000 57 Null Null Inbound Call to Station Inbound call to station Station off hook Makecall Service initiated Service initiated Initiated Initiated Pending Pending ...

Page 66: ...n No change Inbound Call to Station Alert station tone User busy with no call waiting or call forward Call abandoned Alerting Null No change Alerting Null Received Call clearing Inbound call to station Note Note Call forward immediate will not generate any event reports Call forward immediate ...

Page 67: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 59 Pending Pending Outbound call to station Outbound trunk call Outbound Call to Station Outgoing On hook ...

Page 68: ...ff hook answer call Alternate answer position Call abandoned Established Diverted Delivered Connected Null Established Unknown Received Note Note The Diverted Event is sent to the station the call is being diverted away from No more events for this call are sent to that station Call forward busy no answer ...

Page 69: ... 92 470 Issued April 2000 61 Call Clear Call clearing Call abandoned Clear Connection Clear Call Connection cleared Call Cleared Null Null Calling party dropped Connection Cleared Caller Connection Cleared Called Call cleared Null Null bt rbt ...

Page 70: ...ation Call Outbound station call Alert station tone Busy user with call waiting or call forward Call forward immediate Delivered Failed No event Connected Failed No change Delivered Call clearing Outbound station call Note Note For call forward immediate no events are sent On hook ...

Page 71: ...grammer s Guide DBS 92 470 Issued April 2000 63 Outgoing Outgoing Trunk siezed Network reached Connected Established On hook Note There will be no established event report for this call after the network reached event Note ...

Page 72: ...Section 470 TSAPI Programmer s Guide 64 Issued April 2000 DBS 92 470 On hook Originator drop clearconnection or clearcall Connection cleared Call cleared Null Null On hook ...

Page 73: ...nge No change Established Established Established Other party drops call continued Note Last party drops Call cleared Null Established Connection cleared Connection cleared Connection cleared Established Party drops call continued Note Every party on the call will receive this event report Conference and transfer Hold and retrieve ...

Page 74: ...red Station off hook answer call Established Connected Established Call forward busy no answer Diverted Connected Outbound station call On hook Note The Diverted Event is sent to the station the call is being diverted away from No more events for this call are sent to that station Note ...

Page 75: ... Other party puts on hold Other party retrieved from held Held Held Retrieved No change Held Established Established This party puts on hold Connected This party retrieved from held Retrieved Established Service Initiated pending Note The Held and Retrieved event reports are sent to every device that is on the call ...

Page 76: ...eve Other party puts on hold Other party retrieved from held Held Held Retrieved No change Held Established Established This party puts on hold Connected This party retrieved from held Retrieved Established Service Initiated pending Note The Held and Retrieved event reports are sent to every device that is on the call ...

Page 77: ... 10 CSTA Timing Diagrams Call Control Service Group cstaAnswerCall intercom call EXT A EXT B DRV APP A APP B cal lEXT B RBT CSTA Del i ver ed CSTA Del i ver ed CSTA Est abl i shed CSTA AnswerCal l CSTA AnswerCal lConf phone r i ngi ng answercal lvi a speaker CSTA Est abl i shed ...

Page 78: ...r s Guide 70 Issued April 2000 DBS 92 470 cstaAnswerCall trunk call TRK EXT A DRV APP A CSTA Answer Cal l Answercal lvi a speaker CSTA Est abl i shed CSTA Del i ver ed phone r i ngs t r unk al er t i ng ExtA CSTA AnswerCal lConf ...

Page 79: ...ClearCall intercom call EXTA EXTB DRV APP A APP B t ur nspeakerof f CSTA Connect i onCl ear ed EXTA CSTA Connect i onCl ear ed EXT A CSTA Fai l ed CSTA Cl earCal l CSTA Cl earCal lConf l i st eni ngt oBT CSTA Cal lCl ear ed t ur nspeakerof f CSTA Connect i onCl ear ed EXT B ...

Page 80: ...0 TSAPI Programmer s Guide 72 Issued April 2000 DBS 92 470 cstaClearCall trunk call CO EXT A DRV APP A CSTA Cal lCl ear CSTA Connect i on Cl ear ed EXT A r el ease t r unk CSTA Cal lCl ear ed CSTA Cal lCl earConf ...

Page 81: ... cstaClearConnection intercom call EXT A EXT B DRV APP A APP B t ur n speakerof f CSTA Connect i on Cl ear ed EXT A CSTA Connect i on Cl ear ed EXT A EXT A dr opped CSTA Cl earConnect i on i nt er com cal l l i st eni ng t o BT CSTA Fai l ed CSTA Cl earConnect i on Conf ...

Page 82: ...de 74 Issued April 2000 DBS 92 470 cstaClearConnection trunk call TRK EXT A DRV APP A CSTA Cl earConnect i on CSTA Connect i on Cl ear ed EXT A r el ease t r unk speakerof f t r unk cal l CSTA Cal lCl ear ed CSTA Cl earConnect i on Conf ...

Page 83: ...000 75 cstaConferenceCall intercom call EXT A EXT B EXT C DRV APP A APP B APP CSTA Conf er enced CSTA Conf er enced CSTA Conf er enced Conf er enced Conf er enced Conf er enced CSTA Conf er ence Cal l CSTA Conf er ence Cal lConf i nt er com cal l i nt er com cal l ...

Page 84: ...il 2000 DBS 92 470 cstaConferenceCall trunk intercom call EXT A TRK EXT B DRV APP A APP B CSTA Conf er enced CSTA Conf er enced Conf er enced Conf er enced Conf er enced CSTA Conf er ence Cal l CSTA Conf er ence Cal lConf CO on hol d i nt er com cal l ...

Page 85: ... 92 470 Issued April 2000 77 cstaHoldCall intercom call EXT A EXT B DRV APP A APP B hol d ExtB hol d CSTA Hol d Cal l CSTA Hol d Cal l CSTA Ser vi ce I ni t i at ed CSTA Hol d Cal l i nt er com cal l CSTA Hol d Cal lConf l i st eni ng t o DT ...

Page 86: ...rammer s Guide 78 Issued April 2000 DBS 92 470 cstaHoldCall trunk call TRK EXT A DRV APP A CSTA Hol d Cal l co cal l CSTA Ser vi ce I ni t i at ed co hel d co puton hol d l i st eni ng t o DT CSTA Hel d CSTA Hol d Cal lConf ...

Page 87: ...akeCall intercom call EXT A EXT B DRV APP B APP A CSTA M ake Cal l CSTA Ser vi ce I ni t i at ed CSTA Del i ver ed CSTA Del i ver ed t ur n speakeron l i st en t o DT al er tcal l ed par t y phone al er t i ng pr ocess di gi t s and l i st en t o RBT CSTA M ake Cal lConfEvent ...

Page 88: ...80 Issued April 2000 DBS 92 470 cstaMakeCall trunk call CO EXT A DRV APP A CSTA M ake Cal l CSTA Net wor k Reached sei zed t r unk pr ocess di gi t s t ur n speakeron l i st en t o DT CSTA M ake Cal lConfEvent CSTA Ser vi ce I ni t i at ed ...

Page 89: ... s Guide DBS 92 470 Issued April 2000 81 cstaRetrieveCall intercom held EXT A EXT B DRV APP A APP B unhol d ExtB unhol d ExtB CSTA Ret r i eved CSTA Ret r i eved CSTA Ret r i eve Cal l CSTA Ret r i eve Cal lConf i nt er com hel d ...

Page 90: ...SAPI Programmer s Guide 82 Issued April 2000 DBS 92 470 cstaRetrieveCall CO held TRK EXT A DRV APP A CSTA Ret r i eve Cal l CSTA Ret r i eved unhol d t r unk unhol d t r unk t r unk hel d CSTA Ret r i eve Cal lConf ...

Page 91: ...nsferCall intercom call EXT A EXT B EXT C DRV APP A APP B APP C CSTA Tr ansf er r ed CSTA Tr ansf er r ed CSTA Tr ansf er r ed t r ansf er r ed t r ansf er r ed t r ansf er r ed i nt er com cal l CSTA Tr ansf erCal l CSTA Tr ansf erCal lConf i nt er com hel d i nt er com cal l ...

Page 92: ...ril 2000 DBS 92 470 cstaTransferCall CO Transfer to Extension EXT A TRK EXT B DRV APP A APP B CSTA Tr ansf er r ed CSTA Tr ansf er r ed t r ansf er r ed t r ansf er r ed CSTA Tr ansf erCal l CSTA Tr ansf erCal lConf CO hel d i nt er com cal l co cal l ...

Page 93: ...I Programmer s Guide DBS 92 470 Issued April 2000 85 Set Feature Service Group cstaSet Do Not Disturb EXT A DRV APP A CSTA SetDo NotDi st ur b CSTA Do NotDi st ur b Ei t herSetorCl earDND CSTA SetDo NotDi st ur b Conf ...

Page 94: ...ion 470 TSAPI Programmer s Guide 86 Issued April 2000 DBS 92 470 cstaSet Forwarding EXT A DRV APP A CSTA SetFor war di ng CSTA For war di ng Ei t herSetorCl ear Cal lFor war di ng CSTA SetFor war di ng Conf ...

Page 95: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 87 cstaSet Message Waiting Indication EXT A DRV APP A CSTA SetM W I CSTA SetM W IConf CSTA M sg W ai t i ng t ur n on of fM W Il am p ...

Page 96: ...Section 470 TSAPI Programmer s Guide 88 Issued April 2000 DBS 92 470 Query Service Group cstaQuery Do Not Disturb EXTA DRV APPA CSTAQuer yDoNotDi s t ur b CSTAQuer yDoNotDi s t ur bConf ...

Page 97: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 89 cstaQuery Forwarding EXT A DRV APP A CSTA Q uer y For war di ng CSTA Q uer y For war di ng Conf ...

Page 98: ...Section 470 TSAPI Programmer s Guide 90 Issued April 2000 DBS 92 470 cstaQuery Message Waiting Indication EXT A DRV APP A CSTA Q uer y M W I CSTA Q uer y M W IConf ...

Page 99: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 91 cstaQuery Last Number EXT A DRV APP A CSTA Q uer y LastNum ber CSTA Q uer y LastNum berConf ...

Page 100: ...Section 470 TSAPI Programmer s Guide 92 Issued April 2000 DBS 92 470 Monitor Service Group cstaMonitor Device EXT A DRV APP A CSTA M oni t orDevi ce CSTA M oni t orDevi ce Conf ...

Page 101: ...lustrations depict event timing for common DBS system features Busy Override EXT A EXT B EXT C DRV APP A APP B APP C RBT orBT i nt er com cal l i nt er com cal l Act i vat e Busy O ver r i de CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Del i ver ed CSTA Est abl i shed CSTA Conf er enced CSTA Conf er enced CSTA Conf er enced ...

Page 102: ...sy Immediate EXT A EXT B EXT C DRV APP A APP B APP C cal lExtB ExtB i s busy and has cal lf or war d busy t o ExtC CSTA Ser vi ce I ni t i at ed CSTA Del i ver ed CSTA Del i ver ed CFW DO S i nst ead ofCSTA Del i ver ed a CSTA Net wor k Reached wi l lbe sent St ar tr i ngi ng t o ExtC ...

Page 103: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 95 Call Forwarding No Answer ...

Page 104: ...Section 470 TSAPI Programmer s Guide 96 Issued April 2000 DBS 92 470 Call Park ...

Page 105: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 97 Call Pickup ...

Page 106: ...B act i vat ed Cal lW ai t i ng CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Ser vi ce I ni t i at ed CSTA Del i ver ed CSTA Del i ver ed CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Est abl i shed CSTA Est abl i shed hang up cur r entcal l answercal lwai t i ng BT Ext A Ext B RBT Ext A Ext B ...

Page 107: ...l ear ed CSTA Connect i on Cl ear ed CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Ser vi ce I ni t i at ed CSTA Del i ver ed CSTA Del i ver ed CSTA Est abl i shed CSTA Est abl i shed AnswerCal l CSTA Connect i on Cl ear ed CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Cal lCl ear ed hang up cur r entcal l CSTA Del i ver ed cal l back cal lal er t i ng go of f hook r et ur n CB cal l...

Page 108: ...Section 470 TSAPI Programmer s Guide 100 Issued April 2000 DBS 92 470 3 Way Conference ...

Page 109: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 101 Hold Intercom ...

Page 110: ...Section 470 TSAPI Programmer s Guide 102 Issued April 2000 DBS 92 470 Hold CO CO EXTA DRV APP A CO cal l putcal lon hol d CSTA Hel d l i st eni ng t o DT CSTA Ser vi ce I ni t i at ed ...

Page 111: ...470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 103 Intercom Call EXT A EXT B DRV APP A APP B go of f hook phone r i ngi ng CSTA Del i ver ed di alExtB CSTA Del i ver ed CSTA Ser vi ce I ni t i at ed ...

Page 112: ...Section 470 TSAPI Programmer s Guide 104 Issued April 2000 DBS 92 470 Off Hook Voice Announce ...

Page 113: ... EXT A EXT B DRV APP A APP B go of f hook m ake page CSTA Ser vi ce I ni t i at ed CSTA Ser vi ce I ni t i at ed CSTA Del i ver ed CSTA Est abl i shed CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Del i ver ed CSTA Est abl i shed i nt er com cal l go of f hook i nvoke m eet m e answer ...

Page 114: ...Section 470 TSAPI Programmer s Guide 106 Issued April 2000 DBS 92 470 Transfer Supervised ...

Page 115: ...Section 470 TSAPI Programmer s Guide DBS 92 470 Issued April 2000 107 Transfer Unsupervised ...

Page 116: ... t i at ed CSTA Fai l ed CSTA Connect i on Cl ear ed CSTA Cal lCl ear ed CSTA Ser vi ce I ni t i at ed CSTA Cal lCl ear ed answercal l back and sei ze t r unk cal l back f r om t r unk t r unk becom es i dl e CSTA Del i ver ed CSTA Net wor k Reached CSTA Connect i on Cl ear ed go on hook act i vat e CO queui ng l i st en t o di al t one di alCO 1 l i st en t o busyt one ...

Page 117: ...Call request Auto Redial The events will be the same as the original call Barge in for Direct Line Not supported Call Coverage Not supported Caller ID The Caller ID number if available is passed in the CSTADelivered Event and the CSTATransferred Event Caller ID Call Log Sends no events to the TSAPI client Call Waiting OHVA Text Reply Call Waiting Off hook Voice Announce Text Reply cannot be activa...

Page 118: ...ning 88XX DID Incoming DID calls send CSTADelivered Events with the calling party the trunk number DISA Events with DISA calls are not supported Do Not Disturb The TSAPI client can set or clear DND via a CSTASetDoNotDisturb request An extension that makes a call to an extension with DND set will receive a CSTAFailed event EM 24 Console Any programmed keys supported on the K Tel are also supported ...

Page 119: ...me events as the original call LCR Least Cost Routing LCR will apply to a CSTAMakeCall request with the first dialed digit 9 Line Appearances The user can manually pick up any alerting call on a BLF appearance and the TSAPI client will be notified of the pickup The client will not be sent CSTADelivered events when the call first starts alerting a coverage member s extension or a BLF key whether or...

Page 120: ...nt No trunk access codes are needed in the dialed digits for the CSTAMakeCall request Private Line The same events are sent as for regular trunks both incoming and outgoing calls Reminder Call This has no affect on TSAPI clients Ringing Line Preference The same events are sent as when the call is answered via either CSTAAnswerCall request or handset off speaker on Saved Number Redial The same even...

Page 121: ... will send a CSTANetworkReached event Trunk to Trunk Transfer The same restrictions apply as for the extension transferring the call via the prog button on the telephone Voice Mail Transfer Key Upon pressing the Voice Mail Transfer key a CSTAHeld Event and a CSTAService Initiated Event will be sent After dialing an extension or pressing a DSS key a CSTATransferred Event will be sent UNA If assigne...

Page 122: ...Section 470 TSAPI Programmer s Guide 114 Issued April 2000 DBS 92 470 ...

Page 123: ...nferenceCall trunk intercom call 76 Conferenced Event 27 Conferenced Event Report 36 Connection Cleared Event 28 Connection Cleared Event Report 37 CSTA overview 1 CSTA Event Reports 55 CSTA Retrieved Event 33 CSTA Service Groups supported 2 CSTA Timing Diagrams 69 cstaAnswerCall 4 CSTAAnswerCallConfEvent 4 CSTACallClearedEvent 26 cstaClearCall 5 CSTAClearCallConfEvent 5 cstaClearConnectin 6 CSTAC...

Page 124: ...shed Callflow Diagram 65 Established Event 31 Established Event Report 39 Event Report Service Group 25 F Failed Event 31 Failed Event Report 40 FF Keys 110 H Handsfree Answerback 110 Handsfree Operation 111 Held Event 32 Held Event Report 40 Hold and Retrieve Callflow Diagram 67 Hold Call Service 9 47 Hold CO 102 Hold Intercom 101 HoldCall intercom call 77 HoldCall trunk call 78 Hot Dial Pad 111 ...

Page 125: ...12 48 RetrieveCall CO held 82 RetrieveCall intercom held 81 Retrieved Event 33 Retrieved Event Report 41 Ringing Line Preference 112 S Saved Number Redial 112 SDL Connector 56 SDL symbols 54 Service Initiated Event 34 Service Initiated Report 42 Set Do Not Disburb 85 Set Do Not Disturb Feature Service 16 49 Set Feature Service Group 16 85 Set Forwarding 86 Set Forwarding Feature Service 17 50 Set ...

Page 126: ...iv Issued April 2000 DBS 92 470 Section 470 TSAPI Programmer s Guide ...

Reviews:

No comments

Related manuals for Selection 470

Brand: Samsung Pages: 34

Brand: NEC Pages: 24

Brand: jablotron Pages: 2

Wireless Service Gateway WSG

Brand: Unify Pages: 39

Brand: VTech Pages: 2

Brand: AT&T Pages: 10

Brand: Verizon Pages: 5

Brand: Radio Shack Pages: 44

Brand: GE Pages: 48

Brand: Karel Pages: 81

Brand: urmet domus Pages: 52

Brand: AT&T Pages: 15

Brand: Flying Voice Pages: 64

Brand: 2N Pages: 32

Brand: GE Pages: 38

Brand: GE Pages: 84

Brand: GE Pages: 2

Brand: GE Pages: 2

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands