stop_tap

Stop an active tap stream.

Parameters

Name	Type	Description
control_id	string	Optional ID of the tap to stop. If not set, the last tap started will be stopped.

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: my-tap-id

JSON

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

---