Interface InitiateCallResult

Result of initiating a call.

interface InitiateCallResult {
    providerCallId: string;
    providerRequestId?: string;
    success: boolean;
    error?: string;
}

Properties

providerCallId: string

Provider-assigned call ID.

providerRequestId?: string

Creation request identity when distinct from the actual call leg.

success: boolean

Whether the call was accepted by the provider.

error?: string

Error message if not successful.