stop_tap

Stop an active tap stream.

Name	Type	Default	Description
stop_tapRequired	object	-	An object that accepts the stop_tap parameters.

stop_tap Parameters

Name	Type	Default	Description
control_idOptional	string	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

YAML

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

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "stop_tap": {}
      }
    ]
  }
}

Stop a specific call tap

YAML

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

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "stop_tap": {
          "control_id": "my-tap-id"
        }
      }
    ]
  }
}