JTapiResume

Metreos.Providers.JTapi.JTapiResume

Summary

Resume a held call on a monitored device.

Usage

JTapiResume resumes a held call.

For this action to succeed, at a minimum, the script must have already received notification of the call entering the inactive state with the nontriggering JTapiCallInactive event. However, the JTapiCallInactive event does not necessarily always correspond to a call being held.

Remarks

The JTapiCallActive will fire as a result of using this action successfully.

Action Parameters
Parameter Name.NET TypeDefaultDescription
RxPortSystem.UInt32The port that the resumed audio should be sent to, from the monitored device. If this field is not specified, then the audio will resume sending to where it would have, if this parameter were not specified. In other words, not specifying this parameter generally causes the monitored device to begin streaming to the device it was previously streaming to before the call was held. This field has only rare use and should almost always be left unspecified.
CallId *System.Int64Indicates the call to be resumed with JTapiResume.
RxIPSystem.StringThe IP address that the resumed audio should be sent to, from the monitored device. If this field is not specified, then the audio will resume sending to where it would have, if this parameter were not specified. In other words, not specifying this parameter generally causes the monitored device to begin streaming to the device it was previously streaming to before the call was held. This field has only rare use and should almost always be left specified.
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.