Class VonageNativeCallSdk

A real, two-way ITelephonyCallSdk over the native Vonage Voice API + WebSocket media.

Gives the agent both hearing (inbound WebSocket media → seam audio frames) and a voice (sendAudioFrame → the native WebSocket media send path), plus working DTMF send/receive, call transfer, and hangup. Construct via BindVonageNativeCall (the factory the bridge's SetSdkFactory wants), not directly, so config resolution + the lazy loader wire consistently.

The adapter is lazy: the native client is created and the call placed/answered at dial / answer. Handlers registered before the call exists (onAudioFrame, onDtmf, onCallEnded) are buffered and (re-)attached to the native client once the call's UUID is known — mirroring VonageCallSdk.

Implements

ITelephonyCallSdk

Index

Constructors

constructor

Methods

answer dial hangup onAudioFrame onCallEnded onDtmf sendAudioFrame sendDtmf transfer

Constructors

constructor

new VonageNativeCallSdk(
config: VonageNativeSdkConfig,
loadModule?: NativeModuleLoader,
): VonageNativeCallSdk
Parameters
- config: VonageNativeSdkConfig
  Resolved credentials + media URL + the native module specifier.
- loadModule: NativeModuleLoader = defaultNativeLoader
  The native-module loader (defaults to the lazy specifier loader).
Returns VonageNativeCallSdk
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:252

Methods

answer

answer(callId: string): Promise<void>
Answers an inbound call already delivered by the answer webhook: loads the native module, accepts the call's WebSocket media leg, binds the UUID, and (re-)attaches any buffered handlers.
Parameters
- callId: string
  The inbound call UUID from the webhook.
Returns Promise<void>
Throws
When the native module specifier is missing or the module can't be loaded.
Implementation of ITelephonyCallSdk.answer
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:284

dial

dial(
    toNumber: string,
    fromNumber: string,
    args?: Record<string, unknown>,
): Promise<string>
Places an outbound call: loads the native module, constructs a client with the resolved Voice credentials, places the call (opening its WebSocket media leg), binds the UUID, and (re-)attaches any buffered handlers. Brings BOTH hearing and the agent's voice online.
Parameters
- toNumber: string
  Destination number to dial (E.164 recommended).
- fromNumber: string
  The agent's caller-id / DID the call originates from.
- Optionalargs: Record<string, unknown>
  Provider-specific dial options.
Returns Promise<string>
The placed call's UUID.

Throws
When the native module specifier is missing or the module can't be loaded.
Implementation of ITelephonyCallSdk.dial
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:270

hangup

hangup(callId: string): Promise<void>
Hangs up the call via the native client and clears the active UUID. Tolerant of teardown errors.
Parameters
- callId: string
  The call UUID to end.
Returns Promise<void>
Implementation of ITelephonyCallSdk.hangup
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:295

onAudioFrame

onAudioFrame(cb: (pcm: ArrayBuffer) => void): void
Registers the inbound-audio handler (what the agent hears). Buffered until the call exists, then attached; if the call is already live it attaches immediately.
Parameters
- cb: (pcm: ArrayBuffer) => void
  Invoked with each inbound PCM audio frame.
Returns void
Implementation of ITelephonyCallSdk.onAudioFrame
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:328

onCallEnded

onCallEnded(cb: () => void): void
Registers the call-ended handler. Buffered until the call exists, then attached.
Parameters
- cb: () => void
  Invoked when the call ends (remote hangup / carrier drop / WebSocket close).
Returns void
Implementation of ITelephonyCallSdk.onCallEnded
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:378

onDtmf

onDtmf(cb: (digits: string) => void): void
Registers the inbound-DTMF handler. Buffered until the call exists, then attached.
Parameters
- cb: (digits: string) => void
  Invoked with each received DTMF digit string.
Returns void
Implementation of ITelephonyCallSdk.onDtmf
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:354

sendAudioFrame

sendAudioFrame(pcm: ArrayBuffer): void
Sends one raw PCM frame as the agent's outbound voice — the agent's real voice onto the phone call, via the native WebSocket media send path. No-ops (without throwing) before the call exists so an early model frame never crashes the session.
Parameters
- pcm: ArrayBuffer
  The PCM audio bytes to speak onto the call.
Returns void
Implementation of ITelephonyCallSdk.sendAudioFrame
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:316

sendDtmf

sendDtmf(digits: string): Promise<void>
Sends DTMF digits on the live call via the native client. No-ops (without throwing) before the call exists.
Parameters
- digits: string
  The DTMF digit string to send (e.g. '1234#').
Returns Promise<void>
Implementation of ITelephonyCallSdk.sendDtmf
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:343

transfer

transfer(callId: string, toNumber: string): Promise<void>
Transfers the live call to another party via the native client.
Parameters
- callId: string
  The call UUID to transfer.
- toNumber: string
  The transfer destination.
Returns Promise<void>
Implementation of ITelephonyCallSdk.transfer
- Defined in Providers/Vonage/src/vonage-native-call-sdk.ts:367

Class VonageNativeCallSdk

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VonageNativeCallSdk

Methods

answer

Parameters

Returns Promise<void>

Throws

dial

Parameters

Returns Promise<string>

Throws

hangup

Parameters

Returns Promise<void>

onAudioFrame

Parameters

Returns void

onCallEnded

Parameters

Returns void

onDtmf

Parameters

Returns void

sendAudioFrame

Parameters

Returns void

sendDtmf

Parameters

Returns Promise<void>

transfer

Parameters

Returns Promise<void>

Settings

On This Page