1. Manuals
  2. Brands
  3. Panasonic Manuals
  4. Telephone
  5. Selection 470
  6. Programmer's manual

Panasonic Selection 470 Programmer's Manual

Digital business system
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual

Advertisement

Table of Contents
loading

Related Manuals for Panasonic Selection 470

Summary of Contents for Panasonic Selection 470

  • Page 2 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.

  • Page 3: Table Of Contents

    Panasonic DBS TSAPI Overview........
  • Page 4 Section 470 - TSAPI Programmer’s Guide Overview..............25 Definitions .
  • Page 5 Section 470 - TSAPI Programmer’s Guide Query Do Not Disturb Feature Service......... . 52 Query Forwarding Feature Service.
  • Page 6 Section 470 - TSAPI Programmer’s Guide cstaQuery Forwarding........... . 89 cstaQuery Message Waiting Indication .
  • Page 7 Section 470 - TSAPI Programmer’s Guide Hot Dial Pad ............111 Internal Hold Tone .
  • Page 8 Section 470 - TSAPI Programmer’s Guide viii Issued April 2000 DBS-92-470...

  • Page 9: Chapter 1. Introduction

    The standard which makes this possible is called CSTA, or Computer-Supported Telecommunications Applications. Both the Novell Telephony Server NLM and the Panasonic PBX NLM (Panadrvr) are designed to CSTA stan- dards. Panadrvr performs the following functions: •...

  • Page 10: Supported Csta Service Groups

    Section 470 - TSAPI Programmer’s Guide • Provides an application programming interface for DBS-specific administration and maintenance. Supported CSTA Service Groups CSTA services are grouped according to their function. Panadrvr supports the following CSTA service groups: Name Description Call Control Service enables a telephony client application to control a call or Group connection on the DBS.

  • Page 11: Chapter 2. Call-Control Service Group

    Section 470 - TSAPI Programmer’s Guide Chapter 2. Call-Control Service Group Overview Services in this group enable a telephony client application to control a call or connection on the DBS. Some examples are placing calls from a device and controlling connections on a call in progress in the DBS.

  • Page 12: Answer Call Service

    Section 470 - TSAPI Programmer’s Guide * = Unspecified • Grayed boxes represent devices in a call unaffected by the service or event report. • White boxes and circles represent devices and calls affected by the service or event report. •...

  • Page 13: Clear Call Service

    All connection identifiers previously associated with the call are no longer valid. It should be noted that the DBS in itself does not support the cstaClearCall function -- instead the Panasonic Telephony Services driver converts the cstaClearCall function into individual cstaClearConnection functions. The driver makes every attempt to verify that all the cstaClearConnection commands will succeed;...

  • Page 14: Clear Connection Service

    Section 470 - TSAPI Programmer’s Guide Service Parameters: [mandatory] a valid connection identifier indicates the call to call be cleared. The deviceID of call is optional. If it is specified, it is ignored. Ack Parameters: None for this service. noData Nak Parameter: universalFailure •...

  • Page 15: Conference Call Service

    Section 470 - TSAPI Programmer’s Guide The connection is left in the Null state. The connection identifier is no longer associated with the call. The party to be dropped must be an extension. A connection in the alerting or held state cannot be cleared. Service Parameters: [mandatory] a valid connection identifier indicates the call...
  • Page 16 Section 470 - TSAPI Programmer’s Guide Function: cstaConferenceCall(), CSTAConferenceCallConfEvent Direction: C → S Functional Description: This service provides the conference of an existing held call (heldCall) and another active call (activeCall) at the controlling device. The two calls are merged into a single call and the two connections at the conference controlling device are resolved into a single connec- tion in the connected state.

  • Page 17: Hold Call Service

    Section 470 - TSAPI Programmer’s Guide • NO_ACTIVE_CALL (24) The active call parameter is incorrect. • 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 (0) Internal driver error. Notes: •...

  • Page 18: Make Call Service

    Section 470 - TSAPI Programmer’s Guide • INVALID_CSTA_CONNECTION_IDENTIFIER (13) The connection identifier contained in the request is invalid or does not correspond to a station. • NO_ACTIVE_CALL (24) The party to be put on hold is not currently active (e.g., in alerting state) so it cannot be put on hold.
  • Page 19 Section 470 - TSAPI Programmer’s Guide The client application uses this service to set up a call on behalf of a station extension (calling party) to an on- or off-DBS endpoint (calledDevice). All trunk types are supported as facilities for reaching called endpoints for outbound csta- MakeCall calls.

  • Page 20: Retrieve Call Service

    Section 470 - TSAPI Programmer’s Guide Notes: • TRS - The same Toll Restriction Services apply to calls generated via a CSTAMake- Call request as exist with user dialed numbers. • LCR - Least Cost Routing will apply to a CSTAMakeCall request with the first dialed digit “9”.

  • Page 21: Transfer Call Service

    Section 470 - TSAPI Programmer’s Guide Service Parameters: [mandatory] a valid connection identifier indicates the heldCall endpoint to be connected. The deviceID in heldCall must contain the station extension of the endpoint. Ack Parameters: None for this service. noData Nak Parameter: universalFailure •...
  • Page 22 Section 470 - TSAPI Programmer’s Guide Function: cstaTransferCall(), CSTATransferCallConfEvent Direction: C → S Functional Description: This service provides the transfer of an existing held call (heldCall) and another active or proceeding call (alerting, or connected) (activeCall) at a device. The Transfer Service merges two calls with connections at a single common device into one call.
  • Page 23 Section 470 - TSAPI Programmer’s Guide Notes: • Trunk to Trunk Transfer - Existing rules for trunk-to-trunk transfer from a station user will remain 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: Chapter 3. Set Feature Service Group

    Section 470 - TSAPI Programmer’s Guide Chapter 3. Set Feature Service Group Overview These services allow a client application to set switch-controlled features on a Panasonic DBS. The following CSTA Services are supported in the NetWare Telephony Services product: • Set Do Not Disturb Feature Service •...

  • Page 25: Set Forwarding Feature Service

    Section 470 - TSAPI Programmer’s Guide Set Forwarding Feature Service Function: cstaSetForwarding( ), CSTASetFwdConfEvent Direction: C → S Functional Description: The Set Forwarding Service sets the DBS Call Forwarding feature on or off for a user sta- tion. The DBS supports Call Forward Immediate, Call Forward Busy, and Call Forward No Answer types.
  • Page 26 • 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 by the driver.

  • Page 27: Chapter 4. Set Query Service Group

    Section 470 - TSAPI Programmer’s Guide Chapter 4. Set Query Service Group Overview These services allow a client application to query the switch for the state of device features and static attributes of a device. Panadrvr Release 1.0 supports the following Query Services: •...

  • Page 28: Query Forwarding Service

    Section 470 - TSAPI Programmer’s Guide Query Forwarding Service Function: cstaQueryForwarding (), CSTAQueryForwardingConfEvent Direction: C → S Functional Description: This service provides the status and forward-to-number of the Call Forwarding feature for a device. The status is expressed as on or off. The DBS supports types of call forwarding which cannot be directly specified in CSTA terms.

  • Page 29: Query Last Number Service

    Section 470 - TSAPI Programmer’s Guide universalFailure • INVALID_CSTA_DEVICE_IDENTIFIER (12) AN invalid device identifier has been specified in device. • RESOURCE_OUT_OF_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.

  • Page 30: Chapter 5. Monitor Service Group

    Section 470 - TSAPI Programmer’s Guide 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 •...

  • Page 31: Monitor Ended Event Report

    Section 470 - TSAPI Programmer’s Guide service request, because filters for events that are not supported by the DBS are always turned on in monitorFilter. Nak Parameter: universalFailure • INVALID_CSTA_DEVICE_IDENTIFIER (12) An invalid device identifier or extension is specified in deviceID. •...
  • Page 32 Section 470 - TSAPI Programmer’s Guide client application by the DBS and the Cross Reference Association that was established by the original service request is terminated. Service Parameters: [mandatory] must be a valid Cross Reference ID that was monitorCrossRefID returned in a previous CSTAMonitorConfEvent of this acsOpenStream session.

  • Page 33: Chapter 6. Event Report Service Group

    Section 470 - TSAPI Programmer’s Guide Chapter 6. Event Report Service Group Overview Services in this group provide a client application with reports of state-changing events to a call, a connection, or a device. Panadrvr Release 1.0 supports the following Event Report Services: •...

  • Page 34: Call Cleared Event

    Section 470 - TSAPI Programmer’s Guide EC_CALL_PICKUP = 11, EC_CAMP_ON = 12, EC_DEST_NOT_OBTAINABLE = 13, EC_DO_NOT_DISTURB = 14, EC_INCOMPATIBLE_DESTINATION = 15, EC_INVALID_ACCOUNT_CODE = 16, EC_KEY_CONFERENCE = 17, EC_LOCKOUT = 18, EC_MAINTENANCE = 19, EC_NETWORK_CONGESTION = 20, EC_NETWORK_NOT_OBTAINABLE = 21, EC_NEW_CALL = 22, EC_NO_AVAILABLE_AGENTS = 23, EC_OVERRIDE = 24, EC_PARK = 25,...

  • Page 35: Conferenced Event

    Section 470 - TSAPI Programmer’s Guide Service Parameters: [mandatory] contains the handle to the monitor request for monitorCrossRefID which this event is reported. [mandatory] specifies the callID of the call which has been clearedCall cleared. [optional - supported] always specifies a null state localConnectionInfo (CS_NULL).

  • Page 36: Connection Cleared Event

    Section 470 - TSAPI Programmer’s Guide [mandatory] specifies the callID of the call that was primaryOldCall conferenced. This is usually the held call before the conference. This call ended as a result of the conference. [mandatory] specifies the callID of the call that was secondaryOldCall conferenced.

  • Page 37: Delivered Event

    Section 470 - TSAPI Programmer’s Guide Service Parameters: [mandatory] contains the handle to the monitor request for monitorCrossRefID which this event is reported. [mandatory] specifies the connection which has been dropped droppedConnection from the call. [mandatory] specifies the dropped device. releasingDevice •...

  • Page 38: Diverted Event

    Section 470 - TSAPI Programmer’s Guide able. [optional - partially supported] specifies the originally called calledDevice device. In the case of diverted calls, this value is supplied. [optional - not supported] specifies the previously alerted lastRedirectionDevice device in case where the call was redirected or diverted to the alertingDevice.

  • Page 39: Established Event

    Section 470 - TSAPI Programmer’s Guide Established Event Function: CSTAEstablishedEvent Direction: C ← S Functional Description: The Established Event Report indicates that the DBS detects that a device answers or con- nects to a call. The Established Event Report is sent as follows: •...

  • Page 40: Held Event

    Section 470 - TSAPI Programmer’s Guide The DBS TSAPI driver has the ability to intercept failed events due to a party disconnect- ing from a call. Service Parameters: [mandatory] contains the handle to the monitor request for monitorCrossRefID which this event is reported. [mandatory - supported] specifies the callID that failed.

  • Page 41: Network Reached Event

    Section 470 - TSAPI Programmer’s Guide Network Reached Event Function: CSTANetworkReachedEvent Direction: C ← S Functional Description: This event indicates that a call has reached an outgoing trunk. This event report implies that there will be no additional device feedback, except discon- nect/drop, provided for this party in the call.

  • Page 42: Service Initiated Event

    Section 470 - TSAPI Programmer’s Guide Service Parameters: [mandatory] contains the handle to the monitor request for monitorCrossRefID which this event is reported. [mandatory] specifies the connection for which the call has retrievedConnection been taken off the hold state. [mandatory] specifies the device which connected the call from retrievingDevice the hold state.
  • Page 43 Section 470 - TSAPI Programmer’s Guide Functional Description: The Transferred Call Event Report indicates that an existing call was transferred to another device and the device requesting the transfer has been dropped from the call. The transferringDevice will not appear in any future events for the call. The Transferred Event Report is generated for the following circumstances: •...

  • Page 44: Chapter 7. Driver Application Interface Events

    Section 470 - TSAPI Programmer’s Guide Chapter 7. Driver Application Interface Events Call Cleared Event Report Event Report Option Data Type Data Type ... Value clearedCall mandatory ConnectionID_t long callID call_id DeviceID_t device ID controlling extension ConnectionID_device_t STATIC_ID deviceIDType localConnectionInfo optional - supported LocalConnectionState_t enum...

  • Page 45: Connection Cleared Event Report

    Section 470 - TSAPI Programmer’s Guide Event Report Option Data Type Data Type ... Value conferencedConnections optional ConnectionList_t int count count - up to 4 Connection_t array of Connection_t structures *connection Connection_t ConnectionID_t party connection[i] SubjectDeviceID_t staticDevice ConnectionID_t long callid call_id DeviceID_t devID extension or trunk...

  • Page 46: Delivered Event Report

    Section 470 - TSAPI Programmer’s Guide Delivered Event Report Event Report Option Data Type Data Type ... Value connection mandatory ConnectionID_t long callID call_id DeviceID_t device ID initiator of call - extension or trunk ConnectionID_device_t STATIC_ID - extension deviceIDType DYNAMIC_ID - trunk alertingDevice mandatory SubjectDeviceID_t...

  • Page 47: Established Event Report

    Section 470 - TSAPI Programmer’s Guide Established Event Report Event Report Option Data Type Data Type ... Value establishedconnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID initiator of call - extension or trunk ConnectionID_device_t STATIC_ID - extension deviceIDType DYNAMIC_ID - trunk answeringDevice mandatory SubjectDeviceID_t...

  • Page 48: Failed Event Report

    Section 470 - TSAPI Programmer’s Guide Failed Event Report Event Report Option Data Type Data Type ... Value failedConnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID initiating extension ConnectionID_device_t STATIC_ID - extension deviceIDType failingDevice mandatory SubjectDeviceID_t DeviceID_t deviceID initiating extension ConnectionID_device_t DEVICE_IDENTIFIER devIDType...

  • Page 49: Network Reached Event

    Section 470 - TSAPI Programmer’s Guide Network Reached Event Event Report Option Data Type Data Type ... Value connection mandatory ConnectionID_t long callID call_id DeviceID_t device ID trunk_id ConnectionID_device_t DYNAMIC_ID deviceIDType trunkUsed mandatory SubjectDeviceID_t DeviceID_t deviceID trunk_id ConnectionID_device_t TRUNK_IDENTIFIER devIDType DeviceIDStatus_t ID_PROVIDED deviceIDStatus...

  • Page 50: Service Initiated Report

    Section 470 - TSAPI Programmer’s Guide Service Initiated Report Event Report Option Data Type Data Type ... Value initiatedConnection mandatory ConnectionID_t long callID call_id DeviceID_t device ID extension initiating the call ConnectionID_device_t STATIC_ID deviceIDType LocalConnectionInfo optional LocalConnectionState_t enum CS_INITIATE cause optional CSTAEventCause_t enum...

  • Page 51: Monitor Ended Event Report

    Section 470 - TSAPI Programmer’s Guide Event Report Option Data Type Data Type ... Value transferredConnections optional ConnectionList_t int count count - 2 Connection_t array of connection_t *connection Connection_t ConnectionID_t party connection[i] SubjectDeviceID_t staticDevice ConnectionID_t long callid call_id DeviceID_t devID extension or trunk ConnectionID_Device_t STATIC_ID (extension) or...

  • Page 52: Chapter 8. Driver Application Interface Services

    Section 470 - TSAPI Programmer’s Guide Chapter 8. Driver Application Interface Services Universal Failure Confirmation Parameter Option Data Type Data Type ... Value eventHeader mandatory ACSEventHeader_t ACSHandle_t acsHandle EventClass_t eventClass EventType_t eventType ACSHandle_t unsigned short handle_id EventClass_t unsigned short CSTACONFIRMATION EventType_t unsigned short CSTA_UNIVERSAL_FAILURE_...

  • Page 53: Clear Call Service

    Section 470 - TSAPI Programmer’s Guide Clear Call Service Service Request Option Data Type Data Type ... Value *call mandatory ConnectionID_t long callID call_id DeviceID_t deviceID not used ConnectionID_device_t not used devIDType Confirmation Option Data Type Data Type ... Value clearCall mandatory CSTAClearCallConfEvent_t...

  • Page 54: Conference Call Service

    Section 470 - TSAPI Programmer’s Guide Conference Call Service Service Request Option Data Type Data Type ... Value *heldCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_device_t STATIC_ID devIDType *activeCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_device_t STATIC_ID devIDType...

  • Page 55: Hold Call Service

    Section 470 - TSAPI Programmer’s Guide Hold Call Service Service Request Option Data Type Data Type ... Value *activeCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_device_t STATIC_ID devIDType reservation optional not Boolean supported Confirmation Option Data Type Data Type ...

  • Page 56: Retrieve Call Service

    Section 470 - TSAPI Programmer’s Guide Retrieve Call Service Service Request Option Data Type Data Type ... Value *heldCall mandatory ConnectionID_t long callID call_id DeviceID_t deviceID controlling extension ConnectionID_Device_t STATIC_ID devIDType Confirmation Option Data Type Data Type ... Value retrieveCall mandatory CSTARetrieveCallConfEvent_t Nulltype...

  • Page 57: Set Do Not Disturb Feature Service

    Section 470 - TSAPI Programmer’s Guide Confirmation Option Data Type Data Type ... Value connList optional ConnectionList_t int count count - 2 Connection_t array of Connection_t structures *connection Connection_t ConnectionID_t party connection[i] DeviceID_t staticDevice ConnectionID_t long callID call_id DeviceID_t deviceID extension or trunk_id on the call ConnectionID_Device_t STATIC_ID - extension...

  • Page 58: Set Forwarding Feature Service

    Section 470 - TSAPI Programmer’s Guide Set Forwarding Feature Service Service Request Option Data Type Data Type ... Value *device mandatory DeviceID_t char[64] extension forwardingType mandatory ForwardingType_t enum FWD_IMMEDIATE, FWD_BUSY or FWD_NO_ANS forwardingOn mandatory Boolean TRUE or FALSE *forwardingDN mandatory DeviceID_t char[64] forwarding destination...

  • Page 59: Monitor Calls Via Device And Monitor Device Service

    Section 470 - TSAPI Programmer’s Guide Monitor Calls via Device and Monitor Device Service Service Request Option Data Type Data Type ... Value *deviceID mandatory DeviceID_t char[64] extension to monitor monitorFilter optional not CSTAMonitorFilter_t CSTACallFilter_t call supported CSTAFeatureFilter_t feature CSTAAgentFilter_t agent CSTAMaintenanceFilter_t maintenance CSTACallFilter_t...

  • Page 60: Query Do Not Disturb Feature Service

    Section 470 - TSAPI Programmer’s Guide Query Do Not Disturb Feature Service Service Request Option Data Type Data Type ... Value *device mandatory DeviceID_t char{64} extension Confirmation Option Data Type Data Type ... Value queryDND mandatory CSTAQueryDNDConfEvent_t Boolean doNotDisturb TRUE or FALSE Query Forwarding Feature Service Service Request Option...

  • Page 61: Query Message Waiting Indicator Feature Service

    Section 470 - TSAPI Programmer’s Guide Query Message Waiting Indicator Feature Service Service Request Option Data Type Data Type ... Value *device mandatory DeviceID_t char{64} extension Confirmation Option Data Type Data Type ... Value queryMwi mandatory CSTAQueryMwiConfEvent_t Boolean messages TRUE or FALSE Query Last Number Dialed Service Service Request...

  • Page 62: Chapter 9. Callflow Diagrams

    Section 470 - TSAPI Programmer’s Guide Chapter 9. Callflow Diagrams Overview The following callflow diagrams reflect the CSTA Call Event Reports received by an application during call processing. The diagrams use Specification and Description Language (SDL) as defined in CCITT Recommendations Z.101 to Z.104 to depict the relationship of call state/stimulus/event report/local connection state for DBS TSAPI/CSTA events.

  • Page 63: Csta Event Reports

    Section 470 - TSAPI Programmer’s Guide CSTA Event Reports CSTA Event Report Description: A single DBS CSTA Event Report is sent to a cstaMonitorDevice monitor request only. • Event is sent from the switch to the application. • Point of view is from a monitor request. •...

  • Page 64: Sdl Connector

    Section 470 - TSAPI Programmer’s Guide SDL Connector Connector 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. Issued April 2000 DBS-92-470...

  • Page 65: Null

    Section 470 - TSAPI Programmer’s Guide Null Null Inbound Station Makecall call to station off-hook Inbound Call to Service Service Station initiated initiated Initiated Initiated Pending Pending DBS-92-470 Issued April 2000...

  • Page 66: Inbound Call To Station

    Section 470 - TSAPI Programmer’s Guide Inbound Call to Station Inbound Call to St ati on User b usy with Alert statio n Call forward no call waiting Call tone immediate or call forw ard aband oned Note Alerti ng Null No change Alerti ng...

  • Page 67: Pending

    Section 470 - TSAPI Programmer’s Guide Pending Pending Outbound Outbound call to station trunk call On-hook Outbound Call to Outgoing Station DBS-92-470 Issued April 2000...

  • Page 68: Received

    Section 470 - TSAPI Programmer’s Guide Received Received Statio n Call forward Altern ate off-h ook Call busy/no answer answer position answer call aband oned Note Established Diverted Delive red Connected Null Alerti ng Established Unkno wn Receiv ed 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.

  • Page 69: Call Clear

    Section 470 - TSAPI Programmer’s Guide Call Clear ( bt ) ( rbt ) Call Call clearing abandoned Clear Calling party Connection dropped Clear Call Connection Connection cleared Cleared Caller Connection Call Cleared Cleared Called Call cleared Null Null Null Null DBS-92-470 Issued April 2000...

  • Page 70: Outbound Station Call

    Section 470 - TSAPI Programmer’s Guide Outbound Station Call Outbound station call Busy user with Call forward Alert station On-hook call waiting or tone immediate call forward Note Delivered Failed No event Connected Failed No change Outbound station Delivered Call clearing call Note: For call forward immediate, no events are sent.

  • Page 71: Outgoing

    Section 470 - TSAPI Programmer’s Guide Outgoing Outgoing On-hook Trunk siezed Note Network reached Connected Established Note: There will be no established event report for this call after the network reached event. DBS-92-470 Issued April 2000...

  • Page 72: On-Hook

    Section 470 - TSAPI Programmer’s Guide On-hook On-hook Originator drop clearconnection or clearcall Connection cleared Call cleared Null Null Issued April 2000 DBS-92-470...

  • Page 73: Established

    Section 470 - TSAPI Programmer’s Guide Established Established New party Other party Party drops, Last party Hold Conference connects to drops, call call continued drops call continued retrieve transfer Note Connection Connection Connection Established cleared cleared cleared Null Call cleared Change change Established...

  • Page 74: Delivered

    Section 470 - TSAPI Programmer’s Guide Delivered Delivered Station Call On-hook off-hook, forward, busy answer call no answer Note Established Diverted Connected Connected Outbound station Established call 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.

  • Page 75: Hold And Retrieve

    Section 470 - TSAPI Programmer’s Guide Hold and Retrieve H o ld a n d R e tr iev e O th e r Th is p ar ty O th e r p ar t y Th is p arty pa rty r e tr ie v ed re tr ie ve d fr o m puts on h old...

  • Page 76: Conference And Transfer

    Section 470 - TSAPI Programmer’s Guide Conference and Transfer H o ld a n d R e tr iev e O th e r Th is p ar ty O th e r p ar t y Th is p arty pa rty r e tr ie v ed re tr ie ve d fr o m puts on h old...

  • Page 77: Chapter 10. Csta Timing Diagrams

    Section 470 - TSAPI Programmer’s Guide Chapter 10. CSTA Timing Diagrams Call Control Service Group cstaAnswerCall - intercom call D R V A PP A A PP B EXT A EXT B cal lEXT B R BT C STA D el i ver ed phone r i ngi ng C STA D el i ver ed C STA Answ erC al l...

  • Page 78: Cstaanswercall - Trunk Call

    Section 470 - TSAPI Programmer’s Guide cstaAnswerCall - trunk call A PP A TR K EXT A D R V t r unk al er t i ng ExtA phone r i ngs C STA D el i ver ed C STA Answ er C al l () C STA Answ erC al lC onf Answ ercal lvi a speaker...

  • Page 79: Cstaclearcall - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaClearCall - intercom call APP A APP B EXT A EXT B CSTA Cl earCal l CSTA Cl earCal lConf t ur n speakerof f CSTA Connect i on Cl ear ed( EXT A) CSTA Connect i on Cl ear ed ( EXT A) l i st eni ng t o BT CSTA Fai l ed...

  • Page 80: Cstaclearcall - Trunk Call

    Section 470 - TSAPI Programmer’s Guide cstaClearCall - trunk call EXT A D RV A PP A C STA C al lC l ear C STA C al lC l earC onf r el ease t r unk C STA C onnect i on C l ear ed ( EXT A) C STA C al lC l ear ed Issued April 2000 DBS-92-470...

  • Page 81: Cstaclearconnection - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaClearConnection - intercom call D R V A PP A A PP B EXT A EXT B i nt er com cal l C STA C l earC onnect i on t ur n speakerof f C STA C onnect i on C l ear ed ( EXT A) EXT A dr opped C STA C onnect i on C l ear ed ( EXT A)

  • Page 82: Cstaclearconnection - Trunk Call

    Section 470 - TSAPI Programmer’s Guide cstaClearConnection - trunk call TR K EXT A D R V A PP A t r unk cal l C STA C l earC onnect i on r el ease t r unk speakerof f C STA C onnect i on C l ear ed ( EXT A) C STA C al lC l ear ed C STA C l earC onnect i on C onf...

  • Page 83: Cstaconferencecall - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaConferenceCall - intercom call EXT A EXT B EXT C D R V A PP A A PP B A PP i nt er com cal l i nt er com cal l C STA C onf er ence C al l C STA C onf er ence C al lC onf C onf er enced C STA C onf er enced...

  • Page 84: Cstaconferencecall - Trunk & Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaConferenceCall - trunk & intercom call TR K EXT A EXT B D R V A PP A A PP B C O on hol d i nt er com cal l C STA C onf er ence C al l C STA C onf er ence C al lC onf C onf er enced C STA C onf er enced...

  • Page 85: Cstaholdcall - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaHoldCall - intercom call D RV A PP A A PP B EXT A EXT B i nt er com cal l C STA H ol d C al l C STA H ol d C al lC onf hol d ExtB C STA H ol d C al l hol d...

  • Page 86: Cstaholdcall - Trunk Call

    Section 470 - TSAPI Programmer’s Guide cstaHoldCall - trunk call TR K EXT A D RV A PP A co cal l C STA H ol d C al l C STA H ol d C al lC onf co hel d co puton hol d C STA H el d l i st eni ng t o D T...

  • Page 87: Cstamakecall - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaMakeCall - intercom call D R V A PP B A PP A EXT A EXT B C STA M ake C al l() C STA M ake C al lC onfEvent t ur n speakeron C STA Ser vi ce I ni t i at ed l i st en t o D T pr ocess di gi t s...

  • Page 88: Cstamakecall - Trunk Call

    Section 470 - TSAPI Programmer’s Guide cstaMakeCall - trunk call EXT A D RV A PP A C STA M ake C al l() C STA M ake C al lC onfEvent t ur n speakeron C STA Ser vi ce I ni t i at ed l i st en t o D T sei zed t r unk pr ocess di gi t s...

  • Page 89: Cstaretrievecall - Intercom Held

    Section 470 - TSAPI Programmer’s Guide cstaRetrieveCall - intercom held D RV A PP A A PP B EXT A EXT B i nt er com hel d C STA R et r i eve C al l C STA R et r i eve C al lC onf unhol d ExtB C STA R et r i eved unhol d ExtB...

  • Page 90: Cstaretrievecall - Co Held

    Section 470 - TSAPI Programmer’s Guide cstaRetrieveCall - CO held TR K EXT A D R V A PP A t r unk hel d C STA R et r i eve C al l() C STA R et r i eve C al lC onf unhol d t r unk unhol d t r unk C STA R et r i eved...

  • Page 91: Cstatransfercall - Intercom Call

    Section 470 - TSAPI Programmer’s Guide cstaTransferCall - intercom call EXT A EXT B EXT C D RV A PP A A PP B A PP C i nt er com hel d i nt er com cal l C STA Tr ansf erC al l C STA Tr ansf erC al lC onf t r ansf er r ed C STA Tr ansf er r ed...

  • Page 92: Cstatransfercall - Co Transfer To Extension

    Section 470 - TSAPI Programmer’s Guide cstaTransferCall - CO Transfer to Extension TR K EXT A EXT B D R V A PP A A PP B C O hel d i nt er com cal l C STA Tr ansf erC al l C STA Tr ansf erC al lC onf t r ansf er r ed C STA Tr ansf er r ed...

  • Page 93: Set Feature Service Group

    Section 470 - TSAPI Programmer’s Guide Set Feature Service Group cstaSet Do Not Disturb D R V A PP A EXT A C STA SetD o N otD i st ur b Ei t herSetorC l earD N D C STA D o N otD i st ur b C STA SetD o N otD i st ur b C onf DBS-92-470 Issued April 2000...

  • Page 94: Cstaset Forwarding

    Section 470 - TSAPI Programmer’s Guide cstaSet Forwarding APP A EXT A CSTA SetFor war di ng Ei t herSetorCl ear CSTA For war di ng Cal lFor war di ng CSTA SetFor war di ng Conf Issued April 2000 DBS-92-470...

  • Page 95: Cstaset Message Waiting Indication

    Section 470 - TSAPI Programmer’s Guide cstaSet Message Waiting Indication D RV A PP A EXT A C STA SetM W I C STA M sg W ai t i ng t ur n on/ of fM W Il am p C STA SetM W IC onf DBS-92-470 Issued April 2000...

  • Page 96: Query Service Group

    Section 470 - TSAPI Programmer’s Guide Query Service Group cstaQuery Do Not Disturb APP A EXTA CSTA Quer yDoNotDi st ur b CSTA Quer yDoNotDi s t ur bConf Issued April 2000 DBS-92-470...

  • Page 97: Cstaquery Forwarding

    Section 470 - TSAPI Programmer’s Guide cstaQuery Forwarding D R V A PP A EXT A C STA Q uer y For w ar di ng C STA Q uer y For w ar di ng C onf DBS-92-470 Issued April 2000...

  • Page 98: Cstaquery Message Waiting Indication

    Section 470 - TSAPI Programmer’s Guide cstaQuery Message Waiting Indication D R V A PP A EXT A C STA Q uer y M W I C STA Q uer y M W IC onf Issued April 2000 DBS-92-470...

  • Page 99: Cstaquery Last Number

    Section 470 - TSAPI Programmer’s Guide cstaQuery Last Number D R V A PP A EXT A C STA Q uer y LastN um ber C STA Q uer y LastN um berC onf DBS-92-470 Issued April 2000...

  • Page 100: Monitor Service Group

    Section 470 - TSAPI Programmer’s Guide Monitor Service Group cstaMonitor Device D R V A PP A EXT A C STA M oni t orD evi ce C STA M oni t orD evi ce C onf Issued April 2000 DBS-92-470...

  • Page 101: Chapter 11. Dbs System Features

    Section 470 - TSAPI Programmer’s Guide Chapter 11. DBS System Features Timing Diagrams The following illustrations depict event timing for common DBS system features. Busy Override EXT A EXT B EXT C D R V A PP A A PP B A PP C i nt er com cal l R BT orBT i nt er com cal l...

  • Page 102: Call Forward - Busy & Immediate

    Section 470 - TSAPI Programmer’s Guide Call Forward - Busy & Immediate EXT A EXT B EXT C D RV A PP A A PP B A PP C cal lExtB ExtB i s busy and has C STA Ser vi ce I ni t i at ed cal lf or w ar d busy t o ExtC St ar tr i ngi ng t o ExtC C STA D el i ver ed...

  • Page 103: Call Forwarding - No Answer

    Section 470 - TSAPI Programmer’s Guide Call Forwarding - No Answer DBS-92-470 Issued April 2000...

  • Page 104: Call Park

    Section 470 - TSAPI Programmer’s Guide Call Park Issued April 2000 DBS-92-470...

  • Page 105: Call Pickup

    Section 470 - TSAPI Programmer’s Guide Call Pickup DBS-92-470 Issued April 2000...

  • Page 106: Call Waiting

    Section 470 - TSAPI Programmer’s Guide Call Waiting D RV A PP A A PP B EXT A EXT B BT Ext A- - >Ext B act i vat ed C al lW ai t i ng C STA C onnect i on C l ear ed C STA C al lC l ear ed C STA Ser vi ce I ni t i at ed C STA D el i ver ed...

  • Page 107: Camp-On

    Section 470 - TSAPI Programmer’s Guide Camp-On D RV A PP A A PP B EXT A EXT B BT Ext A- - >Ext B act i vat ed C am p- O n C STA C onnect ed C l ear ed C STA C al lC l ear C STA Ser vi ce I ni t i at ed C STA D el i ver ed...

  • Page 108: 3-Way Conference

    Section 470 - TSAPI Programmer’s Guide 3-Way Conference Issued April 2000 DBS-92-470...

  • Page 109: Hold Intercom

    Section 470 - TSAPI Programmer’s Guide Hold Intercom DBS-92-470 Issued April 2000...

  • Page 110: Hold Co

    Section 470 - TSAPI Programmer’s Guide Hold CO D R V A PP A EXTA C O cal l putcal lon hol d C STA H el d l i st eni ng t o D T C STA Ser vi ce I ni t i at ed Issued April 2000 DBS-92-470...

  • Page 111: Intercom Call

    Section 470 - TSAPI Programmer’s Guide Intercom Call D R V A PP A A PP B EXT A EXT B go of f - hook C STA Ser vi ce I ni t i at ed di alExtB C STA D el i ver ed phone r i ngi ng C STA D el i ver ed DBS-92-470...

  • Page 112: Off-Hook Voice Announce

    Section 470 - TSAPI Programmer’s Guide Off-Hook Voice Announce Issued April 2000 DBS-92-470...

  • Page 113: Paging/Meet Me Answer

    Section 470 - TSAPI Programmer’s Guide Paging/Meet Me Answer D R V A PP A A PP B EXT A EXT B go of f - hook & C STA Ser vi ce I ni t i at ed m ake page go of f - hook C STA Ser vi ce I ni t i at ed i nvoke m eet - m e answ er...

  • Page 114: Transfer - Supervised

    Section 470 - TSAPI Programmer’s Guide Transfer - Supervised Issued April 2000 DBS-92-470...

  • Page 115: Transfer - Unsupervised

    Section 470 - TSAPI Programmer’s Guide Transfer - Unsupervised DBS-92-470 Issued April 2000...

  • Page 116: Trunk Queuing

    Section 470 - TSAPI Programmer’s Guide Trunk Queuing C O 1 EXT A D R V A PP A co busy go of f - hook/ C STA Ser vi ce I ni t i at ed l i st en t o di al t one di alC O 1 &...

  • Page 117: Additional Dbs Feature Handling

    Section 470 - TSAPI Programmer’s Guide Additional DBS Feature Handling Absence Message An extension calling another extension with an absence message set will receive a CSTAFailed event. Account Codes Non-verified account codes are supported via CSTAMakeCall request, using "A" for the auto key.

  • Page 118: Delayed Ringing

    Section 470 - TSAPI Programmer’s Guide Delayed Ringing When the extension begins alerting, the same events are sent as if the extension had started alerting immediately. Dial "0" for Attendant The same events are sent as in the intercom call. Dialtone Disabled Doesn't affect the CSTA events for that extension.

  • Page 119: Handsfree Operation

    Section 470 - TSAPI Programmer’s Guide Handsfree Operation Uses the speaker to answer/drop calls. The speaker is used by CSTAMakeCall, CSTAAnswerCall, and CSTARetrieveCall request. Therefore, a speakerphone is necessary for a TSAPI client. Hot Dial Pad Calls initiated via a hot dial pad will send the same events as an intercom/trunk call. Internal Hold Tone Internal hold tone, if administered, will be applied to a trunk put on hold via a CSTAHoldCall request.

  • Page 120: One Touch Vm Access

    Section 470 - TSAPI Programmer’s Guide One Touch VM Access Upon pressing the Voice Mail Access key, a CSTAService Initiated Event will be sent, followed by a CSTADelivered Event. Paging A page can be made via CSTAMakeCall request with "#<pagegroup>" as the dialed digits. Pooled Trunk Access Pooled trunk access can be used via CSTAMakeCall request with the dialed digits "9"...

  • Page 121: Station Class Of Service

    Section 470 - TSAPI Programmer’s Guide Station Class of Service Class Of Service (COS) will be checked where appropriate. Station Hunting Any hunt group call received by a TSAPI client extension will receive CSTA events for the hunt group call. Station Lockout Station Lockout can be activated/deactivated via a CSTAMakeCall request.
  • Page 122 Section 470 - TSAPI Programmer’s Guide Issued April 2000 DBS-92-470...
  • Page 123 Index Connection Cleared Event ... . . 28 Connection Cleared Event Report ..37 Absence Message ....109 CSTA (overview).
  • Page 124 Section 470 - TSAPI Programmer’s Guide CSTARetrieveCallConfEvent... 12 Handsfree Operation ....111 CSTAServiceInitiatedEvent ... . 34 Held Event .
  • Page 125 Section 470 - TSAPI Programmer’s Guide SDL Connector ..... 56 SDL symbols ..... . . 54 Off-Hook Voice Announce.
  • Page 126 Section 470 - TSAPI Programmer’s Guide Issued April 2000 DBS-92-470...

Table of Contents