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

YAMLJSON

version: 1.0.0
sections:
  main:
    - stop_tap: {}

Stop a specific call tap

YAMLJSON

version: 1.0.0
sections:
  main:
    - stop_tap:
        control_id: my-tap-id