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

    Interface PurchaseNumberParams

    interface PurchaseNumberParams {
        areaCode?: string;
        explicitProgrammaticConsent: string;
        inboundInstruction: string;
        inboundLanguage?: string;
        inboundVoiceGender?: "male" | "female";
        includeImessage?: boolean;
    }
    Index
    areaCode? explicitProgrammaticConsent inboundInstruction inboundLanguage? inboundVoiceGender? includeImessage?
    areaCode?: string

    Preferred US area code when provisioning. Optional — omitted: any available US number. Only US numbers can be provisioned at this time. Ignored for iMessage numbers.

    explicitProgrammaticConsent: string

    Required attestation that the account holder explicitly consented to provisioning this number programmatically (e.g. a reference to where/how they consented). Stored on the number for the provisioning audit trail.

    inboundInstruction: string

    System prompt the AI voice agent uses on inbound calls to this number. Required.

    inboundLanguage?: string

    BCP-47 language tag (e.g. "es-ES") pinning inbound calls to this number to one language. Optional — omitted: the language is detected from the caller's country prefix on each call (alongside en-US).

    inboundVoiceGender?: "male" | "female"

    Voice gender for inbound calls to this number: "male" or "female". Optional — omitted: female (the default for every language).

    includeImessage?: boolean

    Provision an iMessage number instead of a standard one. Optional — omitted: a standard SMS/call number. iMessage numbers are pay-as-you-go only and are provisioned asynchronously: the returned number starts in setupStatus: "provisioning" — poll DialClient.listNumbers until it is "ready".

    Settings
    Member Visibility

    On This Page
    Properties