3.2 Event Information

Events used by the Global Call software are listed below. For each event, the following information is provided:

• The name of the event. A dagger (†) next to the event name indicates that the name is maskable and the event's default setting (enabled or disabled) is indicated in parentheses.
• The type of the event: termination, notification, or unsolicited. See Section 3.1, "Event Types" for more information.
• The type of entity with which the event is associated: a call (CRN), line device (LDID), or Request ID.
• A short description explaining why the event is received and what the event indicates.

Note: For more information about masking (enabling or disabling) events, see the description of the gc_SetConfigData( ) function (if supported by the technology being used) or the gc_SetEvtMsk( ) function.

The following events, listed in alphabetical order, are used by the Global Call software:

GCEV_ACCEPT

Termination event for gc_AcceptCall( )

Associated with a call (CRN)

Call received at remote end, but not yet answered.

GCEV_ACKCALL

Termination event for gc_CallAck( )

Associated with a call (CRN)

Indicates termination of gc_CallAck( ) and that the DDI string may be retrieved by using gc_GetDNIS( ).

GCEV_ALARM

Unsolicited event

Associated with a line device (LDID)

An alarm occurred on a trunk or a time slot. If enabled and allowed, GCEV_BLOCKED and GCEV_UNBLOCKED will also be generated for blocking alarms.

