ptevent.h

基于sipfoundy 公司开发的sipx协议API

    };
    //:Event Ids
    // The following table defines the event ids for all of the events
    // supported by the Pingtel system.
    //
    /* Provider Events */
    //!enumcode: PROVIDER_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive provider events on this instance of the PtProviderListener.
    //!enumcode: PROVIDER_IN_SERVICE - Indicates that the state of the PtProvider object has changed to PtProvider::IN_SERVICE.
    //!enumcode: PROVIDER_OUT_OF_SERVICE - Indicates that the state of the Provider object has changed to PtProvider::OUT_OF_SERVICE.
    //!enumcode: PROVIDER_SHUTDOWN - Indicates that the state of the PtProvider object has changed to PtProvider::SHUTDOWN.
    //!enumcode: PROVIDER_ADDRESS_ADDED - Indicates that a new PtAddress has been added to the provider.
    //!enumcode: PROVIDER_ADDRESS_REMOVED - Indicates that a PtAddress has been removed from the provider.
    //!enumcode: PROVIDER_TERMINAL_ADDED - Indicates that a new PtTerminal has been added to the provider.
    //!enumcode: PROVIDER_TERMINAL_REMOVED - Indicates that a PtTerminal has been removed from the provider.

    /* Address Events */
    //!enumcode: ADDRESS_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive address events on this instance of the PtAddressListener.
    /* call control: */
    //!enumcode: ADDRESS_DO_NOT_DISTURB_ENABLED - Indicates the state of the do-not-disturb feature has changed to enabled for the PtAddress.
    //!enumcode: ADDRESS_DO_NOT_DISTURB_DISABLED - Indicates the state of the do-not-disturb feature has changed to disabled for the PtAddress.
    //!enumcode: ADDRESS_FORWARDING_CHANGED - Indicates the state of the forward feature has changed for the PtAddress.
    //!enumcode: ADDRESS_MESSAGES_WAITING - Indicates the state of the message waiting feature has changed to messages waiting for the PtAddress.
    //!enumcode: ADDRESS_NO_MESSAGES_WAITING - Indicates the state of the message waiting feature has changed to no messages waiting for the PtAddress.

    /* Terminal Events */
    //!enumcode: TERMINAL_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive terminal events on this instance of the PtTerminalListener.

    /* Call Events */
    //!enumcode: CALL_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive call events on this instance of the PtCallListener.
    //!enumcode: CALL_ACTIVE - Indicates that the state of the call object has changed to PtCall::ACTIVE
    //!enumcode: CALL_INVALID - Indicates that the state of the call object has changed to PtCall::INVALID.
    //!enumcode: CALL_META_PROGRESS_STARTED - Indicates that the current call in the telephony platform has changed state, and events will follow which indicate the changes to this call.
    //!enumcode: CALL_META_PROGRESS_ENDED - Indicates that the current call in the telephony platform has changed state, and all the events that were associated with that change have now been reported.
    //!enumcode: CALL_META_SNAPSHOT_STARTED - Indicates that the Pingtel implementation is reporting to the application the current state of the call on the associated telephony platform, by reporting a set of simulated state changes that, in effect, construct the current state of the call.
    //!enumcode: CALL_META_SNAPSHOT_ENDED - Indicates that the Pingtel implementation has finished reporting a set of simulated state changes that, in effect, construct the current state of the call.
    /* call control */
    //!enumcode: CALL_META_ADD_PARTY_STARTED - Indicates that a party has been added to the call. A "party" corresponds to a PtConnection being added. Note that if a PtTerminalConnection is added, it carries a meta event of CALL_META_PROGRESS_STARTED.
    //!enumcode: CALL_META_ADD_PARTY_ENDED - Indicates the end of the group of events related to the add party meta event.
    //!enumcode: CALL_META_REMOVE_PARTY_STARTED - Indicates that a party (i.e., connection) has been removed from the call by moving into the PtConnection::DISCONNECTED state.
    //!enumcode: CALL_META_REMOVE_PARTY_ENDED - Indicates the end of the group of events related to the remove party meta event.

    /* Multi-Call Events */
    //!enumcode: MULTICALL_META_MERGE_STARTED - Indicates that calls are merging, and events will follow which indicate the changes to those calls.
    //!enumcode: MULTICALL_META_MERGE_ENDED - Indicates that calls have merged, and that all state change events resulting from this merge have been reported.
    //!enumcode: MULTICALL_META_TRANSFER_STARTED - Indicates that a transfer is occurring, and events will follow which indicate the changes to the affected calls.
    //!enumcode: MULTICALL_META_TRANSFER_ENDED - Indicates that a transfer has completed, and that all state change events resulting from this transfer have been reported.

    /* Connection Events */
    //!enumcode: CONNECTION_CREATED - Indicates that a new PtConnection object has been created.
    /* replaced by callctrl CONNECTION_IN_PROGRESS - Indicates that the state of the PtConnection object has changed to PtConnection::IN_PROGRESS. */
    //!enumcode: CONNECTION_ALERTING - Indicates that the state of the PtConnection object has changed to PtConnection::ALERTING.
    /* replaced by callctrl CONNECTION_CONNECTED - Indicates that the state of the PtConnection object has changed to PtConnection::CONNECTED. */
    //!enumcode: CONNECTION_DISCONNECTED - Indicates that the state of the PtConnection object has changed to PtConnection::DISCONNECTED.
    //!enumcode: CONNECTION_FAILED - Indicates that the state of the PtConnection object has changed to PtConnection::FAILED.
    //!enumcode: CONNECTION_UNKNOWN - Indicates that the state of the PtConnection object has changed to PtConnection::UNKNOWN.
    /* call control */
    //!enumcode: CONNECTION_DIALING - Indicates that the state of the PtConnection object has changed to PtConnection::DIALING.
    //!enumcode: CONNECTION_ESTABLISHED - Indicates that the state of the PtConnection object has changed to PtConnection::ESTABLISHED.
    //!enumcode: CONNECTION_INITIATED -  Indicates that the state of the PtConnection object has changed to PtConnection::INITIATED.
    //!enumcode: CONNECTION_NETWORK_ALERTING - Indicates that the state of the PtConnection object has changed to PtConnection::NETWORK_ALERTING.
    //!enumcode: CONNECTION_NETWORK_REACHED - Indicates that the state of the PtConnection object has changed to PtConnection::NETWORK_REACHED.
    //!enumcode: CONNECTION_OFFERED - Indicates that the state of the PtConnection object has changed to PtConnection::OFFERED.
    //!enumcode: CONNECTION_QUEUED - Indicates that the state of the PtConnection object has changed to PtConnection::QUEUED.

    /* Terminal Connection Events */
    //!enumcode: TERMINAL_CONNECTION_CREATED - Indicates that a new PtTerminalConnection object has been created.
    /* replaced by callctrl TERMINAL_CONNECTION_ACTIVE - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::ACTIVE. */
    /* TERMINAL_CONNECTION_PASSIVE - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::PASSIVE. */
    //!enumcode: TERMINAL_CONNECTION_RINGING - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::RINGING.
    //!enumcode: TERMINAL_CONNECTION_DROPPED - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::DROPPED.
    //!enumcode: TERMINAL_CONNECTION_UNKNOWN - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::UNKNOWN.
    /* call control */
    /* TERMINAL_CONNECTION_BRIDGED - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::BRIDGED. */
    //!enumcode: TERMINAL_CONNECTION_HELD -  Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::HELD.
    /* TERMINAL_CONNECTION_IN_USE -  Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::INUSE. */
    //!enumcode: TERMINAL_CONNECTION_TALKING - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::TALKING.

    /* PhoneComponent events */
    //!enumcode: PHONE_RINGER_VOLUME_CHANGED - Indicates that the PtPhoneRinger volume has changed.
    //!enumcode: PHONE_RINGER_PATTERN_CHANGED - Indicates that the PtPhoneRinger audio pattern to be played when ringing has changed.
    //!enumcode: PHONE_RINGER_INFO_CHANGED - Indicates that the PtPhoneRinger info string has changed.
    //!enumcode: PHONE_SPEAKER_VOLUME_CHANGED - Indicates that the associated PtPhoneSpeaker volume has changed.
    //!enumcode: PHONE_MICROPHONE_GAIN_CHANGED - Indicates that the associated PtPhoneMicrophone gain has changed.
    //!enumcode: PHONE_LAMP_MODE_CHANGED - Indicates that the associated PtPhoneLamp mode has changed.
    //!enumcode: PHONE_BUTTON_INFO_CHANGED - Indicates that the associated PtPhoneButton info string has changed.
    //!enumcode: PHONE_BUTTON_UP - Indicates that the associated PtPhoneButton has changed to the up (released) position.
    //!enumcode: PHONE_BUTTON_DOWN - Indicates that the associated PtPhoneButton has changed to the down (pressed) position.
    //!enumcode: PHONE_HOOKSWITCH_OFFHOOK - Indicates that the PtPhoneHookswitch has changed to the offhook state.
    //!enumcode: PHONE_HOOKSWITCH_ONHOOK - Indicates that the PtPhoneHookswitch has changed to the onhook state.
    //!enumcode: PHONE_DISPLAY_CHANGED - Indicates that the PtPhoneDisplay has changed.

    enum PtEventCause
    {
                /*
                 * WARNING: Do not change the order of these causes as they must match the JTAPI constants
                 */

                CAUSE_NORMAL                                                    = 100,
                CAUSE_UNKNOWN                                                   = 101,
                CAUSE_CALL_CANCELLED                                    = 102,
                CAUSE_DESTINATION_NOT_OBTAINABLE        = 103,
                CAUSE_INCOMPATIBLE_DESTINATION  = 104,
                CAUSE_LOCKOUT                                                   = 105,
                CAUSE_NEW_CALL                                                  = 106,
                CAUSE_RESOURCES_NOT_AVAILABLE           = 107,
                CAUSE_NETWORK_CONGESTION                        = 108,
                CAUSE_NETWORK_NOT_OBTAINABLE            = 109,
                CAUSE_SNAPSHOT                                                  = 110,

                // Call control
        CAUSE_ALTERNATE                                         = 202,
        CAUSE_BUSY                                                      = 203,
        CAUSE_CALL_BACK                                         = 204,
        CAUSE_CALL_NOT_ANSWERED                 = 205,
        CAUSE_CALL_PICKUP                                       = 206,
        CAUSE_CONFERENCE                                        = 207,
        CAUSE_DO_NOT_DISTURB                            = 208,
        CAUSE_PARK                                                      = 209,
        CAUSE_REDIRECTED                                        = 210,
        CAUSE_REORDER_TONE                                      = 211,
        CAUSE_TRANSFER                                          = 212,
        CAUSE_TRUNKS_BUSY                                       = 213,
        CAUSE_UNHOLD                                                    = 214,


                /*
                 * These are our own constants, make sure the map in JTAPI
                 */
                CAUSE_NOT_ALLOWED                                               = 1000,
                CAUSE_NETWORK_NOT_ALLOWED                       = 1001
    };
    //:Event causes
    // Specific event cause descriptions ...
    //!enumcode: CAUSE_CALL_CANCELLED - Cause code indicating the user has terminated call without going on-hook.
    //!enumcode: CAUSE_DESTINATION_NOT_OBTAINABLE - Cause code indicating the destination is not available.
    //!enumcode: CAUSE_INCOMPATIBLE_DESTINATION - Cause code indicating that a call has encountered an incompatible destination.
    //!enumcode: CAUSE_LOCKOUT - Cause code indicating that a call encountered inter-digit timeout while dialing.
    //!enumcode: CAUSE_NETWORK_CONGESTION - Cause code indicating call encountered network congestion.
    //!enumcode: CAUSE_NETWORK_NOT_OBTAINABLE - Cause code indicating call could not reach a destination network.
    //!enumcode: CAUSE_NEW_CALL - Cause code indicating the event is related to a new call.
    //!enumcode: CAUSE_NORMAL - Cause code indicating normal operation.
    //!enumcode: CAUSE_RESOURCES_NOT_AVAILABLE - Cause code indicating resources were not available.
    //!enumcode: CAUSE_SNAPSHOT - Cause code indicating that the event is part of a snapshot of the current state of the call.
    //!enumcode: CAUSE_UNKNOWN - Cause code indicating the cause was unknown.
    /* call control */
    //!enumcode: CAUSE_ALTERNATE - Cause code indicating that the call was put on hold and another retrieved in an atomic operation, typically on single line telephones.
    //!enumcode: CAUSE_BUSY - Cause code indicating that the call encountered a busy endpoint.
    //!enumcode: CAUSE_CALL_BACK - Cause code indicating the event is related to the callback feature.
    //!enumcode: CAUSE_CALL_NOT_ANSWERED - Cause code indicating that the call was not answered before a timer elapsed.
    //!enumcode: CAUSE_CALL_PICKUP - Cause code indicating that the call was redirected by the call pickup feature.
    //!enumcode: CAUSE_CONFERENCE - Cause code indicating the event is related to the conference feature.
    //!enumcode: CAUSE_DO_NOT_DISTURB - Cause code indicating the event is related to the do-not-disturb feature.
    //!enumcode: CAUSE_PARK - Cause code indicating the event is related to the park feature.
    //!enumcode: CAUSE_REDIRECTED - Cause code indicating the event is related to the redirect feature.
    //!enumcode: CAUSE_REORDER_TONE - Cause code indicating that the call encountered a reorder tone.
    //!enumcode: CAUSE_TRANSFER - Cause code indicating the event is related to the transfer feature.
    //!enumcode: CAUSE_TRUNKS_BUSY - Cause code indicating that the call encountered the "all trunks busy" condition.
    //!enumcode: CAUSE_UNHOLD - Cause code indicating the event is related to the unhold feature.
    //!enumcode: CAUSE_NOT_ALLOWED - PINGTEL SPECIFIC: Cause code indicating the call is unauthorized by endpoint.
    //!enumcode: CAUSE_NETWORK_NOT_ALLOWED - PINGTEL SPECIFIC: Cause code indicating the call is unauthorized by network/servers.

         // Meta events
    enum PtMetaCode
         {
                META_EVENT_NONE                                         = 0x00,
                META_CALL_STARTING                                      = 0x80,
                META_CALL_PROGRESS                                      = 0x81,
                META_CALL_ADDITIONAL_PARTY                      = 0x82,
                META_CALL_REMOVING_PARTY                        = 0x83,
                META_CALL_ENDING                                        = 0x84,
                META_CALL_MERGING                                       = 0x85,
                META_CALL_TRANSFERRING                          = 0x86,
                META_SNAPSHOT                                           = 0x87,
                META_UNKNOWN                                            = 0x88,
        };
        /* meta events */