nodes/generated

Interface WhatsAppNodeParameters

Source
interface WhatsAppNodeParameters {
    additionalFields?:
        | {
            addresses?: {
                address: {
                    city?: string;
                    country?: string;
                    country_code?: string;
                    state?: string;
                    street?: string;
                    type?: "HOME"
                    | "WORK";
                    zip?: string;
                }[];
            };
            birthday?: string;
            emails?: {
                data: { email?: string; type?: "HOME"
                | "WORK" }[];
            };
            organization?: {
                data: {
                    company?: string;
                    department?: string;
                    title?: string;
                };
            };
            phones?: {
                data: {
                    phone?: string;
                    type?: | "HOME"
                    | "WORK"
                    | "CELL"
                    | "IPHONE"
                    | "MAIN"
                    | "wa_id";
                }[];
            };
            urls?: {
                url: { type?: "HOME"
                | "WORK"; url?: string }[];
            };
        }
        | {
            nameAndAddress: {
                address?: string;
                name?: string;
            };
        }
        | { mediaCaption?: string; mediaFilename?: string }
        | { previewUrl?: boolean }
        | { mediaFileName?: string };
    approvalOptions?: {
        values: {
            approvalType?: "single" | "double";
            approveLabel?: string;
            disapproveLabel?: string;
        };
    };
    components?: {
        component: {
            bodyParameters?: {
                parameter: {
                    amount_1000?: number;
                    code?: | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER"
                    | "ISK"
                    | "AMD"
                    | "ANG"
                    | "AOA"
                    | "AWG"
                    | "BAM"
                    | "BHD"
                    | "BIF"
                    | "BOV"
                    | "BTN"
                    | "BYN"
                    | "CDF"
                    | "CHE"
                    | "CHW"
                    | "CLF"
                    | "COU"
                    | "CUC"
                    | "CUP"
                    | "CVE"
                    | "DJF"
                    | "ERN"
                    | "ETB"
                    | "FKP"
                    | "GEL"
                    | "GHS"
                    | "GIP"
                    | "GMD"
                    | "GNF"
                    | "GYD"
                    | "HTG"
                    | "IQD"
                    | "IRR"
                    | "JOD"
                    | "KGS"
                    | "KHR"
                    | "KMF"
                    | "KPW"
                    | "KWD"
                    | "KYD"
                    | "LSL"
                    | "LYD"
                    | "MDL"
                    | "MGA"
                    | "MKD"
                    | "MNT"
                    | "MRU"
                    | "MWK"
                    | "MXV"
                    | "MZN"
                    | "NAD"
                    | "NGN"
                    | "OMR"
                    | "PAB"
                    | "PYG"
                    | "RSD"
                    | "RWF"
                    | "SDG"
                    | "SHP"
                    | "SLL"
                    | "SOS"
                    | "SRD"
                    | "SSP"
                    | "STN"
                    | "SVC"
                    | "SZL"
                    | "TJS"
                    | "TMT"
                    | "TND"
                    | "TZS"
                    | "UGX"
                    | "USN"
                    | "UYI"
                    | "UYU"
                    | "UYW"
                    | "UZS"
                    | "VES"
                    | "XAF"
                    | "XAG"
                    | "XAU"
                    | "XBA"
                    | "XBB"
                    | "XBC"
                    | "XBD"
                    | "XDR"
                    | "XPD"
                    | "XPF"
                    | "XPT"
                    | "XSU"
                    | "XTS"
                    | "XUA"
                    | "XXX"
                    | "ZMW"
                    | "ZWL";
                    date_time?: string;
                    fallback_value?: string;
                    text?: string;
                    type?: "text"
                    | "currency"
                    | "date_time";
                }[];
            };
            buttonParameters?: {
                parameter: {
                    payload?: string;
                    text?: string;
                    type?: "text"
                    | "payload";
                };
            };
            headerParameters?: {
                parameter: {
                    amount_1000?: number;
                    code?: | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER"
                    | "ISK"
                    | "AMD"
                    | "ANG"
                    | "AOA"
                    | "AWG"
                    | "BAM"
                    | "BHD"
                    | "BIF"
                    | "BOV"
                    | "BTN"
                    | "BYN"
                    | "CDF"
                    | "CHE"
                    | "CHW"
                    | "CLF"
                    | "COU"
                    | "CUC"
                    | "CUP"
                    | "CVE"
                    | "DJF"
                    | "ERN"
                    | "ETB"
                    | "FKP"
                    | "GEL"
                    | "GHS"
                    | "GIP"
                    | "GMD"
                    | "GNF"
                    | "GYD"
                    | "HTG"
                    | "IQD"
                    | "IRR"
                    | "JOD"
                    | "KGS"
                    | "KHR"
                    | "KMF"
                    | "KPW"
                    | "KWD"
                    | "KYD"
                    | "LSL"
                    | "LYD"
                    | "MDL"
                    | "MGA"
                    | "MKD"
                    | "MNT"
                    | "MRU"
                    | "MWK"
                    | "MXV"
                    | "MZN"
                    | "NAD"
                    | "NGN"
                    | "OMR"
                    | "PAB"
                    | "PYG"
                    | "RSD"
                    | "RWF"
                    | "SDG"
                    | "SHP"
                    | "SLL"
                    | "SOS"
                    | "SRD"
                    | "SSP"
                    | "STN"
                    | "SVC"
                    | "SZL"
                    | "TJS"
                    | "TMT"
                    | "TND"
                    | "TZS"
                    | "UGX"
                    | "USN"
                    | "UYI"
                    | "UYU"
                    | "UYW"
                    | "UZS"
                    | "VES"
                    | "XAF"
                    | "XAG"
                    | "XAU"
                    | "XBA"
                    | "XBB"
                    | "XBC"
                    | "XBD"
                    | "XDR"
                    | "XPD"
                    | "XPF"
                    | "XPT"
                    | "XSU"
                    | "XTS"
                    | "XUA"
                    | "XXX"
                    | "ZMW"
                    | "ZWL";
                    date_time?: string;
                    imageLink?: string;
                    text?: string;
                    type?: "image"
                    | "text"
                    | "currency"
                    | "date_time";
                }[];
            };
            index?: number;
            sub_type?: "url"
            | "quick_reply";
            type?: "header" | "body" | "button";
        }[];
    };
    defineForm?: "json"
    | "fields";
    formFields?: {
        values: {
            acceptFileTypes?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName?: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "date"
                | "html"
                | "checkbox"
                | "dropdown"
                | "hiddenField"
                | "password"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    jsonOutput?: string;
    latitude?: number;
    longitude?: number;
    mediaDeleteId?: string;
    mediaFilename?: string;
    mediaGetId?: string;
    mediaId?: string;
    mediaLink?: string;
    mediaPath?: | "useMediaLink"
    | "useMediaId"
    | "useMedian8n";
    mediaPropertyName?: string;
    message?: string;
    messageType?: | "video"
    | "document"
    | "image"
    | "text"
    | "audio"
    | "location"
    | "contacts";
    name?: {
        data: {
            first_name?: string;
            formatted_name: string;
            last_name?: string;
            middle_name?: string;
            prefix?: string;
            suffix?: string;
        };
    };
    operation?: | "send"
    | "sendTemplate"
    | "sendAndWait"
    | "mediaUpload"
    | "mediaUrlGet"
    | "mediaDelete";
    options?: | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    };
    phoneNumberId?: string;
    recipientPhoneNumber?: string;
    resource?: "message"
    | "media";
    responseType?: "approval" | "freeText" | "customForm";
    template?: string;
    textBody?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        addresses?: {
            address: {
                city?: string;
                country?: string;
                country_code?: string;
                state?: string;
                street?: string;
                type?: "HOME"
                | "WORK";
                zip?: string;
            }[];
        };
        birthday?: string;
        emails?: {
            data: { email?: string; type?: "HOME"
            | "WORK" }[];
        };
        organization?: {
            data: {
                company?: string;
                department?: string;
                title?: string;
            };
        };
        phones?: {
            data: {
                phone?: string;
                type?: | "HOME"
                | "WORK"
                | "CELL"
                | "IPHONE"
                | "MAIN"
                | "wa_id";
            }[];
        };
        urls?: {
            url: { type?: "HOME"
            | "WORK"; url?: string }[];
        };
    }
    | {
        nameAndAddress: { address?: string; name?: string };
    }
    | { mediaCaption?: string; mediaFilename?: string }
    | { previewUrl?: boolean }
    | { mediaFileName?: string }

Default: {}

Source§

readonly approvalOptions?: {
    values: {
        approvalType?: "single" | "double";
        approveLabel?: string;
        disapproveLabel?: string;
    };
}

Default: {}

Source§

readonly components?: {
    component: {
        bodyParameters?: {
            parameter: {
                amount_1000?: number;
                code?:
                    | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER"
                    | "ISK"
                    | "AMD"
                    | "ANG"
                    | "AOA"
                    | "AWG"
                    | "BAM"
                    | "BHD"
                    | "BIF"
                    | "BOV"
                    | "BTN"
                    | "BYN"
                    | "CDF"
                    | "CHE"
                    | "CHW"
                    | "CLF"
                    | "COU"
                    | "CUC"
                    | "CUP"
                    | "CVE"
                    | "DJF"
                    | "ERN"
                    | "ETB"
                    | "FKP"
                    | "GEL"
                    | "GHS"
                    | "GIP"
                    | "GMD"
                    | "GNF"
                    | "GYD"
                    | "HTG"
                    | "IQD"
                    | "IRR"
                    | "JOD"
                    | "KGS"
                    | "KHR"
                    | "KMF"
                    | "KPW"
                    | "KWD"
                    | "KYD"
                    | "LSL"
                    | "LYD"
                    | "MDL"
                    | "MGA"
                    | "MKD"
                    | "MNT"
                    | "MRU"
                    | "MWK"
                    | "MXV"
                    | "MZN"
                    | "NAD"
                    | "NGN"
                    | "OMR"
                    | "PAB"
                    | "PYG"
                    | "RSD"
                    | "RWF"
                    | "SDG"
                    | "SHP"
                    | "SLL"
                    | "SOS"
                    | "SRD"
                    | "SSP"
                    | "STN"
                    | "SVC"
                    | "SZL"
                    | "TJS"
                    | "TMT"
                    | "TND"
                    | "TZS"
                    | "UGX"
                    | "USN"
                    | "UYI"
                    | "UYU"
                    | "UYW"
                    | "UZS"
                    | "VES"
                    | "XAF"
                    | "XAG"
                    | "XAU"
                    | "XBA"
                    | "XBB"
                    | "XBC"
                    | "XBD"
                    | "XDR"
                    | "XPD"
                    | "XPF"
                    | "XPT"
                    | "XSU"
                    | "XTS"
                    | "XUA"
                    | "XXX"
                    | "ZMW"
                    | "ZWL";
                date_time?: string;
                fallback_value?: string;
                text?: string;
                type?: "text"
                | "currency"
                | "date_time";
            }[];
        };
        buttonParameters?: {
            parameter: {
                payload?: string;
                text?: string;
                type?: "text"
                | "payload";
            };
        };
        headerParameters?: {
            parameter: {
                amount_1000?: number;
                code?: | "ALL"
                | "ARS"
                | "AUD"
                | "BRL"
                | "CAD"
                | "CHF"
                | "CNY"
                | "CZK"
                | "DKK"
                | "EUR"
                | "GBP"
                | "HKD"
                | "HUF"
                | "INR"
                | "JPY"
                | "KRW"
                | "MXN"
                | "NOK"
                | "NZD"
                | "PLN"
                | "RUB"
                | "SEK"
                | "SGD"
                | "THB"
                | "TWD"
                | "USD"
                | "ZAR"
                | "AFN"
                | "DZD"
                | "AZN"
                | "BSD"
                | "BBD"
                | "BZD"
                | "BMD"
                | "BOB"
                | "BND"
                | "BGN"
                | "CLP"
                | "COP"
                | "NIO"
                | "CRC"
                | "DOP"
                | "VND"
                | "XCD"
                | "EGP"
                | "FJD"
                | "UAH"
                | "JMD"
                | "KES"
                | "PGK"
                | "HRK"
                | "MMK"
                | "LAK"
                | "LBP"
                | "HNL"
                | "LRD"
                | "MYR"
                | "MUR"
                | "MAD"
                | "NPR"
                | "ILS"
                | "TOP"
                | "PKR"
                | "MOP"
                | "PHP"
                | "BWP"
                | "QAR"
                | "GTQ"
                | "RON"
                | "MVR"
                | "IDR"
                | "SAR"
                | "SCR"
                | "PEN"
                | "SBD"
                | "LKR"
                | "SYP"
                | "BDT"
                | "WST"
                | "KZT"
                | "TTD"
                | "TRY"
                | "AED"
                | "VUV"
                | "XOF"
                | "YER"
                | "ISK"
                | "AMD"
                | "ANG"
                | "AOA"
                | "AWG"
                | "BAM"
                | "BHD"
                | "BIF"
                | "BOV"
                | "BTN"
                | "BYN"
                | "CDF"
                | "CHE"
                | "CHW"
                | "CLF"
                | "COU"
                | "CUC"
                | "CUP"
                | "CVE"
                | "DJF"
                | "ERN"
                | "ETB"
                | "FKP"
                | "GEL"
                | "GHS"
                | "GIP"
                | "GMD"
                | "GNF"
                | "GYD"
                | "HTG"
                | "IQD"
                | "IRR"
                | "JOD"
                | "KGS"
                | "KHR"
                | "KMF"
                | "KPW"
                | "KWD"
                | "KYD"
                | "LSL"
                | "LYD"
                | "MDL"
                | "MGA"
                | "MKD"
                | "MNT"
                | "MRU"
                | "MWK"
                | "MXV"
                | "MZN"
                | "NAD"
                | "NGN"
                | "OMR"
                | "PAB"
                | "PYG"
                | "RSD"
                | "RWF"
                | "SDG"
                | "SHP"
                | "SLL"
                | "SOS"
                | "SRD"
                | "SSP"
                | "STN"
                | "SVC"
                | "SZL"
                | "TJS"
                | "TMT"
                | "TND"
                | "TZS"
                | "UGX"
                | "USN"
                | "UYI"
                | "UYU"
                | "UYW"
                | "UZS"
                | "VES"
                | "XAF"
                | "XAG"
                | "XAU"
                | "XBA"
                | "XBB"
                | "XBC"
                | "XBD"
                | "XDR"
                | "XPD"
                | "XPF"
                | "XPT"
                | "XSU"
                | "XTS"
                | "XUA"
                | "XXX"
                | "ZMW"
                | "ZWL";
                date_time?: string;
                imageLink?: string;
                text?: string;
                type?: "image"
                | "text"
                | "currency"
                | "date_time";
            }[];
        };
        index?: number;
        sub_type?: "url"
        | "quick_reply";
        type?: "header" | "body" | "button";
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly defineForm?: "json" | "fields"

Default: "fields"

Source§

readonly formFields?: {
    values: {
        acceptFileTypes?: string;
        elementName?: string;
        fieldLabel: string;
        fieldName?: string;
        fieldOptions: { values: { option?: string }[] };
        fieldType:
            | "number"
            | "file"
            | "text"
            | "email"
            | "date"
            | "html"
            | "checkbox"
            | "dropdown"
            | "hiddenField"
            | "password"
            | "radio"
            | "textarea";
        fieldValue?: string;
        formatDate?: string;
        html?: string;
        limitSelection?: "exact"
        | "range"
        | "unlimited";
        maxSelections?: number;
        minSelections?: number;
        multipleFiles?: boolean;
        multiselect?: boolean;
        multiselectLegacyNotice?: string;
        numberOfSelections?: number;
        placeholder?: string;
        requiredField?: boolean;
    }[];
}

Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly jsonOutput?: string

Default: "[\n {\n "fieldLabel":"Name",\n "placeholder":"enter you name",\n "requiredField":true\n },\n {\n "fieldLabel":"Age",\n "fieldType":"number",\n "placeholder":"enter your age"\n },\n {\n "fieldLabel":"Email",\n "fieldType":"email",\n "requiredField":true\n }\n]" Type options: {"rows":5}

Source§

readonly latitude?: number

Type options: {"minValue":-90,"maxValue":90}

Source§

readonly longitude?: number

Type options: {"minValue":-180,"maxValue":180}

Source§

readonly mediaDeleteId?: string

The ID of the media

Source§

readonly mediaFilename?: string

The name of the file (required when using a file ID)

Source§

readonly mediaGetId?: string

The ID of the media

Source§

readonly mediaId?: string

ID of the media to be sent

Link of the media to be sent

Source§

readonly mediaPath?: "useMediaLink" | "useMediaId" | "useMedian8n"

Use a link, an ID, or n8n to upload an audio file Default: "useMediaLink"

Source§

readonly mediaPropertyName?: string

The name of the input field containing the binary file data to be uploaded Default: "data"

Source§

readonly message?: string

Type options: {"rows":4}

Source§

readonly messageType?:
    | "video"
    | "document"
    | "image"
    | "text"
    | "audio"
    | "location"
    | "contacts"

The type of the message Default: "text"

Source§

readonly name?: {
    data: {
        first_name?: string;
        formatted_name: string;
        last_name?: string;
        middle_name?: string;
        prefix?: string;
        suffix?: string;
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly operation?:
    | "send"
    | "sendTemplate"
    | "sendAndWait"
    | "mediaUpload"
    | "mediaUrlGet"
    | "mediaDelete"

Default: "sendTemplate"

Source§

readonly options?:
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    }

Default: {}

Source§

readonly phoneNumberId?: string

The ID of the business account's phone number from which the message will be sent from Type options: {"loadOptions":{"routing":{"request":{"url":"={{$credentials.businessAccountId}}/phone_numbers","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"data"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.display_phone_number}} - {{$responseItem.verified_name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}

Source§

readonly recipientPhoneNumber?: string

Phone number of the recipient of the message

Source§

readonly resource?: "message" | "media"

Default: "message"

Source§

readonly responseType?: "approval" | "freeText" | "customForm"

Default: "approval"

Source§

readonly template?: string

Name of the template Type options: {"loadOptions":{"routing":{"request":{"url":"={{$credentials.businessAccountId}}/message_templates","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"data"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}} - {{$responseItem.language}}","value":"={{$responseItem.name}}|{{$responseItem.language}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}

Source§

readonly textBody?: string

The body of the message (max 4096 characters)