Member Junction
    Preparing search index...

    Interface TwilioTelephonyConfig

    Twilio Programmable Voice + Media Streams telephony binding configuration.

    interface TwilioTelephonyConfig {
        accountSid: string;
        amdStatusCallbackUrl?: string;
        apiKeySecret?: string;
        apiKeySid?: string;
        authToken?: string;
        costPerMinute?: number;
        inboundRunAsUserEmail?: string;
        maxCallSeconds?: number;
        maxConcurrentCalls?: number;
        onMachine?: OnMachineAction;
        outbound?: OutboundPolicySettings;
        statusCallbackUrl?: string;
        streamPublicUrl: string;
        transferTargets?: TransferTargetSettings[];
        webhookSigningSecret?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountSid amdStatusCallbackUrl? apiKeySecret? apiKeySid? authToken? costPerMinute? inboundRunAsUserEmail? maxCallSeconds? maxConcurrentCalls? onMachine? outbound? statusCallbackUrl? streamPublicUrl transferTargets? webhookSigningSecret?

    Properties

    accountSid: string

    Twilio Account SID (AC…).

    amdStatusCallbackUrl?: string

    URL Twilio posts the async answering-machine verdict to. Defaults to <public URL>/telephony/twilio/amd.

    apiKeySecret?: string

    API Key secret — paired with apiKeySid.

    apiKeySid?: string

    API Key SID (SK…) — preferred over the auth token for REST auth when paired with apiKeySecret.

    authToken?: string

    Account auth token — REST auth (when no API key pair) AND the HMAC key for X-Twilio-Signature verification.

    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.

    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.

    onMachine?: OnMachineAction

    What to do when a machine or fax answers an outbound call (default 'hangup').

    outbound?: OutboundPolicySettings

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

    statusCallbackUrl?: string

    URL Twilio posts outbound-call lifecycle events to. Defaults to <public URL>/telephony/twilio/status (the route that ends the session when a call is busy / unanswered / failed / completed).

    streamPublicUrl: string

    The publicly reachable wss://…/telephony/twilio/media URL Twilio's connects to.

    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.

    webhookSigningSecret?: string

    Reserved; currently unused. The media websocket is authenticated by a per-call token minted by MJ (see mediaSocketAuth.ts), and webhooks by X-Twilio-Signature.

    Settings

    Member Visibility

    On This Page

    Properties