tap

Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI.

Name	Type	Default	Description
tapRequired	object	-	An object that accepts the tap parameters.

tap Parameters

Name	Type	Default	Description
uriRequired	string	-	Destination of the tap media stream: rtp://IP:port, ws://example.com, or wss://example.com
control_idOptional	string	Auto-generated and stored in tap_control_id variable	Identifier for this tap to use with stop_tap
directionOptional	string	speak	Direction of the audio to tap: speak for what party says, listen for what party hears, both for what party hears and says
codecOptional	string	PCMU	PCMU or PCMA
rtp_ptimeOptional	integer	20 ms	If using a rtp:// URI, this optional parameter can set the packetization time of the media in milliseconds. Optional. Default 20 ms.
status_urlOptional	string	-	HTTP or HTTPS URL to deliver tap status events.

Variables

Set by the method:

• tap_uri: (out) The destination URI of the newly started tap.
• tap_result: (out) success | failed.
• tap_control_id: (out) Control ID of this tap.
• tap_rtp_src_addr: (out) If RTP, source address of the tap stream.
• tap_rtp_src_port: (out) If RTP, source port of the tap stream.
• tap_ptime: (out) Packetization time of the tap stream.
• tap_codec: (out) Codec in the tap stream.
• tap_rate: (out) Sample rate in the tap stream.

Examples

Start WSS tap

YAML

version: 1.0.0
sections:
  main:
    - tap:
        uri: wss://example.com/tap

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "tap": {
          "uri": "wss://example.com/tap"
        }
      }
    ]
  }
}