Panasonic DBS Section 470 Guide

Section 470 - TSAPI Programmer’s Guide

The contents of this document are subject to change without notice and do not constitute a
commitment on the part of Panasonic Telecommunication Systems Company (PTSC). Every
effort has been made to ensure the accuracy of this document. 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 pertaining to said software or hardware.

Copyright 2000 by Panasonic Telecommunication Systems Company



ii Issued April 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

Contents

Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Panasonic DBS TSAPI Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Supported CSTA Service Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2. Call-Control Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Functional Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Answer Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Clear Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Clear Connection Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Conference Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Hold Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Make Call 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 5. Monitor Service Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Monitor Device Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Monitor Ended Event Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Monitor Stop Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Chapter 6. Event Report Service Group . . . . . . . . . . . . . . . . . . . . . . . . 25

DBS-92-470 Issued April 2000 iii

Section 470 - TSAPI Programmer’s Guide

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Call Cleared Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Conferenced Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Connection Cleared Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Delivered Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Diverted Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Established Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Failed Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Held Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Network Reached Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Retrieved Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Service Initiated Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Transferred Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Chapter 7. Driver Application Interface Events . . . . . . . . . . . . . . . . . . 36

Call Cleared Event Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Conferenced Event Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Connection Cleared Event Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Delivered Event 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 Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Hold Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Make Call Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Retrieve Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Transfer Call Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Set Do Not Disturb Feature Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Set Forwarding Feature Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Set Message Waiting Indicator Feature Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Monitor Calls via Device and Monitor Device Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Monitor Stop Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

iv Issued April 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

Query Do Not Disturb Feature Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Query Forwarding Feature Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Query Message Waiting Indicator Feature Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Query Last Number Dialed Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapter 9. Callflow Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Null . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Inbound Call to Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Pending . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Received . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Call Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Outbound Station Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

On-hook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Established . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Delivered. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Hold and Retrieve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Conference and Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Chapter 10. CSTA Timing Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Call Control 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 call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

cstaRetrieveCall - intercom held. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

cstaRetrieveCall - CO held . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

cstaTransferCall - intercom call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

cstaTransferCall - CO Transfer to Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Set Feature Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

cstaSet Do Not Disturb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

cstaSet Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

cstaSet Message Waiting Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Query Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

cstaQuery Do Not Disturb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

DBS-92-470 Issued April 2000 v

Section 470 - TSAPI Programmer’s Guide

cstaQuery Forwarding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

cstaQuery Message Waiting Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

cstaQuery Last Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Monitor Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

cstaMonitor Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Chapter 11. DBS System Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Timing Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Busy Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Call Forward - Busy & Immediate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Call Forwarding - No Answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Call Park . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Call Pickup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Call Waiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Camp-On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

3-Way Conference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

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 Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Delayed Ringing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Dial "0" for Attendant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Dialtone Disabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Direct Trunk Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

DID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

DISA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Do Not Disturb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

EM/24 Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

FF-Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Handsfree Answerback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Handsfree Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

vi Issued April 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

Hot Dial Pad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Internal Hold Tone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Key Bank Hold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Last Number Redial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

LCR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Line Appearances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

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

DBS-92-470 Issued April 2000 vii

Section 470 - TSAPI Programmer’s Guide

viii Issued April 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

Chapter 1. Introduction

The intent of this document is to provide in-depth information on Panadrvr™, the
Panasonic© PBX Driver Netware Loadable Module (NLM) designed to communicate with
the Novell Tserver NLM. This information will allow TSAPI application developers to
design customized applications for interfacing Panasonic DBS telephone systems with the
Novell Netware® Telephony Services environment.

Users of this manual should have a working knowledge of CSTA architecture and services
and with the Panasonic DBS telephone system. The following documents may be of
assistance.

• Standard ECMA-179 Services for Computer-Supported Telecommunications
Applications (CSTA)
European Computer Manufacturer’s Association, June 1992

• Standard ECMA-180 Protocol for Computer-Supported Telecommunications
Applications (CSTA)
European Computer Manufacturer’s Association, June 1992

