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

    Interface SendMessageParams

    interface SendMessageParams {
        body?: string;
        forceAudioFile?: boolean;
        fromNumber?: string;
        fromNumberId?: string;
        media?: SendMessageMedia[];
        to: string;
    }
    Index
    body? forceAudioFile? fromNumber? fromNumberId? media? to

    Optionalbody

    body?: string

    Message text; optional when media is attached (a media-only send records "").

    forceAudioFile?: boolean

    Send an audio attachment as a regular file attachment instead of an iMessage voice message. No effect on standard numbers or non-audio media.

    fromNumber?: string

    Number to send 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 send from. Legacy alternative to fromNumber — provide exactly one.

    media?: SendMessageMedia[]

    Media attachments (MMS), in send order — max 10 items, 5 MB each.

    to: string

    Settings
    Member Visibility

    On This Page
    Properties