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

    Interface CreateGroupParams

    Parameters for DialClient.createGroup.

    interface CreateGroupParams {
        channel?: "whatsapp";
        fromNumber?: string;
        fromNumberId?: string;
        name: string;
        participants: string[];
    }
    Index
    channel? fromNumber? fromNumberId? name participants
    channel?: "whatsapp"

    The channel to create the group on. Only "whatsapp" today, and the default when omitted.

    fromNumber?: string

    The line that creates the group and becomes its admin: its id, its number in E.164, or a nickname. Provide exactly one of fromNumber or fromNumberId (enforced by the server).

    fromNumberId?: string

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

    name: string

    The group's name (subject), 1–100 characters.

    participants: string[]

    The numbers to add, in E.164 — 1 to 256, deduplicated by the server. The creating line's own number is refused.

    Settings
    Member Visibility

    On This Page
    Properties