@getdial/sdk - v0.21.0
    Preparing search index...

    Interface MakeCallParams

    interface MakeCallParams {
        fromNumber?: string;
        fromNumberId?: string;
        idempotencyKey?: string;
        language?: string;
        maxCallDurationSeconds?: number;
        outboundInstruction: string;
        to: string;
        transferTo?: string;
        voiceGender?: "male" | "female";
    }
    Index
    fromNumber? fromNumberId? idempotencyKey? language? maxCallDurationSeconds? outboundInstruction to transferTo? voiceGender?
    fromNumber?: string

    Number to call from, referenced flexibly: a phone-number id, one of your numbers in E.164, or a nickname. Provide exactly one of fromNumber or fromNumberId (enforced by the server).

    fromNumberId?: string

    Number id to call from. Legacy alternative to fromNumber — provide exactly one.

    idempotencyKey?: string

    Unique key (e.g. a UUID) making the placement idempotent. Optional — pass the same key when retrying a failed or ambiguous makeCall and the server returns the already-placed call instead of dialing again.

    language?: string

    BCP-47 language tag, e.g. "en-US". Optional — when omitted, the server detects the language from the destination number's country prefix and the agent handles both it and en-US.

    maxCallDurationSeconds?: number

    Maximum duration for this call in seconds. Optional — when omitted the account-level or number-level cap applies (if any).

    outboundInstruction: string

    System prompt for the AI voice agent during this call.

    to: string
    transferTo?: string

    Forward-to number in E.164 format. Optional — when set, the agent waits for a real human (riding out hold music and IVR menus) and then cold-transfers the call to this number. Must differ from to and the from number.

    voiceGender?: "male" | "female"

    Voice gender for the agent on this call. Optional — when omitted, the voice is female (the default for every language). Pass "male" to override.

    Settings
    Member Visibility

    On This Page
    Properties