GCEV_ALERTING† (enabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Notifies the application that the call has reached its destination but is not yet connected to the called party. The call is waiting for the destination party to answer (ringing).

GCEV_ANSWERED

Termination event for gc_AnswerCall( )

Associated with a call (CRN)

Call established and enters Connected state.

GCEV_ATTACH

Termination event for gc_Attach( ) or gc_AttachResource( )

Associated with a line device (LDID)

Voice or media handle was successfully attached to the line device.

GCEV_ATTACH_FAIL

Termination event for gc_Attach( ) or gc_AttachResource( )

Associated with a line device (LDID)

The corresponding attach function failed.

GCEV_BLINDTRANSFER

Termination event for gc_BlindTransfer( )

Associated with a call (CRN)

Generated when the call transfer has been successfully initiated in an unsupervised transfer.

GCEV_BLOCKED† (enabled by default)

Unsolicited event

Associated with a line device (LDID)

Indicates that the line is blocked and application cannot issue call-related function calls. Retrieve reason for line blockage using gc_ResultValue( ).

GCEV_CALLINFO

Unsolicited event

Associated with a call (CRN)

Generated when an incoming information message is received, for example, in response to a gc_SndMsg( ) function call from the remote side.

GCEV_CALLPROC

Termination event for gc_CallAck( )

Associated with a call (CRN)

Generated when a call proceeding indication is sent out.

GCEV_CALLSTATUS

Termination event for gc_MakeCall( )

Associated with a call (CRN)

Indicates that a time-out or a no answer (call control library dependent) condition was returned while the gc_MakeCall( ) function is active.

GCEV_COMPLETETRANSFER

Termination event for gc_CompleteTransfer( )

Associated with a call (CRN)

Indicates that the original call has been transferred to the consultation call. Transfer completed successfully.

GCEV_CONGESTION

Unsolicited event

Associated with a call (CRN)

Generated when an incoming congestion message is received indicating that the remote end is not ready to accept inbound user information.

GCEV_CONNECTED

Termination event for gc_MakeCall( )

Associated with a call (CRN)

Call is connected.

GCEV_D_CHAN_STATUS

Unsolicited event

Associated with a line device (LDID)

Generated when the status of the D channel changes as a result of an event on the D channel.

GCEV_DETACH

Termination event for gc_Detach( )

Associated with a line device (LDID)

Voice or media handle was successfully detached from the line device.

GCEV_DETACH_FAIL

Termination event for gc_Detach( )

Associated with a line device (LDID)

The gc_Detach( ) function failed.

GCEV_DETECTED† (enabled by default)

Unsolicited event

Associated with a call (CRN)

Generated when an incoming call has been received. Indicates that the call is still in progress and is waiting for more digits before it can be offered to the application.

GCEV_DIALING† (disabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Generated when a call is sent out and enters the Dialing call state.

GCEV_DIALTONE† (enabled by default)

Termination event for gc_SetUpTransfer( )

Associated with a call (CRN)

Generated when a call is put on hold in order to make a consultation call during a supervised transfer.

GCEV_DISCONNECTED (see also below)

Unsolicited event

Associated with a call (CRN)

Call is disconnected by remote end.

For ISDN applications, indicates that a Disconnect, Release Complete, or Release message was received.

The application must call the gc_DropCall( ) and gc_ReleaseCallEx( ) functions after this event is received to set the call state to Null.

GCEV_DISCONNECTED (see also above)

Termination event for gc_MakeCall( )

Associated with a call (CRN) or a line device (LDID)

A request or message was rejected by the network or the function timed out. The error detected prevents further call processing on this call.

GCEV_DIVERTED

Unsolicited event

Associated with a call (CRN)

Generated when a NAM with divert information is received. Indicates that an outbound call was successfully diverted to another station (DPNSS and Q.SIG only).

GCEV_DROPCALL

Termination event for gc_DropCall( )

Associated with a call (CRN)

Call is disconnected and enters Idle state.

GCEV_ERROR

Unsolicited event

Associated with a call (CRN) or line device (LDID)

Indicates that an internal component has failed. For more information, see the "Error Handling" section in the Global Call API Programming Guide.

GCEV_EXTENSION

Unsolicited event

Associated with a call (CRN) or line device (LDID)

Indicates unsolicited information is received from the network or remote end point. Information about the event is contained in the EXTENSIONEVTBLK structure, which is referenced via the extevtdatap pointer in the METAEVENT structure associated with the GCEV_EXTENSION event.

GCEV_EXTENSIONCMPLT

Termination event for gc_Extension( )

Associated with a call (CRN) or line device (LDID)

Indicates the successful completion of the extension function. Information about the event is contained in the EXTENSIONEVTBLK structure, which is referenced via the extevtdatap pointer in the METAEVENT structure associated with the GCEV_EXTENSIONCMPLT event.

GCEV_FACILITY

Unsolicited event

Associated with a line device (LDID)

Generated when an incoming Facility Request message is received.

GCEV_FACILITY_ACK

Unsolicited event

Associated with a line device (LDID)

Generated when an incoming facility ACK message is received.

GCEV_FACILITY_REJ

Unsolicited event

Associated with a line device (LDID)

Generated when an incoming Facility_REJ message is received.

GCEV_FATALERROR

Unsolicited event

Associated with a line device (LDID)

Generated when a fatal error occurs. A fatal error is an error that can cause the channel to hang. For information about handling fatal errors, see the "Error Handling" section in the Global Call API Programming Guide.

GCEV_GETCONFIGDATA

Termination event for gc_GetConfigData( )

Associated with a call (CRN) or line device (LDID)

The configuration data has been retrieved successfully. Information about the event is contained in the GC_RTCM_EVTDATA structure.

GCEV_GETCONFIGDATA_FAIL

Termination event for gc_GetConfigData( )

Associated with a call (CRN) or line device (LDID)

The gc_GetConfigData( ) function failed. Information about the event is contained in the GC_RTCM_EVTDATA structure.

GCEV_HOLDACK (DPNSS and Q.SIG only)

Termination event for gc_HoldCall( )

Associated with a call (CRN)

Generated when a Hold Call Completed acknowledgment message is received. Indicates that the Hold Call request was acknowledged.

GCEV_HOLDCALL (see also below)

Termination event for gc_HoldCall( ) (PDKRT only)

Associated with a call (CRN)

Generated when a call successfully enters the OnHold state.

GCEV_HOLDCALL (see also above)

Unsolicited event (ISDN only)

Associated with a call (CRN)

Generated when a hold current call message is received.

GCEV_HOLDREJ (DPNSS and Q.SIG only)

Termination event for gc_HoldCall( )

Associated with a call (CRN)

Generated when a Hold Call Rejected acknowledgment message is received. Indicates that the Hold Call request was rejected.

GCEV_ISDNMSG

Unsolicited event

Associated with a call (CRN)

Generated when an incoming unrecognized ISDN message is received.

GCEV_L2BFFRFULL

Unsolicited event

Associated with a call (CRN)

Reserved for future use. Generated when the incoming layer 2 access message buffer is full.

GCEV_L2FRAME

Unsolicited event

Associated with a call (CRN)

Generated when an incoming data link layer 2 access message is received.

GCEV_L2NOBFFR

Unsolicited event

Associated with a call (CRN)

Generated when no free space (buffer) is available for an incoming layer 2 access message.

GCEV_LISTEN

Termination event for gc_Listen( )

Associated with a line device (LDID)

Indicates that the time slot has been routed successfully.

GCEV_MEDIA_ACCEPT

Notification event for gc_AnswerCall( ), gc_AttachResource( ), gc_MakeCall( )

Associated with a call (CRN)

Generated when media has been established with the remote side and streaming may begin.

GCEV_MEDIA_REJECT

Notification event for gc_AttachResource( ) or gc_MakeCall( )

Associated with a call (CRN)

Generated when an attempt to establish media with the remote side failed.

GCEV_MEDIA_REQ

Unsolicited event

Associated with a call (CRN)

Indicates that the remote side has proposed the establishment of media.

GCEV_MEDIADETECTED

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Indicates that the connected media type (the call progress information) has been identified, and the gc_GetCallInfo( ) function can be used to retrieve information about the connected media type.

Note: This event is received only if enabled by the gc_SetParm( ) function with GCPR_MEDIADETECT.

GCEV_MOREDIGITS

Termination event for gc_CallAck( )

Associated with a call (CRN)

Generated when more digits are requested. The event indicates whether:

• the requested number of digits were available
• additional digits are present
• no digits were available

GCEV_MOREINFO

Termination event for gc_CallAck( )

Associated with a call (CRN)

Generated when more digits are requested. The event indicates whether:

• the requested number of digits were available
• additional digits are present
• no digits were available

GCEV_NOFACILITYBUF

Notification event for gc_GetCallInfo( )

Associated with a call (CRN)

Generated when a combination of multiple IEs are received in the same message and the IEs exceed the storage capacity of the library.

GCEV_NOTIFY

Unsolicited event

Associated with a call (CRN)

Generated when an incoming notify message is received.

GCEV_NOUSRINFOBUF† (enabled by default)

Unsolicited event

Associated with a call (CRN)

Indicates that the incoming UUI is discarded. An incoming UUI is not accepted until the existing UUI is read by the application.

GCEV_NSI (DPNSS and Q.SIG only)

Unsolicited event

Associated with a call (CRN)

Generated when a Network Specific Information (NSI) message is received.

GCEV_OFFERED

Unsolicited event

Associated with a call (CRN)

Indicates that an inbound call arrived; call enters Offered state.

GCEV_OPENEX

Termination event for gc_OpenEx( )

Associated with a line device (LDID)

Indicates that the device was opened successfully.

GCEV_OPENEX_FAIL

Termination event for gc_OpenEx( )

Associated with a line device (LDID)

Indicates that the request to open the device failed. A gc_Close( ) function must still be performed on the line device handle to free resources.

GCEV_PROCEEDING† (enabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Generated when the call is sent out and enters the proceeding state. The necessary information for the call is completed. The call is proceeding.

GCEV_PROGRESSING† (enabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Generated when an incoming progress message is received.

GCEV_RELEASECALL

Termination event for gc_ReleaseCallEx( )

Associated with a call (CRN)

Indicates that the call has been released.

GCEV_RELEASECALL_FAIL

Termination event for gc_ReleaseCallEx( )

Associated with a call (CRN)

Indicates that the release call action failed.

GCEV_REQANI

Termination event for gc_ReqANI( )

Associated with a call (CRN)

Generated when ANI information is received from the network. Applies to the AT&T ANI-on-Demand feature only.

GCEV_REQMOREINFO† (enabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Generated when the remote side requests more digits, which typically occurs after the call enters the Dialing state.

GCEV_RESETLINEDEV

Termination event for gc_ResetLineDev( )

Associated with a line device (LDID)

Generated when the gc_ResetLineDev( ) function completes.

GCEV_RESTARTFAIL

Termination event for gc_ResetLineDev( )

Associated with a line device (LDID)

Generated when the gc_ResetLineDev( ) function fails on ISDN.

GCEV_RETRIEVEACK (DPNSS and Q.SIG only)

Termination event for gc_RetrieveCall( )

Associated with a call (CRN)

Generated when a Retrieve Call Completed acknowledgment is received. Indicates that the call on hold has been reconnected.

GCEV_RETRIEVECALL (see also below)

Termination event for gc_RetrieveCall( ) (PDKRT only)

Associated with a call (CRN)

Indicates that a call on hold was successfully retrieved.

GCEV_RETRIEVECALL (see also above)

Unsolicited event (ISDN only)

Associated with a call (CRN)

Generated when a request has been received from the remote side to return a call on hold to the active state.

GCEV_RETRIEVEREJ (DPNSS and Q.SIG only)

Termination event for gc_RetrieveCall( )

Associated with a call (CRN)

Generated when a Retrieve Call Rejected acknowledgment message is received. Indicates that the held call could not be reconnected.

GCEV_SENDMOREINFO

Termination event for gc_SendMoreInfo( )

Associated with a call (CRN)

Generated when the information is successfully sent.

GCEV_SERVICEREQ

Unsolicited event

Associated with a call (CRN) or line device (LDID)

Generated when the network receives a service request.

GCEV_SERVICERESP

Termination event for gc_ReqService( )

Associated with a call (CRN) or line device (LDID)

Generated when the network receives a response from the remote device to a service request.

GCEV_SERVICERESPCMPLT

Termination event for gc_RespService( )

Associated with a call (CRN) or line device (LDID)

Indicates that a response to a service request has been successfully generated.

GCEV_SETBILLING

Termination event for gc_SetBilling( )

Associated with a call (CRN)

Generated when billing information for the call is acknowledged by the network. (Applies to AT&T ANI-on-Demand feature only.)

GCEV_SETCHANSTATE (see also below)

Termination event for gc_SetChanState( )

Associated with a line device (LDID)

Line device was placed in requested state.

GCEV_SETCHANSTATE (see also above)

Unsolicited event (ISDN only)

Associated with a line device (LDID)

Generated when the status of the B channel changes or a Maintenance message is received from the network.

If applications are both ISDN and non-ISDN, follow these steps to determine whether or not the event is unsolicited:

1. Check the call control library form (CC, not GC) of the result value.
2. Convert the ISDN cclib name to the cclibid after calling the gc_Start( ) function.
3. Compare the ISDN cclibid to the metaevent cclibid; the result value for ISDN applications is non-0 for unsolicited and 0 for termination.

GCEV_SETCONFIGDATA

Termination event for gc_SetConfigData( )

Associated with a Request ID

Indicates that the configuration data has been successfully updated. Information about the event is contained in the GC_RTCM_EVTDATA structure.

GCEV_SETCONFIGDATA_FAIL

Termination event for gc_SetConfigData( )

Associated with a Request ID

Indicates that an error occurred when updating the configuration data. Information about the event is contained in the GC_RTCM_EVTDATA structure.

GCEV_SETUP_ACK† (disabled by default)

Notification event for gc_MakeCall( )

Associated with a call (CRN)

Generated when an incoming setup ACK message is received.

GCEV_SETUPTRANSFER

Termination event for gc_SetUpTransfer( )

Associated with a call (CRN)

Indicates that a call reference number has been allocated for the consultation call; the original call is on hold.

GCEV_STOPMEDIA_REQ

Unsolicited event

Associated with a call (CRN)

Indicates that the remote side has torn down the media channel that was previously established and that streaming should stop.

GCEV_SWAPHOLD

Termination event for gc_SwapHold( )

Associated with a call (CRN)

Generated when the call on hold (pending transfer) is switched to the active state and the call that was previously active is put on hold (pending transfer).

GCEV_TASKFAIL

Termination event for gc_AcceptCall( ), gc_AnswerCall( ), gc_BlindTransfer( ), gc_CallAck( ), gc_CompleteTransfer( ), gc_DropCall( ), gc_Extension( ), gc_HoldCall( ), gc_Listen( ), gc_MakeCall( ), gc_ReqANI( ), gc_ReqMoreInfo( ), gc_ReqService( ), gc_RespService( ), gc_RetrieveCall( ), gc_SendMoreInfo( ), gc_SetBilling( ), gc_SetChanState( ), gc_SetUpTransfer( ), gc_SwapHold( ), gc_UnListen( )

Associated with a call (CRN) or line device (LDID)

For functions that cause call state transitions, the event indicates a failure occurred and the call state does not change. An unsolicited error event occurred during the execution of a function. The call state does not change. For more information, see the "Error Handling" section in the Global Call API Programming Guide.

GCEV_TRANSFERACK (DPNSS and Q.SIG only)

Unsolicited event

Associated with a call (CRN)

Generated when a Transfer Acknowledge message is received from the network. Indicates that the network accepted a request to transfer a call.

GCEV_TRANSFERREJ (DPNSS and Q.SIG only)

Unsolicited event

Associated with a call (CRN)

Generated when a Transfer Reject message is received from the network. Indicates that the network rejected a request to transfer a call.

GCEV_TRANSIT (DPNSS and Q.SIG only)

Unsolicited event

Associated with a call (CRN)

Generated when messages are sent via a call transferring party to the destination party after a transfer call connection is completed.

GCEV_UNBLOCKED† (enabled by default)

Unsolicited event

Associated with a line device (LDID)

Line is unblocked. Application may issue call-related commands to this line device.

GCEV_UNLISTEN

Termination event for gc_UnListen( )

Associated with a line device (LDID)

Indicates that the time slot has been unrouted successfully.

GCEV_USRINFO

Unsolicited event

Associated with a call (CRN)

Generated when an incoming User Information message is received, for example, in response to a gc_SndMsg( ) function call in which the msg_type specified is SndMsg_UsrInformation. Indicates that a User-to-User Information (UUI) event is coming.

Click here to contact Telecom Support Resources