Member Junction
    Preparing search index...

    Interface VonageTelephonyConfig

    Vonage Voice + WebSocket-media telephony binding configuration.

    interface VonageTelephonyConfig {
        apiKey?: string;
        apiSecret?: string;
        applicationId?: string;
        costPerMinute?: number;
        eventUrl?: string;
        inboundRunAsUserEmail?: string;
        maxCallSeconds?: number;
        maxConcurrentCalls?: number;
        mediaPublicUrl: string;
        onMachine?: OnMachineAction;
        outbound?: OutboundPolicySettings;
        privateKey?: string;
        signatureSecret?: string;
        transferTargets?: TransferTargetSettings[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiKey? apiSecret? applicationId? costPerMinute? eventUrl? inboundRunAsUserEmail? maxCallSeconds? maxConcurrentCalls? mediaPublicUrl onMachine? outbound? privateKey? signatureSecret? transferTargets?

    Properties

    apiKey?: string

    Account API key — used for key-scoped operations when no application credential pair is supplied.

    apiSecret?: string

    Account API secret — paired with apiKey.

    applicationId?: string

    Vonage Application ID (UUID) — the JWT-auth identity for the Voice API.

    costPerMinute?: number

    Estimated carrier cost rate per minute in reporting currency (e.g. 0.015 for 1.5 cents/min). Used to compute Interaction.CostEstimate at call end. Defaults to 0.015 if unset.

    eventUrl?: string

    Event-webhook URL Vonage posts call lifecycle events to. Defaults to <public URL>/telephony/vonage/event (the route that ends the session when a call is busy / unanswered / failed / completed).

    inboundRunAsUserEmail?: string

    Email of the user INBOUND calls run as. Required for inbound calls: if unset, unknown, inactive, or the system user, the call is rejected (there is deliberately no fallback to a privileged user). Point it at a dedicated least-privilege account.

    maxCallSeconds?: number

    Maximum length of one phone call in seconds (default 1800). The session is stopped at the cap.

    maxConcurrentCalls?: number

    Most phone calls (every carrier together, both directions) the server will carry at once (default 25). Keep this at or below the realtime model plan's concurrent-session limit: past the cap an inbound caller hears a polite "all agents are busy" and an outbound call is refused, instead of every call degrading.

    mediaPublicUrl: string

    The publicly reachable wss://…/telephony/vonage/media URL the call's connect NCCO opens.

    onMachine?: OnMachineAction

    What to do when a machine answers an outbound call — Vonage's machine_detection (default 'hangup').

    outbound?: OutboundPolicySettings

    Outbound destination policy and per-user rate limit applied to every Place*Call mutation.

    privateKey?: string

    The application's RSA private key (PEM) used to sign Voice-API JWTs.

    signatureSecret?: string

    Vonage account signature secret — HMAC key for signed-request sig AND HS256 webhook-JWT verification.

    transferTargets?: TransferTargetSettings[]

    The places the agent may transfer a live call to, by name. Empty or absent means the agent cannot transfer at all, even on a carrier that supports it: the agent never names a free-form number.

    Settings

    Member Visibility

    On This Page

    Properties