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

    Interface PhoneNumber

    interface PhoneNumber {
        accountId: string;
        avatarUrl: string | null;
        capabilities: ("sms" | "call" | "imessage")[];
        country: string;
        createdAt: string;
        firstName: string | null;
        id: string;
        inboundInstruction: string | null;
        inboundLanguage: string | null;
        inboundVoiceGender: "male" | "female" | null;
        lastName: string | null;
        maxCallDurationSeconds: number | null;
        nickname: string | null;
        number: string;
        setupError: string | null;
        setupStatus: "provisioning" | "ready" | "failed";
    }
    Index
    accountId avatarUrl capabilities country createdAt firstName id inboundInstruction inboundLanguage inboundVoiceGender lastName maxCallDurationSeconds nickname number setupError setupStatus
    accountId: string
    avatarUrl: string | null

    Dial-hosted URL of the number's iMessage avatar photo; null when unset or not an iMessage number.

    capabilities: ("sms" | "call" | "imessage")[]

    Channels the number supports; subset of ["sms", "call", "imessage"].

    country: string
    createdAt: string
    firstName: string | null

    iMessage display first name; always null on numbers without iMessage.

    id: string
    inboundInstruction: string | null

    System prompt the AI voice agent uses on inbound calls; null for legacy numbers.

    inboundLanguage: string | null

    BCP-47 language tag pinning inbound calls to one language; null → detected from the caller's country prefix on each call.

    inboundVoiceGender: "male" | "female" | null

    Voice gender for inbound calls ("male"/"female"); null → female (the default).

    lastName: string | null

    iMessage display last name; always null on numbers without iMessage.

    maxCallDurationSeconds: number | null

    Per-number call-length cap in seconds; null → no cap at this level.

    nickname: string | null

    Human-readable label for the number; null when unset.

    number: string
    setupError: string | null

    Human-readable reason when setupStatus is failed; null otherwise.

    setupStatus: "provisioning" | "ready" | "failed"

    Whether the number is ready to use. SMS/call numbers are always ready; iMessage numbers may be provisioning until set up, or failed on error.

    Settings
    Member Visibility

    On This Page
    Properties