Class RealVonageBindings

Production IVonageClientBindings over the real Vonage Voice API + WebSocket media, expressed against the injected IVonageVoiceLike / IVonageMediaPump surfaces so it builds and unit-tests with no @vonage/server-sdk install and no network.

createCall → Voice REST createCall with the NCCO connect websocket action.
acceptInbound → no REST call (the answer webhook already returned the connect NCCO); the websocket for the delivered call UUID is what "accepting" means — handled by onWebsocketAudio.
hangupCall / transferCall / playDigits → Voice REST.
pushWebsocketAudio / onWebsocketAudio → WebSocket media frames, transcoded through the T0 codec.

Implements

IVonageClientBindings

Index

Constructors

constructor

Methods

acceptInbound createCall flushOutbound hangupCall onCallStatus onDigits onWebsocketAudio playDigits pushWebsocketAudio transferCall

Constructors

constructor

new RealVonageBindings(options: RealVonageBindingsOptions): RealVonageBindings
Parameters
- options: RealVonageBindingsOptions
Returns RealVonageBindings
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:237

Methods

acceptInbound

acceptInbound(_callUuid: string): Promise<void>
Accepts the websocket media leg for an inbound call already delivered by the answer webhook.
Parameters
- _callUuid: string
  The inbound call UUID from the webhook.
Returns Promise<void>
Implementation of IVonageClientBindings.acceptInbound
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:257

createCall

createCall(
    toNumber: string,
    fromNumber: string,
    args?: Record<string, unknown>,
): Promise<string>
Places an outbound call via the Vonage Voice API (POST /v1/calls) with an NCCO that connects a bidirectional websocket to the agent's media leg.
Parameters
- toNumber: string
  Destination number (E.164).
- fromNumber: string
  The agent's Vonage number / verified caller-id the call originates from.
- Optionalargs: Record<string, unknown>
  Provider-specific options (event-webhook URL, websocket media URL, recording flags, …).
Returns Promise<string>
The created call UUID.
Implementation of IVonageClientBindings.createCall
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:246

flushOutbound

flushOutbound(callUuid: string): void
Parameters
- callUuid: string
Returns void
Inherit Doc: —
barge-in: tell Vonage to discard its queued outbound audio so the agent stops mid-utterance.
Implementation of IVonageClientBindings.flushOutbound
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:309

hangupCall

hangupCall(callUuid: string): Promise<void>
Ends the call (Voice API PUT /v1/calls/:uuid with { action: 'hangup' }).
Parameters
- callUuid: string
  The call UUID to hang up.
Returns Promise<void>
Implementation of IVonageClientBindings.hangupCall
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:263

onCallStatus

onCallStatus(callUuid: string, cb: () => void): void
Registers the call-ended callback (event-webhook completed/failed/rejected/cancelled or the websocket close event).
Parameters
- callUuid: string
  The call UUID.
- cb: () => void
  Invoked when the call ends.
Returns void
Implementation of IVonageClientBindings.onCallStatus
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:300

onDigits

onDigits(callUuid: string, cb: (digits: string) => void): void
Registers the inbound DTMF callback (NCCO input/dtmf results delivered to the event webhook).
Parameters
- callUuid: string
  The call UUID.
- cb: (digits: string) => void
  Invoked with each received DTMF digit string.
Returns void
Implementation of IVonageClientBindings.onDigits
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:285

onWebsocketAudio

onWebsocketAudio(callUuid: string, cb: (pcm: ArrayBuffer) => void): void
Registers the inbound websocket audio callback for the call (what the agent hears).
Parameters
- callUuid: string
  The call UUID whose inbound media to subscribe to.
- cb: (pcm: ArrayBuffer) => void
  Invoked with each inbound PCM audio frame.
Returns void
Implementation of IVonageClientBindings.onWebsocketAudio
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:274

playDigits

playDigits(callUuid: string, digits: string): Promise<void>
Sends DTMF digits on the call (Voice API PUT /v1/calls/:uuid/dtmf with { digits }).
Parameters
- callUuid: string
  The call UUID.
- digits: string
  The DTMF digit string.
Returns Promise<void>
Implementation of IVonageClientBindings.playDigits
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:280

pushWebsocketAudio

pushWebsocketAudio(callUuid: string, pcm: ArrayBuffer): void
Pushes one outbound audio payload onto the call's websocket media leg (the agent's voice).
Parameters
- callUuid: string
  The call UUID whose media leg to write to.
- pcm: ArrayBuffer
  The audio bytes (the adapter encodes to the websocket media frame).
Returns void
Implementation of IVonageClientBindings.pushWebsocketAudio
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:268

transferCall

transferCall(callUuid: string, toNumber: string): Promise<void>
Transfers the live call (Voice API PUT /v1/calls/:uuid with { action: 'transfer', destination: { type: 'ncco', ncco: [...] } }).
Parameters
- callUuid: string
  The call UUID to redirect.
- toNumber: string
  The transfer destination.
Returns Promise<void>
Implementation of IVonageClientBindings.transferCall
- Defined in Providers/Vonage/src/real-vonage-bindings.ts:295

Class RealVonageBindings

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RealVonageBindings

Methods

acceptInbound

Parameters

Returns Promise<void>

createCall

Parameters

Returns Promise<string>

flushOutbound

Parameters

Returns void

Inherit Doc: —

hangupCall

Parameters

Returns Promise<void>

onCallStatus

Parameters

Returns void

onDigits

Parameters

Returns void

onWebsocketAudio

Parameters

Returns void

playDigits

Parameters

Returns Promise<void>

pushWebsocketAudio

Parameters

Returns void

transferCall

Parameters

Returns Promise<void>

Settings

On This Page