solapi
    Preparing search index...

    Class Message

    메시지 모델, 전체적인 메시지 발송을 위한 파라미터는 이 Message 모델에서 관장함

    Index

    Constructors

    constructor

    Properties

    autoTypeDetect? country? customFields? dateCreated? dateUpdated? faxOptions? from? groupId? imageId? kakaoOptions? log? messageId? rcsOptions? replacements? statusCode? subject? text? to type? voiceOptions?

    Constructors

    • Parameters

      • parameter: {
            autoTypeDetect?: boolean;
            country?: string;
            customFields?: { readonly [key: string]: string };
            faxOptions?: { fileIds: readonly string[] };
            from?: string;
            imageId?: string;
            kakaoOptions?: {
                adFlag?: boolean;
                bms?: {
                    additionalContent?: string;
                    adult?: boolean;
                    buttons?: readonly (
                        | {
                            linkMobile: string;
                            linkPc?: string;
                            linkType: "WL";
                            name: string;
                            targetOut?: boolean;
                        }
                        | {
                            linkAndroid?: string;
                            linkIos?: string;
                            linkMobile?: string;
                            linkType: "AL";
                            name: string;
                            targetOut?: boolean;
                        }
                        | { linkType: "AC"; name?: string }
                        | { chatExtra?: string; linkType: "BK"; name: string }
                        | { chatExtra?: string; linkType: "MD"; name: string }
                        | { chatExtra?: string; linkType: "BC"; name: string }
                        | { chatExtra?: string; linkType: "BT"; name: string }
                        | { linkType: "BF"; name: string }
                    )[];
                    carousel?:
                        | {
                            list: readonly {
                                buttons: readonly ((...) | (...))[];
                                content: string;
                                coupon?: {
                                    description: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile?: ...;
                                    linkPc?: ...;
                                    title: ...;
                                };
                                header: string;
                                imageId: string;
                                imageLink?: string;
                            }[];
                            tail?: {
                                linkAndroid?: string;
                                linkIos?: string;
                                linkMobile: string;
                                linkPc?: string;
                            };
                        }
                        | {
                            head?: {
                                content: string;
                                header: string;
                                imageId: string;
                                linkAndroid?: string;
                                linkIos?: string;
                                linkMobile?: string;
                                linkPc?: string;
                            };
                            list: readonly {
                                additionalContent?: string;
                                buttons: readonly ((...) | (...))[];
                                commerce: {
                                    discountFixed?: (...) | (...);
                                    discountPrice?: (...) | (...);
                                    discountRate?: (...) | (...);
                                    regularPrice: number;
                                    title: string;
                                };
                                coupon?: {
                                    description: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile?: ...;
                                    linkPc?: ...;
                                    title: ...;
                                };
                                imageId: string;
                                imageLink?: string;
                            }[];
                            tail?: {
                                linkAndroid?: string;
                                linkIos?: string;
                                linkMobile: string;
                                linkPc?: string;
                            };
                        };
                    chatBubbleType: | "TEXT"
                    | "IMAGE"
                    | "WIDE"
                    | "WIDE_ITEM_LIST"
                    | "COMMERCE"
                    | "CAROUSEL_FEED"
                    | "CAROUSEL_COMMERCE"
                    | "PREMIUM_VIDEO";
                    commerce?: {
                        discountFixed?: number;
                        discountPrice?: number;
                        discountRate?: number;
                        regularPrice: number;
                        title: string;
                    };
                    content?: string;
                    coupon?: {
                        description: string;
                        linkAndroid?: string;
                        linkIos?: string;
                        linkMobile?: string;
                        linkPc?: string;
                        title: string;
                    };
                    header?: string;
                    imageId?: string;
                    imageLink?: string;
                    mainWideItem?: {
                        imageId: string;
                        linkAndroid?: string;
                        linkIos?: string;
                        linkMobile: string;
                        linkPc?: string;
                        title?: string;
                    };
                    subWideItemList?: readonly {
                        imageId: string;
                        linkAndroid?: string;
                        linkIos?: string;
                        linkMobile: string;
                        linkPc?: string;
                        title: string;
                    }[];
                    targeting: "I"
                    | "M"
                    | "N";
                    video?: { imageId?: string; imageLink?: string; videoUrl: string };
                };
                buttons?: readonly (
                    | {
                        buttonName: string;
                        buttonType: "WL";
                        linkMo: string;
                        linkPc?: string
                        | null;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AL";
                        linkAnd: string;
                        linkIos: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "BK"
                        | "MD"
                        | "DS"
                        | "BC"
                        | "BT"
                        | "AC";
                    }
                )[];
                disableSms?: boolean;
                imageId?: string;
                pfId: string;
                templateId?: string;
                variables?: { readonly [key: string]: string };
            };
            naverOptions?: {
                buttons?: readonly {
                    buttonName: string;
                    buttonType: string;
                    linkAnd?: string;
                    linkIos?: string;
                    linkMo?: string;
                    linkPc?: string;
                }[];
                disableSms?: boolean;
                talkId: string;
                templateId: string;
                variables?: { readonly [key: string]: string };
            };
            rcsOptions?: {
                additionalBody?: {
                    buttons?: readonly (
                        | { buttonName: string; buttonType: "WL"; link: string }
                        | {
                            buttonName: string;
                            buttonType: "ML";
                            latitude: string;
                            longitude: string;
                        }
                        | {
                            buttonName: string;
                            buttonType: "MQ"
                            | "MR"
                            | "CA"
                            | "CL"
                            | "DL"
                            | "MS";
                            link: string;
                        }
                    )[];
                    description: string;
                    imaggeId?: string;
                    title: string;
                };
                brandId: string;
                buttons?: readonly (
                    | { buttonName: string; buttonType: "WL"; link: string }
                    | {
                        buttonName: string;
                        buttonType: "ML";
                        latitude: string;
                        longitude: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "MQ"
                        | "MR"
                        | "CA"
                        | "CL"
                        | "DL"
                        | "MS";
                        link: string;
                    }
                )[];
                commercialType?: boolean;
                copyAllowed?: boolean;
                disableSms?: boolean;
                mmsType?: "M3"
                | "S3"
                | "M4"
                | "S4"
                | "M5"
                | "S5"
                | "M6"
                | "S6";
                templateId?: string;
                variables?: { readonly [key: string]: string };
            };
            replacements?: readonly {}[];
            subject?: string;
            text?: string;
            to: string
            | readonly string[];
            type?:
                | "SMS"
                | "LMS"
                | "MMS"
                | "ATA"
                | "CTA"
                | "CTI"
                | "NSA"
                | "RCS_SMS"
                | "RCS_LMS"
                | "RCS_MMS"
                | "RCS_TPL"
                | "RCS_ITPL"
                | "RCS_LTPL"
                | "FAX"
                | "VOICE"
                | "BMS_TEXT"
                | "BMS_IMAGE"
                | "BMS_WIDE"
                | "BMS_WIDE_ITEM_LIST"
                | "BMS_CAROUSEL_FEED"
                | "BMS_PREMIUM_VIDEO"
                | "BMS_COMMERCE"
                | "BMS_CAROUSEL_COMMERCE"
                | "BMS_FREE";
            voiceOptions?: {
                counselorNumber?: string;
                headerMessage?: string;
                replyRange?: 1
                | 2
                | 3
                | 4
                | 5
                | 6
                | 7
                | 8
                | 9;
                tailMessage?: string;
                voiceType: "FEMALE" | "MALE";
            };
        }

      Returns Message

    Properties

    autoTypeDetect?: boolean

    메시지 타입 감지 여부(비활성화 시 반드시 타입이 명시 되어야 함)

    country?: string

    해외 문자 발송을 위한 국가번호(예) "82", "1" 등)

    customFields?: Record<string, string>

    사용자를 위한 사용자만의 커스텀 값을 입력할 수 있는 필드 단, 오브젝트 내 키 값 모두 문자열 형태로 입력되어야 합니다.

    dateCreated?: string

    메시지 생성일자

    dateUpdated?: string

    메시지 수정일자

    faxOptions?: FileIds
    from?: string

    발신번호

    groupId?: string

    메시지의 그룹 ID

    imageId?: string

    MMS 전용 스토리지(이미지) ID

    kakaoOptions?: KakaoOption

    카카오 알림톡/친구톡을 위한 프로퍼티

    log?: readonly object[]

    메시지 로그

    messageId?: string

    해당 메시지의 ID

    rcsOptions?: RcsOption

    RCS 메시지를 위한 프로퍼티

    replacements?: readonly object[]
    statusCode?: string

    메시지 상태 코드

    https://developers.solapi.com/references/message-status-codes

    subject?: string

    문자 제목(LMS, MMS 전용)

    Optionaltext

    text?: string

    메시지 내용

    to: string | readonly string[]

    수신번호

    type?: MessageType

    MessageType 메시지 유형

    voiceOptions?: {
        counselorNumber?: string;
        headerMessage?: string;
        replyRange?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
        tailMessage?: string;
        voiceType: "FEMALE" | "MALE";
    }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties