JTapiIncomingCall

Metreos.Providers.JTapi.JTapiIncomingCall

Summary

JTapiIncomingCall indicates that a call has been routed to a line on a monitored device and is currently ringing and unanswered.

Usage

When a call is inbound to an script via JTapiIncomingCall, the call is in a ringing state and a script can choose to do one of 4 things: JTapiRejectCall, JTapiAnswerCall, JTapiRedirect, or simply do nothing with the call.

The JTapiHangup event can occur after JTapiIncomingCall, even if the call has not been answered. In this case, just as when the call has been answered and is established, it indicates that the remote endpoint has terminated the call, and the call is over.

Remarks

None.

Event Parameters
Parameter Name.NET TypeDescription
CallIdSystem.Int64Unique identifier used to identify this call leg in all subsequent 3rd-Party JTAPI API operations, such as JTapiRejectCall, JTapiAnswerCall, or JTapiRedirect.
CallControlCauseSystem.StringThe JTAPI protocol CallControlCause for the call. Please refer to the JTAPI documentation for the complete list of Cause and CallControlCause reasons.
DeviceNameSystem.StringThe name of the device that has received the call.
ToSystem.StringThe called number for this call. This number may not correspond to the number the remote endpoint initially dialed.
FromSystem.StringThe calling party number for this call.
OriginalToSystem.StringThe original number which was dialed. This will be the same as the To field unless the call has been redirected, transferred, or translated while being routed.
StackTokenSystem.StringThe JTAPI protocol call ID.
JTapiCallIdSystem.StringThe JTapi internal call Id. This can be used to co-relate the originating and the terminating ends of the call.