• Computer-Supported Telecommunications Applications ECMA TR/52, European
Computer Manufacturer’s Association, June 1990

• Novell Netware® Telephony Services: PBX Driver Interface Specification

• Panasonic DBS Section 520: DBS Telephony Services Installation and Feature
Description

• Panasonic DBS Section 300: 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 based on
the caller’s ANI, while automatically displaying the caller’s account record or customer pro­file on the agent’s computer screen. On the other hand, the switch network can use a database
management system to automatically dial a telephone number associated with an account
record. For this to occur, both the computer network and the switch network must use a com­mon protocol to communicate with each other. 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:

• Receives CSTA telephony requests from the Tserver NLM and translates them into DBS­specific protocol requests before sending them on to the DBS.

• Communicates with the DBS via a serial link to the Panasonic API card.

• Receives requests, responses, and events from the DBS and translates them into the
appropriate CSTA messages before sending on to the Tserver NLM.

DBS-92-470 Issued April 2000 1

• 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

Section 470 - TSAPI Programmer’s Guide

Call Control Service
Group

Set Feature Service
Group

Query Service
Group

Monitor Service
Group

Event Report
Service Group

These service groups are described in detail on the following pages.

enables a telephony client application to control a call or
connection on the DBS.

allows a client application to set switch-controlled features and
parameters on a DBS device.

allows a client application to query the switch for device features
and static attributes of a device.

allows a client application to request and cancel the reporting of
state-changing events.

provides a client application with reports of state-changing
events to a call, a connection, or a device.

2 Issued April 2000 DBS-92-470

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. Panadrvr Release 1.0 supports the following Call-Control
Services:

• Answer Call Service

• Clear Call Service

• Clear Connection Service

• Conference Call Service

• Hold Call Service

• Make Call Service

• Retrieve Call Service

• Transfer Call Service

The following Call-Control Services are

• 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 and C1, C2, and C3 represent callIDs.

• Lines represent connections between a call and a device and C1-D1, C1-D2, C2-D3, etc.
represent connectionIDs.

• Absence of a line is equivalent to a connection in the Null connection state.

• Labels in boxes and circles represent call and device instances.

• Labels on lines represent a connection state using the following key:

a = Alerting
c = Connected
f = Failed
h = Held
i = Initiated
q = Queued
a/h = Alerting or Held

supported by Panadrvr Release 1.0.

not

DBS-92-470 Issued April 2000 3

* = 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.

• The parameters for the function call of the service are indicated in bold italics.

Answer Call Service

The Answer Call Service is used when an incoming call (C1) is alerting (ringing) a device

(D1) with the connection alertingCall (C1-D1). The effect is the same as if the answering

party answered the call via the telephone on/off button.

Section 470 - TSAPI Programmer’s Guide

Function:
Direction: C → S
Functional Descripti on:

The Answer Call Service allows a client application to request that a call ringing at a sta­tion be answered. Answering a ringing call means to connect a call if the user is on-hook
by forcing the station off-hook, or, if the user is off-hook, by cutting through the call to the
headset or handset. An active call 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 Answer Call Service request is acknowledged (Ack) by the switch if the switch is able
to connect the specified call either by forcing the station off-hook (i.e., turning the speak­erphone on) or by taking the appropriate action required to handle an existing call.
Answering a call which is already connected will result in a positive acknowledgment and
the call will remain connected.

Service Parameters:

alertingCall [mandatory] a valid connection identifier indicates the callID

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

cstaAnswerCall( ), CSTAAnswerCallConfEvent

and the station extension (STATIC_ID).

• INVALID_CSTA_CONNECTION_IDENTIFIER (13)

An incorrect callID, or an incorrect deviceID is specified.

• INVALID_OBJECT_STATE (22)

The specified connection at the station is not in the alerting or connected.

4 Issued April 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

• NO_CALL_TO_ANSWER (28)

The specified connection at the station is not alerting.

