Interface VonageVoiceClientLike

The subset of the SDK's Voice client (vonage.voice) we drive.

interface VonageVoiceClientLike {
    createOutboundCall(
        call: VonageOutboundCallLike,
    ): Promise<VonageCallResponseLike>;
    hangupCall(callUuid: string): Promise<unknown>;
    playDTMF(callUuid: string, digits: string): Promise<VonageDtmfResponseLike>;
    transferCallWithNCCO(
        callUuid: string,
        ncco: NccoAction[],
    ): Promise<unknown>;
}

Index

Methods

createOutboundCall hangupCall playDTMF transferCallWithNCCO

Methods

createOutboundCall

createOutboundCall(
call: VonageOutboundCallLike,
): Promise<VonageCallResponseLike>
Places an outbound call; resolves the created call resource (carrying uuid).
Parameters
- call: VonageOutboundCallLike
Returns Promise<VonageCallResponseLike>
- Defined in Providers/Vonage/src/vonage-rest-client.ts:68

hangupCall

hangupCall(callUuid: string): Promise<unknown>
Hangs up a call by UUID.
Parameters
- callUuid: string
Returns Promise<unknown>
- Defined in Providers/Vonage/src/vonage-rest-client.ts:70

playDTMF

playDTMF(callUuid: string, digits: string): Promise<VonageDtmfResponseLike>
Sends DTMF digits into a live call by UUID.
Parameters
- callUuid: string
- digits: string
Returns Promise<VonageDtmfResponseLike>
- Defined in Providers/Vonage/src/vonage-rest-client.ts:74

transferCallWithNCCO

transferCallWithNCCO(callUuid: string, ncco: NccoAction[]): Promise<unknown>
Transfers a live call by UUID into a replacement NCCO.
Parameters
- callUuid: string
- ncco: NccoAction[]
Returns Promise<unknown>
- Defined in Providers/Vonage/src/vonage-rest-client.ts:72