Type Alias BulkCreateMessagesData

type BulkCreateMessagesData = {
    body?: {
        app: string;
        attachments?:
            | {
                _id: string;
                contentLength: number;
                contentType: string;
                name: string;
                sourceId?: string;
            }[]
            | string[];
        auto?: boolean;
        channel: | "email"
        | "sms"
        | "chat"
        | "facebook"
        | "twitter-dm"
        | "twitter-tweet"
        | "voice"
        | "instagram"
        | "whatsapp";
        conversation?: string;
        createdAt?: string;
        createdBy?: string;
        custom?: { [key: string]: never };
        customer?: string;
        direction?: "in" | "out";
        error?: {
            code?: string;
            detail?: string;
            links?: { [key: string]: unknown };
            meta?: { [key: string]: unknown };
            source?: { [key: string]: unknown };
            status?: number;
            title?: string;
        };
        errorAt?: string;
        externalId?: string;
        id?: string;
        importedAt?: string;
        kbArticles?: string[];
        lang?: string
        | null;
        location?: {
            address?: string;
            address2?: string;
            address3?: string;
            areaCode?: string;
            cityName?: string;
            countryCode?: string;
            countryName?: string;
            latitude?: number;
            longitude?: number;
            name?: string;
            regionCode?: string;
            regionName?: string;
            zipCode?: string;
        };
        meta?: { [key: string]: unknown };
        modifiedAt?: string;
        modifiedBy?: string;
        preview?: string;
        queue?: unknown & { external?: "amazon-connect"; id?: string };
        reference?: { message: string; type: "reply" | "replyAll" | "forward" };
        related?: string;
        sentAt?: string;
        sentiment?: { confidence: number; polarity: -1 | 0 | 1 };
        shortcuts?: string[];
        size?: number;
        source?: "bulk" | "satisfaction";
        status?: "sent" | "received" | "error";
        subject?: string;
    }[];
    path?: never;
    query?: never;
    url: "/messages/bulk";
}

Index

Properties

body? path? query? url

Properties

`Optional`body

body?: {
    app: string;
    attachments?:
        | {
            _id: string;
            contentLength: number;
            contentType: string;
            name: string;
            sourceId?: string;
        }[]
        | string[];
    auto?: boolean;
    channel: | "email"
    | "sms"
    | "chat"
    | "facebook"
    | "twitter-dm"
    | "twitter-tweet"
    | "voice"
    | "instagram"
    | "whatsapp";
    conversation?: string;
    createdAt?: string;
    createdBy?: string;
    custom?: { [key: string]: never };
    customer?: string;
    direction?: "in" | "out";
    error?: {
        code?: string;
        detail?: string;
        links?: { [key: string]: unknown };
        meta?: { [key: string]: unknown };
        source?: { [key: string]: unknown };
        status?: number;
        title?: string;
    };
    errorAt?: string;
    externalId?: string;
    id?: string;
    importedAt?: string;
    kbArticles?: string[];
    lang?: string
    | null;
    location?: {
        address?: string;
        address2?: string;
        address3?: string;
        areaCode?: string;
        cityName?: string;
        countryCode?: string;
        countryName?: string;
        latitude?: number;
        longitude?: number;
        name?: string;
        regionCode?: string;
        regionName?: string;
        zipCode?: string;
    };
    meta?: { [key: string]: unknown };
    modifiedAt?: string;
    modifiedBy?: string;
    preview?: string;
    queue?: unknown & { external?: "amazon-connect"; id?: string };
    reference?: { message: string; type: "reply" | "replyAll" | "forward" };
    related?: string;
    sentAt?: string;
    sentiment?: { confidence: number; polarity: -1 | 0 | 1 };
    shortcuts?: string[];
    size?: number;
    source?: "bulk" | "satisfaction";
    status?: "sent" | "received" | "error";
    subject?: string;
}[]

Type declaration

app: string
Optionalattachments?:
    | {
        _id: string;
        contentLength: number;
        contentType: string;
        name: string;
        sourceId?: string;
    }[]
    | string[]
Optionalauto?: boolean
If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.
channel:
    | "email"
    | "sms"
    | "chat"
    | "facebook"
    | "twitter-dm"
    | "twitter-tweet"
    | "voice"
    | "instagram"
    | "whatsapp"