• MISTYPED_ARGUMENT_REJECTION (74)

DYNAMIC_ID is specified in alertingCall.

• 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)

An internal driver error has occurred.

Notes:

• If the station user is on-hook idle, the switch will turn on the speaker/headset and

answer the call.

• If the station user is busy on a call, the current call with either be put on hold or

dropped depending on the “key-bank-hold” option setting.

Clear Call Service

This service will cause each device 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:
Direction: C → S
Functional Descripti on:

The Clear Call Service disconnects all connections from the specified call and terminates
the call itself. 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; however in some cases (e.g., the
extension is physically off-hook), the call will not be cleared even though a positive con­firmation is returned to the application.

cstaClearCall(), CSTAClearCallConfEvent

DBS-92-470 Issued April 2000 5

Section 470 - TSAPI Programmer’s Guide

Service Parameters:

call [mandatory] a valid connection identifier indicates the call to

be cleared. The deviceID of call is optional. If it is specified, it

is ignored.

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

• NO_ACTIVE_CALL (24)

The callID of the connectionID specified in the request is invalid.∙

• RESOURCE_OUT_OF_SERVICE (34)

The DBS is off-line.∙

• OUTSTANDING_REQUEST_LIMIT_EXCEEDED (44)

The application has too many outstanding CSTA requests.

• INVALID_OBJECT_STATE (22)

1. One of the connections in the call has a call on hold.

2. One on the connections in the call is being alerted by another monitored extension.

Notes:

•

Switch operation

• Every station dropped will be in the on-hook idle state.

• Any lamps associated with the call are off.

• Displays are cleared.

- After a successful Clear Call Service request:

Clear Connection Service

This service releases the specified connection, call (C1-D3), and its connectionID from the

specified call (C1). The result is the same as if the user pressed the extension’s on/off button
during a hands-free conversation. The Clear Connection Service cannot be used if the exten­sion is physically off-hook.

Function:
Direction: C → S
Private Parameters:
Functional Descripti on:

The Clear Connection Service disconnects the specified device from the designated call.

6 Issued April 2000 DBS-92-470

cstaClearConnection(), CSTAClearConnectionConfEvent

userInfo

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:

call [mandatory] a valid connection identifier indicates the

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

• INVALID_OBJECT_STATE (22)

The specified connection at the station is not currently active (in alerting or held state)
so it cannot be dropped or the station user is off-hook.

• NO_ACTIVE_CALL (24)

The connectionID contained in the request is invalid. CallID may be incorrect.

• NO_CONNECTION_TO_CLEAR (27)

The connectionID contained in the request is invalid. CallID may be correct, but devi­ceID is wrong.

endpoint to be disconnected.

• 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

three or more parties (directly connected to the switch), the other parties remain on
the call. If this was a two-party call, the non-dropped party is listening to busytone.

Only connected parties can be dropped from a call. Held and alerting parties cannot
be dropped by the Clear Connection Service.

Conference Call Service

- When a party is dropped from an existing conference call with

This service provides the conference of an existing heldCall (C1-D1), and another activeCall

(C2-D1) at the same device. The two calls are merged into a single call, (C3) and the two
connections (C1-D1, C2-D1) at the conferencing device (D1) are resolved into a single con-

nection, newCall (C3-D1), in the Connected state.

DBS-92-470 Issued April 2000 7

Section 470 - TSAPI Programmer’s Guide

Function:
Direction: C → S
Functional Descripti on:

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. The pre-existing CSTA connectionID associated with the
device creating the conference are released, and a new callID for the resulting conferenced
call is provided.

Service Parameters:

heldCall [mandatory] must be a valid connection identifier for the call

activeCall [mandatory] must be a valid connection identifier for the call

Ack Parameters:

newCall [mandatory - partially supported] a connection identifier

connList [optional - supported] specifies the devices on the resulting

Nak Parameter:

universalFailure

