stop_tap

View as Markdown

Stop an active tap stream.

stop_tap
objectRequired

An object that accepts the following properties.

Properties

stop_tap.control_id
stringDefaults to The last tap started will be stopped

ID of the tap to stop

Variables

Read by the method:

  • tap_control_id: (in) Control ID of last tap stream started.

Set by the method:

  • stop_tap_result: (out) Success or failed.

Examples

Stop the last call tap

1version: 1.0.0
2sections:
3 main:
4 - stop_tap: {}

Stop a specific call tap

1version: 1.0.0
2sections:
3 main:
4 - stop_tap:
5 control_id: my-tap-id