Optionalconversation?: string
OptionalcreatedAt?: string
OptionalcreatedBy?: string
Optionalcustom?: { [key: string]: never }
Optionalcustomer?: string
Optionaldirection?: "in" | "out"
Optionalerror?: {
    code?: string;
    detail?: string;
    links?: { [key: string]: unknown };
    meta?: { [key: string]: unknown };
    source?: { [key: string]: unknown };
    status?: number;
    title?: string;
}
OptionalerrorAt?: string
OptionalexternalId?: string
Optionalid?: string
OptionalimportedAt?: string
OptionalkbArticles?: string[]
Optionallang?: string | null
Optionallocation?: {
    address?: string;
    address2?: string;
    address3?: string;
    areaCode?: string;
    cityName?: string;
    countryCode?: string;
    countryName?: string;
    latitude?: number;
    longitude?: number;
    name?: string;
    regionCode?: string;
    regionName?: string;
    zipCode?: string;
}
Optionalmeta?: { [key: string]: unknown }
OptionalmodifiedAt?: string
OptionalmodifiedBy?: string
Optionalpreview?: string
Optionalqueue?: unknown & { external?: "amazon-connect"; id?: string }
Optionalreference?: { message: string; type: "reply" | "replyAll" | "forward" }
Optionalrelated?: string
OptionalsentAt?: string
Optionalsentiment?: { confidence: number; polarity: -1 | 0 | 1 }
Optionalshortcuts?: string[]
Optionalsize?: number
Optionalsource?: "bulk" | "satisfaction"
Optionalstatus?: "sent" | "received" | "error"
Optionalsubject?: string

`Optional`path

path?: never

`Optional`query

query?: never

url

url: "/messages/bulk"

Type Alias BulkCreateMessagesData

Index

Properties

Properties

Optionalbody

Type declaration

app: string

Optionalattachments?: | { _id: string; contentLength: number; contentType: string; name: string; sourceId?: string; }[] | string[]

Optionalauto?: boolean

channel: | "email" | "sms" | "chat" | "facebook" | "twitter-dm" | "twitter-tweet" | "voice" | "instagram" | "whatsapp"

Optionalconversation?: string

OptionalcreatedAt?: string

OptionalcreatedBy?: string

Optionalcustom?: { [key: string]: never }

Optionalcustomer?: string

Optionaldirection?: "in" | "out"

Optionalerror?: { code?: string; detail?: string; links?: { [key: string]: unknown }; meta?: { [key: string]: unknown }; source?: { [key: string]: unknown }; status?: number; title?: string;}

OptionalerrorAt?: string

OptionalexternalId?: string

Optionalid?: string

OptionalimportedAt?: string

OptionalkbArticles?: string[]

Optionallang?: string | null

Optionallocation?: { address?: string; address2?: string; address3?: string; areaCode?: string; cityName?: string; countryCode?: string; countryName?: string; latitude?: number; longitude?: number; name?: string; regionCode?: string; regionName?: string; zipCode?: string;}

Optionalmeta?: { [key: string]: unknown }

OptionalmodifiedAt?: string

OptionalmodifiedBy?: string

Optionalpreview?: string

Optionalqueue?: unknown & { external?: "amazon-connect"; id?: string }

Optionalreference?: { message: string; type: "reply" | "replyAll" | "forward" }

Optionalrelated?: string

OptionalsentAt?: string

Optionalsentiment?: { confidence: number; polarity: -1 | 0 | 1 }

Optionalshortcuts?: string[]

Optionalsize?: number

Optionalsource?: "bulk" | "satisfaction"

Optionalstatus?: "sent" | "received" | "error"

Optionalsubject?: string

Optionalpath

Optionalquery

url

Settings

On This Page

`Optional`body

`Optional`attachments?:
| {
_id: string;
contentLength: number;
contentType: string;
name: string;
sourceId?: string;
}[]
| string[]

`Optional`auto?: boolean

channel:
| "email"
| "sms"
| "chat"
| "facebook"
| "twitter-dm"
| "twitter-tweet"
| "voice"
| "instagram"
| "whatsapp"

`Optional`conversation?: string

`Optional`createdAt?: string

`Optional`createdBy?: string

`Optional`custom?: { [key: string]: never }

`Optional`customer?: string

`Optional`direction?: "in" | "out"

`Optional`error?: {
code?: string;
detail?: string;
links?: { [key: string]: unknown };
meta?: { [key: string]: unknown };
source?: { [key: string]: unknown };
status?: number;
title?: string;
}

`Optional`errorAt?: string

`Optional`externalId?: string

`Optional`id?: string

`Optional`importedAt?: string

`Optional`kbArticles?: string[]

`Optional`lang?: string | null

`Optional`location?: {
address?: string;
address2?: string;
address3?: string;
areaCode?: string;
cityName?: string;
countryCode?: string;
countryName?: string;
latitude?: number;
longitude?: number;
name?: string;
regionCode?: string;
regionName?: string;
zipCode?: string;
}

`Optional`meta?: { [key: string]: unknown }

`Optional`modifiedAt?: string

`Optional`modifiedBy?: string

`Optional`preview?: string

`Optional`queue?: unknown & { external?: "amazon-connect"; id?: string }

`Optional`reference?: { message: string; type: "reply" | "replyAll" | "forward" }

`Optional`related?: string

`Optional`sentAt?: string

`Optional`sentiment?: { confidence: number; polarity: -1 | 0 | 1 }

`Optional`shortcuts?: string[]

`Optional`size?: number

`Optional`source?: "bulk" | "satisfaction"

`Optional`status?: "sent" | "received" | "error"

`Optional`subject?: string

`Optional`path

`Optional`query