cstaConferenceCall(), CSTAConf erenceCallConfEvent

which is on hold at the controlling device and is to be

conferenced with the activeCall. The deviceID in heldCall

must contain the station extension of the controlling device.

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.

specifies the resulting new call identifier for the calls which
were conferenced at the conference controlling device. This
connection identifier replaces the two previous call identifiers
at that device.

newCall. This includes a count of the number of devices in the
new call and a list of up to four connectionIDs and up to four
deviceIDs which define each connection in the call.

• If a device is on the DBS, the extension is specified.

• If a party is off the DBS, then its assigned dynamic trunk
identifier is specified.

• INVALID_CSTA_CONNECTION_IDENTIFIER (13)

The controlling deviceID in heldCall or activeCall has not been specified correctly.

• REQUEST_INCOMPATIBLE_WITH_OBJECT (2)
The active call is alerting.

• NO_HELD_CALL (25)
The held call parameter is incorrect.

8 Issued April 2000 DBS-92-470

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:

• The active call must be in the connected state.

• A maximum of 4 parties can be conferenced.

Hold Call Service

The Hold Call Service places a call (C1) at a device (D1) with the connection activeCall (C1-

D1) on hold. The effect is as if the specified party depressed the hold button on the device.
This service maintains a relationship between the holding device (D1) and the held call (C1)
that lasts until the call is retrieved from the hold status, or until the call is cleared.

Function:
Direction: C → S
Functional Descripti on:

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

reservation [optional - not supported] specifies whether reserves the

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

cstaHoldCall( ), CSTAHoldCallConfEvent

connection to be placed on hold. This party must be in the
active (talking) state or already held. The device associated

with the activeCall must be a station. If the party specified in

the request refers to a trunk device, the request will be denied.

The deviceID in activeCall must contain the station extension

of the controlling device.

facility for reuse by the held call. The DBS switch does
support this parameter.

not

• INVALID_CSTA_DEVICE_IDENTIFIER (12)

An invalid device identifier or extension is specified in activeCall.

DBS-92-470 Issued April 2000 9

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.

• 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:

•

Held State

receives the request, a positive request acknowledgment is returned.

•

Music on Hold

trunk party placed on hold from the other end either manually or via the Hold Call
Service.

•

Internal hold tones

party placed on hold from the other end either manually or via the Hold Call Service.

•

Switch Operation

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 two devices designated by the application.

When the service is initiated, a call to the calledDevice (D2) is originated. A call is estab­lished as if D1 had called D2, and the client is returned with the connection newCall (C1-

D1).

- If the party is already on hold on the specified call when the switch

- Music on Hold (if administered and available) will be given to a

- Internal hold tones (if administered) will be given to a trunk

- After a party is placed on hold through a Hold Call Service

Function:
Direction: C → S
Private Parameters:
Functional Descripti on:

The Make Call Service originates a call between two devices. The service attempts to cre-

ate a new call and establish a connection with the originating device (callingDevice). The
Make Call Service also provides a connection identifier (newCall) that indicates the con-
nection of the originating device in the CSTAMakeCallConfEvent.

10 Issued Apri l 2000 DBS-92-470

cstaMakeCall(), CSTAMakeCallConfEvent

destRoute, userInfo

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. The only call progress feedback that is reported as an event to the applica-

tion via Monitor Services is Networked Reached.

For the originator to place the call, the callingDevice (digital extension) must have an

available appearance for call origination and must not be in the talking (active) state on
any appearances. The originator is allowed to have a call(s) on hold or alerting at the
device.

The originator may go off-hook or turn the speaker on and receive dial tone first, then
issue the Make Call Service request for that station. The switch will originate the call on
the same callID to establish the call.

If the originator is off-hook busy, the call can not be placed 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

Ack Parameters:

newCall [mandatory] a connection identifier indicates the connection

Nak Parameter:

A MakeCall request will be denied if the request fails before the call is attempted by the
DBS:

