DEC CIT Applications Interface for VMS Programming Reference

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  How to Use This Manual

  Audience

  Changes to the Applications Interface for V3.0

  Document Structure

  Associated Documentation

  Conventions

  Part I

  1      DEC CIT Routine Specifications

  CIT$ANSWER_CALL (PBX and Voice)

  CIT$ASSIGN (PBX and Voice)

  CIT$CANCEL_CALL (PBX Only)

  CIT$CONFERENCE_JOIN (PBX only)

  CIT$CONVERT (Voice only)

  CIT$CREATE_CONTEXT (Voice only)

  CIT$CREATE_PCM_MESSAGE (Voice only)

  CIT$CREATE_TEXT_MESSAGE (Voice only)

  CIT$DEASSIGN (PBX and Voice)

  CIT$DEFLECT_CALL (PBX only)

  CIT$FREE_CONTEXT (Voice only)

  CIT$FREE_MESSAGE (Voice only)

  CIT$GET_CHANNEL_INFORMATION (PBX only)

  CIT$GET_CONTEXT_INFORMATION (Voice only)

  CIT$GET_DEVICE_ATTRIBUTES (PBX only)

  CIT$GET_DTMF_KEY (Voice only)

  CIT$GET_EVENT (PBX and Voice)

  CIT$GET_MESSAGE_INFORMATION (Voice only)

  CIT$GET_ROUTE_QUERY(PBX Only)

  CIT$GO_OFFHOOK (Voice only)

  CIT$HANGUP_CALL (PBX and Voice)

  CIT$INITIATE_CONFERENCE_CALL (PBX only)

  CIT$INITIATE_TRANSFER_CALL (PBX only)

  CIT$LOAD_DATA (Voice only)

  CIT$MAKE_CALL (PBX and Voice)

  CIT$MAKE_DTMF (Voice only)

  CIT$MAKE_PREDICTIVE_CALL (PBX Only)

  CIT$MAKE_TONE (Voice only)

  CIT$MAP_MESSAGE (Voice only)

  CIT$PICKUP_CALL (PBX only)

  CIT$PLAY (Voice only)

  CIT$PLAY_END (Voice only)

  CIT$PLAY_PAUSE (Voice only)

  CIT$PLAY_RESUME (Voice only)

  CIT$POSITION (Voice only)

  CIT$RECOGNIZE (Voice only)

  CIT$RECORD (Voice only)

  CIT$RECORD_END (Voice only)

  CIT$RECORD_PAUSE (Voice only)

  CIT$RECORD_RESUME (Voice only)

  CIT$RESPOND_TO_INACTIVE_CALL (PBX only)

  CIT$RESPOND_TO_ROUTE_QUERY (PBX Only)

  CIT$RESUME_CALL (PBX only)

  CIT$RETRIEVE_HELD (PBX only)

  CIT$SET_DEVICE_ATTRIBUTES (PBX and Voice)

  CIT$SPEAK_STRING (Voice only)

  CIT$SUSPEND_CALL (PBX only)

  CIT$SWAP_WITH_HELD (PBX only)

  CIT$TRANSFER_CALL (PBX only)

  CIT$UNLOAD_DATA (Voice only)

  2      Condition Values Returned

  Part II

  A   Features Common to All CIT Protocol/PBX Links

  A.1     Standard CIT Functions
    A.1.1      DNs and PLIDs
    A.1.2      Monitoring

  B   Features Specific to the CSTA Protocol

  B.1     CIT Functions Supported by CSTA

  B.2     How CIT Routines Work with CSTA

  CIT$ASSIGN

  CIT$GET_CHANNEL_INFORMATION

  CIT$GET_DEVICE_ATTRIBUTES

  CIT$GET_EVENT

  CIT$SET_DEVICE_ATTRIBUTES

  B.3     Condition Values Returned

  C   Features Specific to AT&T DEFINITY GENERIC 1 PBXs

  C.1     CIT Functions Supported by the DEFINITY G1 PBXs

  C.2     How CIT Routines Work with DEFINITY G1 PBXs

  CIT$ASSIGN

  CIT$CANCEL_CALL

  CIT$GET_CHANNEL_INFORMATION

  CIT$GET_DEVICE_ATTRIBUTES

  CIT$GET_EVENT

  CIT$GET_ROUTE_QUERY

  CIT$MAKE_CALL

  CIT$MAKE_PREDICTIVE_CALL

  CIT$RESPOND_TO_ROUTE_QUERY

  CIT$RESUME_CALL

  CIT_SET_DEVICE_ATTRIBUTES

  D   Features Specific to the HCI Links

  D.1     CIT Functions Supported by the HCI PBXs

  D.2     PLID and HCI

  D.3     How CIT Routines Work with HCI PBXs

  CIT$CONFERENCE_JOIN

  CIT$GET_CHANNEL_INFORMATION

  CIT$GET_DEVICE_ATTRIBUTES

  CIT$GET_EVENT

  CIT$HANGUP_CALL

  CIT$PICKUP_CALL

  CIT$SET_DEVICE_ATTRIBUTES

  CIT$SWAP_WITH_HELD

  CIT$TRANSFER_CALL

  E   Features Specific to Siemens HICOM PBXs

  E.1     CIT Functions Supported by the HICOM PBXs

  E.2     Standard Telephones (500 and 2500 Sets)
    E.2.1      Call Reference ID
    E.2.2      Consultation Calls-Conference and Transfer

  E.3     How CIT Routines Work with HICOM PBXs

  CIT$CANCEL_CALL

  CIT$CONFERENCE_JOIN

  CIT$DEFLECT_CALL

  CIT$GET_CHANNEL_INFORMATION

  CIT$GET_DEVICE_ATTRIBUTES

  CIT$GET_EVENT

  CIT$INITIATE_CONFERENCE_CALL

  CIT$INITIATE_TRANSFER_CALL

  CIT$MAKE_CALL

  CIT$PICKUP_CALL

  CIT$RETRIEVE_HELD

  CIT$SET_DEVICE_ATTRIBUTES

  CIT$SWAP_WITH_HELD

  CIT$TRANSFER_CALL

  F   Features Specific to the Northern Telecom Meridian 1 PBX

  F.1     CIT Functions Specific to the Meridian 1 Link

  F.2     Meridian 1 Concepts and Terminology
    F.2.1      Assigning a Channel
    F.2.2      Standard Telephones (500 and 2500 Sets)
    F.2.3      Call Reference ID

  F.3     Condition Value Returned

  F.4     How CIT Routines Work with the Meridian 1

  CIT$ASSIGN

  CIT$CANCEL_CALL

  CIT$CONFERENCE_JOIN

  CIT$GET_CHANNEL_INFORMATION

  CIT$GET_EVENT

  CIT$RETRIEVE_HELD

  CIT$SET_DEVICE_ATTRIBUTES

  CIT$TRANSFER_CALL

  FIGURES

  1-1        DN Item

  1-2        PLID Item

  1-3        Voice Resource Name Item

  1-4        Message Handle Item

  1-5        Message String Item

  1-6        DN Item

  1-7        Example Get Channel Information Item List

  1-8        Example Get Context Information Item

  1-9        Monitor Item

  1-10       Call Forward Item

  1-11       Canceled Call Forward Item

  1-12       Agent Status Item

  1-13       Item for Agent Status with Data

  1-14       Example Get Event Item List

  1-15       Other and Third Party Items

  1-16       Dialed Number

  1-17       Example Get Message Information Item List

  1-18       Get Route Query Item List

  1-19       DN Item

  1-20       DN Item

  1-21       DN Item

  1-22       DN Item

  1-23       Result Buffer Structure

  1-24       DN Item

  1-25       Example Set Device Attributes Item List

  1-26       ACD Agent Status

  1-27       ACD Agent Login

  1-28       Example Voice Services Item List

  TABLES

  1-1        Call States Returned by Get Event

  1-2        Call Events Returned by Get Event

  1-3        DECvoice States and Events

  1-4        Queue Monitoring

  1-5        Response Values for Respond to Inactive Call

  1-6        Call States and Values for Set Device Attributes

  1-7        Voice Service Identifiers

  A-1        Protocol/PBX-Specific Support for CIT Routines

  B-1        CIT Functions Specific to CSTA

  B-2        Call Event Qualifiers for CSTA

  C-1        CIT Routines for DEFINITY G1 PBXs

  C-2        Call Event Qualifiers for DEFINITY G1

  C-3        DEFINITY G1 Event Information Returned

  C-4        DEFINITY G1 Call Types returned by Get Event

  C-5        DEFINITY G1 Party Information for Events

  D-1        CIT Routines for HCI PBXs

  D-2        Call Event Qualifiers for HCI

  D-3        HCI Event Information Returned by Get Event

  D-4        HCI Party Information for Events

  D-5        Call Types Specific to HCI

  E-1        CIT Routines for HICOM PBXs

  E-2        HICOM Party Information for Events

  F-1        CIT Routines for the Meridian 1

  F-2        Meridian 1 Call Event Qualifiers

  F-3        Meridian 1 Party Information for Events