JTapiAnswer

Metreos.Providers.JTapi.JTapiAnswerCall

Summary

Answers a call currently ringing on a monitored device.

Usage

JTapiAnswer answers an incoming call that is ringing on a phone device currently being monitored by the application server. Once the action has successfully completed, the device being monitored will answer the ringing call.

The application would have already received notification of the incoming call via the triggering JTapiIncomingCall event. The CallId present as an event parameter in the JTapiIncomingCall event would then be used as the CallId action parameter for the JTapiAnswer action.

You can not successfully use JTapiAnswer after the ringing device has been answered (most likely cause is the user answering the phone, but another JTAPI-based application could be the cause of the answer as well). You can know in your application that the call has already been answered if the JTapiCallActive fires before you have used the JTapiAnswer action.

If the calling party hangs up their end of the call before the call is answered, then it is no longer valid to use JTapiAnswer. You can know in your application that the call has already been hung up if the JTapiHangup event fires after the JTapiIncomingCall event instead of JTapiCallActive.

If call is rejected with JTapiReject, then it is no longer valid to use JTapiAnswer.

Remarks

None.

Action Parameters
Parameter Name.NET TypeDefaultDescription
CallId *System.Int64Indicates the call to answer with JTapiAnswer. The CallId must have originated from a JTapiIncomingCall event.
TimeoutSystem.Int32The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

No Result Data

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.