number. as if they were entered from the telephone using the
key pad.

between the originating device and the call. The newCall

parameter contains the callID of the call and the station

extension of the callingDevice.

universalFailure

• INVALID_CALLING_DEVICE (5)

The callingDevice is out of service or invalid.

• INVALID_CALLED_DEVICE (6)

The calledDevice number is too long or contains an illegal digit.

• REQUEST_INCOMPATABLE_WITH_OBJECT (2)

The callingDevice is not monitored.

• INVALID_OBJECT_STATE (22)

The callingDevice is not in a legal state for makecall.

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

DBS-92-470 Issued April 2000 11

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”.

• Direct Trunk Access - A trunk can be directly accessed via a CSTAMakeCall request,
with the dialed digits containing “88XX”.

• Forced Entry Account Codes - Non-verified account codes are supported via a CSTA­MakeCall request, using “A” for the auto key. Verified account codes are supported
via a CSTAMakeCall request.

• Called Destination - if the called device is a DBS station extension, the user at the sta­tion will receive alerting tones. The calling station user will hear dialtone but no
touchtones.

• Call Forwarding Immediate - No CSTA events will be delivered to an extension
which is call forwarded immediately.

• Display - 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 - if the digits dialed result in listening to busy tone, the busy tone
will last until the user hangs up via the handset and/or speakerphone or CSTA Clear
Call or CSTA Clear Connection services.

• Make Tone Call - CSTAMakeCall request with digits plus “1” if switch is set to voice
call default.

• Make Voice Call - CSTA Make Call request with digits plus “1” if switch is set to
tone call default.

• Make Page Call - CSTA Make Call request with “#”<page group>

Retrieve Call Servic e

This service restores a held connection heldCall (C1-D1) to the Connected state (active).

Function:
Direction: C → S
Functional Descripti on:

The Retrieve Call Service connects an on-DBS held connection.

12 Issued Apri l 2000 DBS-92-470

cstaRetrieveCall(), CSTARetrieveCallConfEvent

Section 470 - TSAPI Programmer’s Guide

Service Parameters:

heldCall [mandatory] a valid connection identifier indicates the

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

• INVALID_CSTA_CONNECTION_IDENTIFIER (13)
The connectionID contained in the request is invalid.

• NO_ACTIVE_CALL (24)
The specified call at the station is cleared so it cannot be retrieved.

• NO_HELD_CALL (25)
The specified connection at the station is not in the held state (e.g., alerting state) so it
cannot be retrieved.

• RESOURCE_OUT_OF_SERVICE (34)
The DBS is not on-line.

• OUTSTANDING_REQUEST_LIMIT_EXCEEDED (44)
The application has a pending CSTA request.

endpoint to be connected. The deviceID in heldCall must

contain the station extension of the endpoint.

• 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 heldCall (C1-D1) with an activeCall (C2-D1) at the

same device (D1). The transfer service merges two calls (C1, C2) with connections (C3-D2,
C3-D3) at a single common device (D1) into one call (C3). Also, both of the connections to
the common device become Null and their connectionIDs are released. When the transfer

completes, the common device (D1) is released from the calls (C1, C2). A callID, newCall

(C3), that specifies the resulting new call for the transferred call is provided.

DBS-92-470 Issued April 2000 13

Section 470 - TSAPI Programmer’s Guide

Function:
Direction: C → S
Functional Descripti on:

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. Also, both of
the connections to the common device become Null and their connectionIDs are released.
A connectionID that specifies the resulting new connection for the transferred call is pro­vided.

Service Parameters:

heldCall [mandatory] must be a valid connection identifier for the call

activeCall [mandatory] must be a valid connection identifier of an active

Ack Parameters:

newCall [mandatory] a connection identifier that specifies the resulting
connList [optional - supported] specifies the devices on the resulting

cstaTransferCall(), CSTATransferCallConfEvent

which is on hold at the controlling device and is to be

