Class RealTwilioBindings

Production ITwilioClientBindings over the real Twilio REST API + Media Streams, expressed against the injected ITwilioRestLike / ITwilioMediaPump surfaces so it builds and unit-tests with no twilio install and no network.

createCall → REST calls.create with the <Connect><Stream> TwiML.
acceptInbound → no REST call (the inbound webhook already returned the connect TwiML); the websocket for the delivered Call SID is what "accepting" means — handled by onStreamAudio.
completeCall / redirectCall / playDigits → REST calls(sid).update.
pushStreamAudio / onStreamAudio → Media-Streams frames, transcoded through the T0 codec.

Implements

ITwilioClientBindings

Index

Constructors

constructor

Methods

acceptInbound completeCall createCall onCallStatus onDigits onStreamAudio playDigits pushStreamAudio redirectCall

Constructors

constructor

new RealTwilioBindings(options: RealTwilioBindingsOptions): RealTwilioBindings
Parameters
- options: RealTwilioBindingsOptions
Returns RealTwilioBindings
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:219

Methods

acceptInbound

acceptInbound(_callSid: string): Promise<void>
Accepts the Media-Streams websocket for an inbound call already delivered by the voice webhook.
Parameters
- _callSid: string
  The inbound Call SID from the webhook.
Returns Promise<void>
Implementation of ITwilioClientBindings.acceptInbound
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:238

completeCall

completeCall(callSid: string): Promise<void>
Ends the call (REST calls(sid).update({ status: 'completed' })).
Parameters
- callSid: string
  The Call SID to complete.
Returns Promise<void>
Implementation of ITwilioClientBindings.completeCall
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:244

createCall

createCall(
    toNumber: string,
    fromNumber: string,
    args?: Record<string, unknown>,
): Promise<string>
Places an outbound call via the Twilio REST API (calls.create) with TwiML that opens a bidirectional Media-Streams <Connect><Stream> to the agent's websocket.
Parameters
- toNumber: string
  Destination number (E.164).
- fromNumber: string
  The agent's Twilio number / verified caller-id the call originates from.
- Optionalargs: Record<string, unknown>
  Provider-specific options (status-callback URL, stream URL, recording flags, …).
Returns Promise<string>
The created Call SID.
Implementation of ITwilioClientBindings.createCall
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:227

onCallStatus

onCallStatus(callSid: string, cb: () => void): void
Registers the call-ended callback (status-callback completed/failed/canceled or stream stop).
Parameters
- callSid: string
  The Call SID.
- cb: () => void
  Invoked when the call ends.
Returns void
Implementation of ITwilioClientBindings.onCallStatus
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:285

onDigits

onDigits(callSid: string, cb: (digits: string) => void): void
Registers the inbound DTMF callback (<Gather> webhook results or Media-Streams dtmf events).
Parameters
- callSid: string
  The Call SID.
- cb: (digits: string) => void
  Invoked with each received DTMF digit string.
Returns void
Implementation of ITwilioClientBindings.onDigits
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:270

onStreamAudio

onStreamAudio(callSid: string, cb: (pcm: ArrayBuffer) => void): void
Registers the inbound Media-Streams audio callback for the call (what the agent hears).
Parameters
- callSid: string
  The Call SID whose inbound stream to subscribe to.
- cb: (pcm: ArrayBuffer) => void
  Invoked with each inbound PCM audio frame.
Returns void
Implementation of ITwilioClientBindings.onStreamAudio
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:255

playDigits

playDigits(callSid: string, digits: string): Promise<void>
Sends DTMF digits on the call (REST calls(sid).update with <Play digits> / <Dial sendDigits>).
Parameters
- callSid: string
  The Call SID.
- digits: string
  The DTMF digit string.
Returns Promise<void>
Implementation of ITwilioClientBindings.playDigits
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:265

pushStreamAudio

pushStreamAudio(callSid: string, pcm: ArrayBuffer): void
Pushes one outbound audio payload onto the call's Media-Streams websocket (the agent's voice).
Parameters
- callSid: string
  The Call SID whose stream to write to.
- pcm: ArrayBuffer
  The audio bytes (the adapter encodes to the Media-Streams μ-law/PCM media frame).
Returns void
Implementation of ITwilioClientBindings.pushStreamAudio
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:249

redirectCall

redirectCall(callSid: string, toNumber: string): Promise<void>
Transfers the live call (REST calls(sid).update({ twiml: '<Dial>...' })).
Parameters
- callSid: string
  The Call SID to redirect.
- toNumber: string
  The transfer destination.
Returns Promise<void>
Implementation of ITwilioClientBindings.redirectCall
- Defined in Providers/Twilio/src/real-twilio-bindings.ts:280

Class RealTwilioBindings

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RealTwilioBindings

Methods

acceptInbound

Parameters

Returns Promise<void>

completeCall

Parameters

Returns Promise<void>

createCall

Parameters

Returns Promise<string>

onCallStatus

Parameters

Returns void

onDigits

Parameters

Returns void

onStreamAudio

Parameters

Returns void

playDigits

Parameters

Returns Promise<void>

pushStreamAudio

Parameters

Returns void

redirectCall

Parameters

Returns Promise<void>

Settings

On This Page