Skip to navigation
AgentsFunctionResult

tap

View as MarkdownOpen in Claude

Start a media tap that streams call audio to an external endpoint. Supports WebSocket (wss://, ws://) and RTP (rtp://) destinations.

Parameters

opts
objectRequired

Tap configuration object.

opts.uri
stringRequired

Destination URI for the media stream. Supported formats:

  • "rtp://IP:port" — RTP stream
  • "ws://example.com" — WebSocket stream
  • "wss://example.com" — Secure WebSocket stream
opts.controlId
string

Identifier for this tap. Pass the same ID to stopTap() to end this specific tap. If omitted, a default ID is generated.

opts.direction
"speak" | "listen" | "both"Defaults to both

Audio direction to tap. Always sent, since the tap verb’s own default is "speak". Throws an Error for any other value.

  • "speak" — what the party says
  • "listen" — what the party hears
  • "both" — both directions
opts.codec
"PCMU" | "PCMA"Defaults to PCMU

Audio codec for the stream.

  • "PCMU" — G.711 mu-law
  • "PCMA" — G.711 A-law
opts.rtpPtime
numberDefaults to 20

Packetization time in milliseconds for RTP streams.

opts.statusUrl
string

URL to receive tap status change webhooks.

Returns

FunctionResult — this, for chaining.

Example

import { FunctionResult } from '@signalwire/sdk';
const result = new FunctionResult()
  .tap({ uri: 'wss://example.com/tap', direction: 'both' });