transferred to the activeCall. The deviceID in heldCall must

contain the station extension of the controlling device of the
controlling device.

or proceeding call at the controlling device to which the

heldCall is to be transferred. The deviceID in activeCall must

contain the station extension of the controlling device.

new call identifier for the transferred call.

newCall. This includes a count of the number of devices in the
new call and a list of up to four connectionIDs and up to four
deviceIDs which define each connection in the call.

•If a device is on-DBS, the extension is specified.

•If a party is off-DBS, then its assigned trunk identifier is spec­ified except if Caller ID digits are available.

Nak Parameter:

universalFailure

• INVALID_CSTA_DEVICE_IDENTIFIER (12)

An invalid device identifier or extension is specified in heldCall or activeCall.

• INVALID_CSTA_CONNECTION_IDENTIFIER (13)

The controlling deviceID in activeCall or heldCall has not been specified correctly.

• NO_HELD_CALL (25))
The held call parameter is incorrect.

• NO_ACTIVE_CALL (24)
The active call parameter is incorrect.

• MISTYPED_ARGUMENT_REJECTION (74)

DYNAMIC_ID is specified in heldCall or activeCall.

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

14 Issued Apri l 2000 DBS-92-470

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).

DBS-92-470 Issued April 2000 15

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

• Set Forwarding Feature Service

• Set Message Waiting Indicator Feature Service

Set Do Not Disturb Feature Service

Function:
Direction: C → S
Functional Descripti on:

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)

• RESOURCE_OUT_OF_SERVICE (34)

• OUTSTANDING_REQUEST_LIMIT_EXCEEDED (44)

• GENERIC_SUBSCRIBED_RESOURCE_AVAILABILITY (41)

• GENERIC_UNSPECIFIED (0)

cstaSetDoNotDisturb( ), CSTASetDndConfEvent

An invalid device identifier has been specified in device.

The DBS is off-line.

The application has too many outstanding CSTA requests.

The user does not have the permissions to set DND.

Internal driver error.

Notes:

• COS - the user must have a COS that given them the ability to set DND.

16 Issued Apri l 2000 DBS-92-470

Section 470 - TSAPI Programmer’s Guide

Set Forwarding Feature Service

Function:
Direction: C → S
Functional Descripti on:

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.

Service Parameters:

device [mandatory] specifies the station on which the Call Forwarding
forwardingType [mandatory - partial] specifies the type of forwarding to set or
forwardingOn [mandatory] specifies either on (TRUE) or off (FALSE).

forwardingDN [mandatory] specifies the station extension or off premise

Ack Parameters:

noData None for this service.

Nak Parameter:

universalFailure

• INVALID_CSTA_DEVICE_IDENTIFIER (12)

• RESOURCE_OUT_OF_SERVICE (34)

cstaSetForwarding( ), CSTASetFwdConfEvent

feature is to be set. It must be a valid DBS extension.

clear.

destination to which the calls are to be forwarded. It is
mandatory if forwardingOn is set to on. It is ignored if the
forwardingOn is set to off.

An invalid device identifier has been specified in device.

The DBS is off-line.

• OUTSTANDING_REQUEST_LIMIT_EXCEEDED (44)
The application has too many outstanding CSTA requests.

• GENERIC_UNSPECIFIED (0)
Internal driver error.

• GENERIC_OPERATION (1)
An unsupported call forward type was specified.

Notes:

• COS - the user must have a COS that given them the ability to set DND.

Set Message Waiting Indicator Feature Service

Function:
Direction: C → S
Functional Descripti on:

This service sets on or off the DBS message waiting indicator (MWI) for a user station.

Service Parameters:

device [mandatory] must be a valid DBS extension that supports the
messages [mandatory] specifies either on (TRUE) or off (FALSE).

Ack Parameters:

noData None for this service.

Nak Parameter:

cstaSetMsgWaitingInd( ), CSTASetMwiConfEvent

MWI feature.

