Provider
Synchronous
No Custom Parameters
StopMediaOperation has two distinct modes. It can be used to stop the specific command identified by OperationId, or it can be used to stop all commands executing on a connection.
To programmatically stop an ongoing media operation, specify both OperationId and the ConnectionId on which the media operation is executing on.
To programmatically stop all media operations on a connection, only specify the ConnectionId parameter and not OperationId.
If a media command is stopped with StopMediaOperation, it will cause the TerminationCondition of that action to have a value of userstop.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| OperationId | System.String | Indicates which specific operation on a connection should be cancelled, if specified. If OperationId is specified, then ConnectionId must be specified. This value can be obtained as a result data parameter in the Record, Play, VoiceRecognition, DetectSilence, DetectNonSilence, or GatherDigits action, and so therefore is used to cancel that operation on a connection if that value is specified here. | |
| Block | System.Boolean | True | Indicates that this action should not return until the operation has fully completed. It is recommended that the default of true by used. |
| Timeout | System.Int32 | The 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. | |
| ConnectionId * | System.String | Indicates the connection to stop currently executing media operation(s) on. If one wishes to stop a media operation invoked on a conference, then the ConnectionId to specify in this action parameter is returned as a result data parameter by that media operation. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultCode | System.String | A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes. |
Branch Conditions
No description.
No description.
No description.