DBS-92-470 Issued April 2000 17

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 off-line.

• OUTSTANDING_REQUEST_LIMIT_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 by the driver.

Notes:

• Extension must be installed.

18 Issued Apri l 2000 DBS-92-470

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:

• Query Do Not Disturb Service

• Query Forwarding Service

• Query Message Waiting Service

• Query Last Number

The following Query Services are

• Query Agent State Service

• Query Device Info

not

Query Do Not Disturb Service

Function:
Direction: C → S
Functional Descripti on:

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

Ack Parameters:

doNotDisturb [mandatory] Status of the do not disturb feature expressed as

Nak Parameter:

universalFailure

• RESOURCE_OUT_OF_SERVICE (34)

cstaQueryDoNotDisturb( ), CSTAQueryDoNotDisturbConfEvent

supports the do not disturb feature.

on or off.

The DBS is not on-line.

supported by Panadrvr Release 1.0.

• OUTSTANDING_REQUEST_LIMIT_EXCEEDED (44)
The application has a pending CSTA request.

• GENERIC_UNSPECIFIED (0)
Internal driver error.

• INVALID_CSTA_DEVICE_IDENTIFIER (12)

AN invalid device identifier has been specified in device.

DBS-92-470 Issued April 2000 19

Query Forwarding Service

Function: cstaQueryForwarding (), CSTAQueryForwardingConfEvent
Direction: C → S
Functional Descripti on:

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. Call forward no answer, call forward
busy and call forward immediate are expressed as their CSTA values, call forward busy/no
answer is expressed as CSTA call forward no answer.

Service Parameters:

device [mandatory] must be a valid DBS station extension that

Ack Parameters:

forward [mandatory] This is a list of forwarding parameters. The list

Section 470 - TSAPI Programmer’s Guide

supports the Call Forwarding feature.

contains a count of how many items are in the list. Since the
DBS switch stores only one forwarding address, 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 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.

Query Message Waiting Service

Function: cstaQueryMsgWaitingInd(), CSTAQueryMwiConfEvent
Direction: C → S
Private Ack Parameters: applicationType
Functional Descripti on:

The Query Message Waiting Service provides status of the message waiting indicator
expressed as on or off for a device.

Service Parameters:

device [mandatory] must be a valid DBS station extension that

supports the MWI feature.

Ack Parameters:

messages [mandatory] Indicates the on/off status of the message waiting

indicator for this device.

Nak Parameter:

20 Issued Apri l 2000 DBS-92-470

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.

Notes:

The DBS requires the driver to specify not only which extension’s message waiting indicator
to activate, but also the extension number (e.g., voice mail) that is activating the indicator. In
future releases, applications will inform the driver of the activator’s id in private data;
however in Release 1.0 the extension value must be specified when 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 Descripti on:

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.

Service Parameters:

device [mandatory] must be a valid DBS station extension.

Ack Parameters:

forward [mandatory] This is the value held within the DBS’s last

number dialed buffer. Note: This may be a NULL entry.

Nak Parameter:

universalFailure

• 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

• INVALID_CSTA_DEVICE_IDENTIFIER (12)

An invalid device identifier has been specified in device.

DBS-92-470 Issued April 2000 21

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

• Monitor Stop Service

• Monitor Ended Event

• Change Monitor Filter Service

The following Monitor Services are

• Monitor Call Service

• Monitor Calls Via Device Service

Monitor Device Service

Function: cstaMonitorDevice(), CSTAMonitorConfEvent
Direction: C → S
Functional Descripti on:

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
monitorFilter [optional - not supported] specifies the filters to be used with

Ack Parameters:

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

monitorFilter [optional - not supported] specifies the event reports that are to

supported by Panadrvr Release 1.0.

not

devices are not supported in release 1.0.

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

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.

be filtered out on the object being monitored by the

application. This may not be the monitorFilter specified in the

22 Issued Apri l 2000 DBS-92-470