solapi
    Preparing search index...

    Class SolapiMessageService

    SOLAPI 메시지 서비스 발송 및 조회 등 SOLAPI에서 제공되는 여러 API의 기능을 쉽게 사용할 수 있습니다. SOLAPI 자체의 서비스에 관한 사항은 SOLAPI 홈페이지를 참고해주세요.

    Index

    Constructors

    Properties

    addMessagesToGroup: (
        groupId: string,
        messages:
            | {
                autoTypeDetect?: boolean;
                country?: string;
                customFields?: { readonly [key: string]: string };
                faxOptions?: { fileIds: readonly string[] };
                imageId?: string;
                kakaoOptions?: {
                    adFlag?: boolean;
                    bms?: {
                        additionalContent?: string;
                        adult?: boolean;
                        buttons?: readonly (
                            (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                        )[];
                        carousel?:
                            | { list: readonly (...)[]; tail?: (...) | (...) }
                            | {
                                head?: (...) | (...);
                                list: readonly (...)[];
                                tail?: (...) | (...);
                            };
                        chatBubbleType: | "TEXT"
                        | "IMAGE"
                        | "WIDE"
                        | "WIDE_ITEM_LIST"
                        | "COMMERCE"
                        | "CAROUSEL_FEED"
                        | "CAROUSEL_COMMERCE"
                        | "PREMIUM_VIDEO";
                        commerce?: {
                            discountFixed?: (...)
                            | (...);
                            discountPrice?: (...) | (...);
                            discountRate?: (...) | (...);
                            regularPrice: number;
                            title: string;
                        };
                        content?: string;
                        coupon?: {
                            description: string;
                            linkAndroid?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMobile?: (...) | (...);
                            linkPc?: (...) | (...);
                            title: string;
                        };
                        header?: string;
                        imageId?: string;
                        imageLink?: string;
                        mainWideItem?: {
                            imageId: string;
                            linkAndroid?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMobile: string;
                            linkPc?: (...) | (...);
                            title?: (...) | (...);
                        };
                        subWideItemList?: readonly {
                            imageId: ...;
                            linkAndroid?: ...;
                            linkIos?: ...;
                            linkMobile: ...;
                            linkPc?: ...;
                            title: ...;
                        }[];
                        targeting: "I"
                        | "M"
                        | "N";
                        video?: {
                            imageId?: (...) | (...);
                            imageLink?: (...) | (...);
                            videoUrl: string;
                        };
                    };
                    buttons?: readonly (
                        | {
                            buttonName: string;
                            buttonType: "WL";
                            linkMo: string;
                            linkPc?: (...)
                            | (...)
                            | (...);
                        }
                        | {
                            buttonName: string;
                            buttonType: "AL";
                            linkAnd: string;
                            linkIos: string;
                        }
                        | {
                            buttonName: string;
                            buttonType: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        }
                    )[];
                    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 ((...) | (...) | (...))[];
                        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: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            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;
                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?: 2
                    | 1
                    | 3
                    | 4
                    | 5
                    | 6
                    | 7
                    | 8
                    | 9;
                    tailMessage?: string;
                    voiceType: "FEMALE" | "MALE";
                };
            } & { from?: string; to: string
            | readonly string[] }
            | readonly (
                {
                    autoTypeDetect?: boolean;
                    country?: string;
                    customFields?: { readonly [key: string]: string };
                    faxOptions?: { fileIds: readonly string[] };
                    imageId?: string;
                    kakaoOptions?: {
                        adFlag?: boolean;
                        bms?: {
                            additionalContent?: string;
                            adult?: boolean;
                            buttons?: readonly (...)[];
                            carousel?:
                                | { list: ...; tail?: ... }
                                | { head?: ...; list: ...; tail?: ... };
                            chatBubbleType:
                                | "TEXT"
                                | "IMAGE"
                                | "WIDE"
                                | "WIDE_ITEM_LIST"
                                | "COMMERCE"
                                | "CAROUSEL_FEED"
                                | "CAROUSEL_COMMERCE"
                                | "PREMIUM_VIDEO";
                            commerce?: {
                                discountFixed?: ...;
                                discountPrice?: ...;
                                discountRate?: ...;
                                regularPrice: ...;
                                title: ...;
                            };
                            content?: string;
                            coupon?: {
                                description: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile?: ...;
                                linkPc?: ...;
                                title: ...;
                            };
                            header?: string;
                            imageId?: string;
                            imageLink?: string;
                            mainWideItem?: {
                                imageId: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                                title?: ...;
                            };
                            subWideItemList?: readonly (...)[];
                            targeting: "I" | "M" | "N";
                            video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                        };
                        buttons?: readonly (
                            | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                            | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                            | { buttonName: ...; buttonType: ... }
                        )[];
                        disableSms?: boolean;
                        imageId?: string;
                        pfId: string;
                        templateId?: string;
                        variables?: { readonly [key: string]: string };
                    };
                    naverOptions?: {
                        buttons?: readonly {
                            buttonName: string;
                            buttonType: string;
                            linkAnd?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMo?: (...) | (...);
                            linkPc?: (...) | (...);
                        }[];
                        disableSms?: boolean;
                        talkId: string;
                        templateId: string;
                        variables?: { readonly [key: string]: string };
                    };
                    rcsOptions?: {
                        additionalBody?: {
                            buttons?: readonly (...)[];
                            description: string;
                            imaggeId?: string;
                            title: string;
                        };
                        brandId: string;
                        buttons?: readonly (
                            | { buttonName: ...; buttonType: ...; link: ... }
                            | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                            | { buttonName: ...; buttonType: ...; link: ... }
                        )[];
                        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;
                    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?: 2
                        | 1
                        | 3
                        | 4
                        | 5
                        | 6
                        | 7
                        | 8
                        | 9;
                        tailMessage?: string;
                        voiceType: "FEMALE" | "MALE";
                    };
                } & { from?: string; to: string
                | readonly string[] }
            )[],
    ) => Promise<
        {
            errorCount: string;
            resultList: readonly {
                accountId: string;
                country: string;
                customFields?: { readonly [key: string]: string };
                from: string;
                messageId: string;
                statusCode: string;
                statusMessage: string;
                to: string;
                type: string;
            }[];
        },
    >

    그룹 메시지 추가 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다. 추가 가능한 최대 메시지 건 수는 1,000,000건 입니다.

    Type Declaration

      • (
            groupId: string,
            messages:
                | {
                    autoTypeDetect?: boolean;
                    country?: string;
                    customFields?: { readonly [key: string]: string };
                    faxOptions?: { fileIds: readonly string[] };
                    imageId?: string;
                    kakaoOptions?: {
                        adFlag?: boolean;
                        bms?: {
                            additionalContent?: string;
                            adult?: boolean;
                            buttons?: readonly (
                                (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                            )[];
                            carousel?:
                                | { list: readonly (...)[]; tail?: (...) | (...) }
                                | {
                                    head?: (...) | (...);
                                    list: readonly (...)[];
                                    tail?: (...) | (...);
                                };
                            chatBubbleType: | "TEXT"
                            | "IMAGE"
                            | "WIDE"
                            | "WIDE_ITEM_LIST"
                            | "COMMERCE"
                            | "CAROUSEL_FEED"
                            | "CAROUSEL_COMMERCE"
                            | "PREMIUM_VIDEO";
                            commerce?: {
                                discountFixed?: (...)
                                | (...);
                                discountPrice?: (...) | (...);
                                discountRate?: (...) | (...);
                                regularPrice: number;
                                title: string;
                            };
                            content?: string;
                            coupon?: {
                                description: string;
                                linkAndroid?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMobile?: (...) | (...);
                                linkPc?: (...) | (...);
                                title: string;
                            };
                            header?: string;
                            imageId?: string;
                            imageLink?: string;
                            mainWideItem?: {
                                imageId: string;
                                linkAndroid?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMobile: string;
                                linkPc?: (...) | (...);
                                title?: (...) | (...);
                            };
                            subWideItemList?: readonly {
                                imageId: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                                title: ...;
                            }[];
                            targeting: "I"
                            | "M"
                            | "N";
                            video?: {
                                imageId?: (...) | (...);
                                imageLink?: (...) | (...);
                                videoUrl: string;
                            };
                        };
                        buttons?: readonly (
                            | {
                                buttonName: string;
                                buttonType: "WL";
                                linkMo: string;
                                linkPc?: (...)
                                | (...)
                                | (...);
                            }
                            | {
                                buttonName: string;
                                buttonType: "AL";
                                linkAnd: string;
                                linkIos: string;
                            }
                            | {
                                buttonName: string;
                                buttonType: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            }
                        )[];
                        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 ((...) | (...) | (...))[];
                            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: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                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;
                    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?: 2
                        | 1
                        | 3
                        | 4
                        | 5
                        | 6
                        | 7
                        | 8
                        | 9;
                        tailMessage?: string;
                        voiceType: "FEMALE" | "MALE";
                    };
                } & { from?: string; to: string
                | readonly string[] }
                | readonly (
                    {
                        autoTypeDetect?: boolean;
                        country?: string;
                        customFields?: { readonly [key: string]: string };
                        faxOptions?: { fileIds: readonly string[] };
                        imageId?: string;
                        kakaoOptions?: {
                            adFlag?: boolean;
                            bms?: {
                                additionalContent?: string;
                                adult?: boolean;
                                buttons?: readonly (...)[];
                                carousel?:
                                    | { list: ...; tail?: ... }
                                    | { head?: ...; list: ...; tail?: ... };
                                chatBubbleType:
                                    | "TEXT"
                                    | "IMAGE"
                                    | "WIDE"
                                    | "WIDE_ITEM_LIST"
                                    | "COMMERCE"
                                    | "CAROUSEL_FEED"
                                    | "CAROUSEL_COMMERCE"
                                    | "PREMIUM_VIDEO";
                                commerce?: {
                                    discountFixed?: ...;
                                    discountPrice?: ...;
                                    discountRate?: ...;
                                    regularPrice: ...;
                                    title: ...;
                                };
                                content?: string;
                                coupon?: {
                                    description: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile?: ...;
                                    linkPc?: ...;
                                    title: ...;
                                };
                                header?: string;
                                imageId?: string;
                                imageLink?: string;
                                mainWideItem?: {
                                    imageId: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile: ...;
                                    linkPc?: ...;
                                    title?: ...;
                                };
                                subWideItemList?: readonly (...)[];
                                targeting: "I" | "M" | "N";
                                video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                            };
                            buttons?: readonly (
                                | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                                | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                                | { buttonName: ...; buttonType: ... }
                            )[];
                            disableSms?: boolean;
                            imageId?: string;
                            pfId: string;
                            templateId?: string;
                            variables?: { readonly [key: string]: string };
                        };
                        naverOptions?: {
                            buttons?: readonly {
                                buttonName: string;
                                buttonType: string;
                                linkAnd?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMo?: (...) | (...);
                                linkPc?: (...) | (...);
                            }[];
                            disableSms?: boolean;
                            talkId: string;
                            templateId: string;
                            variables?: { readonly [key: string]: string };
                        };
                        rcsOptions?: {
                            additionalBody?: {
                                buttons?: readonly (...)[];
                                description: string;
                                imaggeId?: string;
                                title: string;
                            };
                            brandId: string;
                            buttons?: readonly (
                                | { buttonName: ...; buttonType: ...; link: ... }
                                | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                                | { buttonName: ...; buttonType: ...; link: ... }
                            )[];
                            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;
                        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?: 2
                            | 1
                            | 3
                            | 4
                            | 5
                            | 6
                            | 7
                            | 8
                            | 9;
                            tailMessage?: string;
                            voiceType: "FEMALE" | "MALE";
                        };
                    } & { from?: string; to: string
                    | readonly string[] }
                )[],
        ): Promise<
            {
                errorCount: string;
                resultList: readonly {
                    accountId: string;
                    country: string;
                    customFields?: { readonly [key: string]: string };
                    from: string;
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                    to: string;
                    type: string;
                }[];
            },
        >
      • 그룹 메시지 추가 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다. 추가 가능한 최대 메시지 건 수는 1,000,000건 입니다.

        Parameters

        • groupId: string

          생성 된 Group ID

        • messages:
              | {
                  autoTypeDetect?: boolean;
                  country?: string;
                  customFields?: { readonly [key: string]: string };
                  faxOptions?: { fileIds: readonly string[] };
                  imageId?: string;
                  kakaoOptions?: {
                      adFlag?: boolean;
                      bms?: {
                          additionalContent?: string;
                          adult?: boolean;
                          buttons?: readonly (
                              (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                          )[];
                          carousel?:
                              | { list: readonly (...)[]; tail?: (...) | (...) }
                              | {
                                  head?: (...) | (...);
                                  list: readonly (...)[];
                                  tail?: (...) | (...);
                              };
                          chatBubbleType: | "TEXT"
                          | "IMAGE"
                          | "WIDE"
                          | "WIDE_ITEM_LIST"
                          | "COMMERCE"
                          | "CAROUSEL_FEED"
                          | "CAROUSEL_COMMERCE"
                          | "PREMIUM_VIDEO";
                          commerce?: {
                              discountFixed?: (...)
                              | (...);
                              discountPrice?: (...) | (...);
                              discountRate?: (...) | (...);
                              regularPrice: number;
                              title: string;
                          };
                          content?: string;
                          coupon?: {
                              description: string;
                              linkAndroid?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMobile?: (...) | (...);
                              linkPc?: (...) | (...);
                              title: string;
                          };
                          header?: string;
                          imageId?: string;
                          imageLink?: string;
                          mainWideItem?: {
                              imageId: string;
                              linkAndroid?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMobile: string;
                              linkPc?: (...) | (...);
                              title?: (...) | (...);
                          };
                          subWideItemList?: readonly {
                              imageId: ...;
                              linkAndroid?: ...;
                              linkIos?: ...;
                              linkMobile: ...;
                              linkPc?: ...;
                              title: ...;
                          }[];
                          targeting: "I"
                          | "M"
                          | "N";
                          video?: {
                              imageId?: (...) | (...);
                              imageLink?: (...) | (...);
                              videoUrl: string;
                          };
                      };
                      buttons?: readonly (
                          | {
                              buttonName: string;
                              buttonType: "WL";
                              linkMo: string;
                              linkPc?: (...)
                              | (...)
                              | (...);
                          }
                          | {
                              buttonName: string;
                              buttonType: "AL";
                              linkAnd: string;
                              linkIos: string;
                          }
                          | {
                              buttonName: string;
                              buttonType: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          }
                      )[];
                      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 ((...) | (...) | (...))[];
                          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: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                              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;
                  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?: 2
                      | 1
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9;
                      tailMessage?: string;
                      voiceType: "FEMALE" | "MALE";
                  };
              } & { from?: string; to: string
              | readonly string[] }
              | readonly (
                  {
                      autoTypeDetect?: boolean;
                      country?: string;
                      customFields?: { readonly [key: string]: string };
                      faxOptions?: { fileIds: readonly string[] };
                      imageId?: string;
                      kakaoOptions?: {
                          adFlag?: boolean;
                          bms?: {
                              additionalContent?: string;
                              adult?: boolean;
                              buttons?: readonly (...)[];
                              carousel?:
                                  | { list: ...; tail?: ... }
                                  | { head?: ...; list: ...; tail?: ... };
                              chatBubbleType:
                                  | "TEXT"
                                  | "IMAGE"
                                  | "WIDE"
                                  | "WIDE_ITEM_LIST"
                                  | "COMMERCE"
                                  | "CAROUSEL_FEED"
                                  | "CAROUSEL_COMMERCE"
                                  | "PREMIUM_VIDEO";
                              commerce?: {
                                  discountFixed?: ...;
                                  discountPrice?: ...;
                                  discountRate?: ...;
                                  regularPrice: ...;
                                  title: ...;
                              };
                              content?: string;
                              coupon?: {
                                  description: ...;
                                  linkAndroid?: ...;
                                  linkIos?: ...;
                                  linkMobile?: ...;
                                  linkPc?: ...;
                                  title: ...;
                              };
                              header?: string;
                              imageId?: string;
                              imageLink?: string;
                              mainWideItem?: {
                                  imageId: ...;
                                  linkAndroid?: ...;
                                  linkIos?: ...;
                                  linkMobile: ...;
                                  linkPc?: ...;
                                  title?: ...;
                              };
                              subWideItemList?: readonly (...)[];
                              targeting: "I" | "M" | "N";
                              video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                          };
                          buttons?: readonly (
                              | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                              | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                              | { buttonName: ...; buttonType: ... }
                          )[];
                          disableSms?: boolean;
                          imageId?: string;
                          pfId: string;
                          templateId?: string;
                          variables?: { readonly [key: string]: string };
                      };
                      naverOptions?: {
                          buttons?: readonly {
                              buttonName: string;
                              buttonType: string;
                              linkAnd?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMo?: (...) | (...);
                              linkPc?: (...) | (...);
                          }[];
                          disableSms?: boolean;
                          talkId: string;
                          templateId: string;
                          variables?: { readonly [key: string]: string };
                      };
                      rcsOptions?: {
                          additionalBody?: {
                              buttons?: readonly (...)[];
                              description: string;
                              imaggeId?: string;
                              title: string;
                          };
                          brandId: string;
                          buttons?: readonly (
                              | { buttonName: ...; buttonType: ...; link: ... }
                              | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                              | { buttonName: ...; buttonType: ...; link: ... }
                          )[];
                          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;
                      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?: 2
                          | 1
                          | 3
                          | 4
                          | 5
                          | 6
                          | 7
                          | 8
                          | 9;
                          tailMessage?: string;
                          voiceType: "FEMALE" | "MALE";
                      };
                  } & { from?: string; to: string
                  | readonly string[] }
              )[]

          여러 메시지(문자, 알림톡 등)

        Returns Promise<
            {
                errorCount: string;
                resultList: readonly {
                    accountId: string;
                    country: string;
                    customFields?: { readonly [key: string]: string };
                    from: string;
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                    to: string;
                    type: string;
                }[];
            },
        >

    생성 된 Group ID

    여러 메시지(문자, 알림톡 등)

    cancelInspectionKakaoAlimtalkTemplate: (
        templateId: string,
    ) => Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 검수 취소 요청

    Type Declaration

    카카오 알림톡 템플릿 ID

    createGroup: (
        allowDuplicates?: boolean,
        appId?: string,
        customFields?: Record<string, string>,
    ) => Promise<string>

    그룹 생성

    Type Declaration

      • (
            allowDuplicates?: boolean,
            appId?: string,
            customFields?: Record<string, string>,
        ): Promise<string>
      • 그룹 생성

        Parameters

        • allowDuplicates: boolean = false

          생성할 그룹이 중복 수신번호를 허용하는지 여부를 확인합니다.

        • OptionalappId: string

          생성할 그룹에 특정 appId를 넣을 수 있습니다.

        • OptionalcustomFields: Record<string, string>

          생성할 그룹에 사용자 정의 데이터를 Record 형태로 삽입할 수 있습니다.

        Returns Promise<string>

    생성할 그룹이 중복 수신번호를 허용하는지 여부를 확인합니다.

    생성할 그룹에 특정 appId를 넣을 수 있습니다.

    생성할 그룹에 사용자 정의 데이터를 Record 형태로 삽입할 수 있습니다.

    createKakaoAlimtalkTemplate: (
        data:
            | {
                buttons?: readonly (
                    | {
                        buttonName: string;
                        buttonType: "WL";
                        linkMo: string;
                        linkPc?: string
                        | null;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AL";
                        linkAnd: string;
                        linkIos: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AC"
                        | "BK"
                        | "MD"
                        | "BC"
                        | "BT"
                        | "DS";
                    }
                )[];
                categoryCode: string;
                content: string;
                emphasizeSubTitle?: string;
                emphasizeTitle?: string;
                emphasizeType?: "TEXT"
                | "IMAGE"
                | "NONE"
                | "ITEM_LIST";
                extra?: string;
                header?: string;
                highlight?: {
                    description?: string | null;
                    imageId?: string | null;
                    title?: string | null;
                };
                imageId?: string;
                item?: {
                    list: readonly { description: string; title: string }[];
                    summary: { description?: string | null; title?: string | null };
                };
                messageType?: "BA"
                | "EX"
                | "AD"
                | "MI";
                name: string;
                quickReplies?: readonly (
                    | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                    | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                    | { linkType: "BK" | "BC" | "BT"; name: string }
                )[];
                securityFlag?: boolean;
            } & { channelId: string }
            | {
                buttons?: readonly (
                    | {
                        buttonName: string;
                        buttonType: "WL";
                        linkMo: string;
                        linkPc?: string
                        | null;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AL";
                        linkAnd: string;
                        linkIos: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AC"
                        | "BK"
                        | "MD"
                        | "BC"
                        | "BT"
                        | "DS";
                    }
                )[];
                categoryCode: string;
                content: string;
                emphasizeSubTitle?: string;
                emphasizeTitle?: string;
                emphasizeType?: "TEXT"
                | "IMAGE"
                | "NONE"
                | "ITEM_LIST";
                extra?: string;
                header?: string;
                highlight?: {
                    description?: string | null;
                    imageId?: string | null;
                    title?: string | null;
                };
                imageId?: string;
                item?: {
                    list: readonly { description: string; title: string }[];
                    summary: { description?: string | null; title?: string | null };
                };
                messageType?: "BA"
                | "EX"
                | "AD"
                | "MI";
                name: string;
                quickReplies?: readonly (
                    | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                    | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                    | { linkType: "BK" | "BC" | "BT"; name: string }
                )[];
                securityFlag?: boolean;
            } & { channelGroupId: string },
    ) => Promise<KakaoAlimtalkTemplate>

    Type Declaration

      • (
            data:
                | {
                    buttons?: readonly (
                        | {
                            buttonName: string;
                            buttonType: "WL";
                            linkMo: string;
                            linkPc?: string
                            | null;
                        }
                        | {
                            buttonName: string;
                            buttonType: "AL";
                            linkAnd: string;
                            linkIos: string;
                        }
                        | {
                            buttonName: string;
                            buttonType: "AC"
                            | "BK"
                            | "MD"
                            | "BC"
                            | "BT"
                            | "DS";
                        }
                    )[];
                    categoryCode: string;
                    content: string;
                    emphasizeSubTitle?: string;
                    emphasizeTitle?: string;
                    emphasizeType?: "TEXT"
                    | "IMAGE"
                    | "NONE"
                    | "ITEM_LIST";
                    extra?: string;
                    header?: string;
                    highlight?: {
                        description?: string | null;
                        imageId?: string | null;
                        title?: string | null;
                    };
                    imageId?: string;
                    item?: {
                        list: readonly { description: string; title: string }[];
                        summary: { description?: string | null; title?: string | null };
                    };
                    messageType?: "BA"
                    | "EX"
                    | "AD"
                    | "MI";
                    name: string;
                    quickReplies?: readonly (
                        | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                        | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                        | { linkType: "BK" | "BC" | "BT"; name: string }
                    )[];
                    securityFlag?: boolean;
                } & { channelId: string }
                | {
                    buttons?: readonly (
                        | {
                            buttonName: string;
                            buttonType: "WL";
                            linkMo: string;
                            linkPc?: string
                            | null;
                        }
                        | {
                            buttonName: string;
                            buttonType: "AL";
                            linkAnd: string;
                            linkIos: string;
                        }
                        | {
                            buttonName: string;
                            buttonType: "AC"
                            | "BK"
                            | "MD"
                            | "BC"
                            | "BT"
                            | "DS";
                        }
                    )[];
                    categoryCode: string;
                    content: string;
                    emphasizeSubTitle?: string;
                    emphasizeTitle?: string;
                    emphasizeType?: "TEXT"
                    | "IMAGE"
                    | "NONE"
                    | "ITEM_LIST";
                    extra?: string;
                    header?: string;
                    highlight?: {
                        description?: string | null;
                        imageId?: string | null;
                        title?: string | null;
                    };
                    imageId?: string;
                    item?: {
                        list: readonly { description: string; title: string }[];
                        summary: { description?: string | null; title?: string | null };
                    };
                    messageType?: "BA"
                    | "EX"
                    | "AD"
                    | "MI";
                    name: string;
                    quickReplies?: readonly (
                        | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                        | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                        | { linkType: "BK" | "BC" | "BT"; name: string }
                    )[];
                    securityFlag?: boolean;
                } & { channelGroupId: string },
        ): Promise<KakaoAlimtalkTemplate>
      • Parameters

        • data:
              | {
                  buttons?: readonly (
                      | {
                          buttonName: string;
                          buttonType: "WL";
                          linkMo: string;
                          linkPc?: string
                          | null;
                      }
                      | {
                          buttonName: string;
                          buttonType: "AL";
                          linkAnd: string;
                          linkIos: string;
                      }
                      | {
                          buttonName: string;
                          buttonType: "AC"
                          | "BK"
                          | "MD"
                          | "BC"
                          | "BT"
                          | "DS";
                      }
                  )[];
                  categoryCode: string;
                  content: string;
                  emphasizeSubTitle?: string;
                  emphasizeTitle?: string;
                  emphasizeType?: "TEXT"
                  | "IMAGE"
                  | "NONE"
                  | "ITEM_LIST";
                  extra?: string;
                  header?: string;
                  highlight?: {
                      description?: string | null;
                      imageId?: string | null;
                      title?: string | null;
                  };
                  imageId?: string;
                  item?: {
                      list: readonly { description: string; title: string }[];
                      summary: { description?: string | null; title?: string | null };
                  };
                  messageType?: "BA"
                  | "EX"
                  | "AD"
                  | "MI";
                  name: string;
                  quickReplies?: readonly (
                      | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                      | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                      | { linkType: "BK" | "BC" | "BT"; name: string }
                  )[];
                  securityFlag?: boolean;
              } & { channelId: string }
              | {
                  buttons?: readonly (
                      | {
                          buttonName: string;
                          buttonType: "WL";
                          linkMo: string;
                          linkPc?: string
                          | null;
                      }
                      | {
                          buttonName: string;
                          buttonType: "AL";
                          linkAnd: string;
                          linkIos: string;
                      }
                      | {
                          buttonName: string;
                          buttonType: "AC"
                          | "BK"
                          | "MD"
                          | "BC"
                          | "BT"
                          | "DS";
                      }
                  )[];
                  categoryCode: string;
                  content: string;
                  emphasizeSubTitle?: string;
                  emphasizeTitle?: string;
                  emphasizeType?: "TEXT"
                  | "IMAGE"
                  | "NONE"
                  | "ITEM_LIST";
                  extra?: string;
                  header?: string;
                  highlight?: {
                      description?: string | null;
                      imageId?: string | null;
                      title?: string | null;
                  };
                  imageId?: string;
                  item?: {
                      list: readonly { description: string; title: string }[];
                      summary: { description?: string | null; title?: string | null };
                  };
                  messageType?: "BA"
                  | "EX"
                  | "AD"
                  | "MI";
                  name: string;
                  quickReplies?: readonly (
                      | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                      | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                      | { linkType: "BK" | "BC" | "BT"; name: string }
                  )[];
                  securityFlag?: boolean;
              } & { channelGroupId: string }

        Returns Promise<KakaoAlimtalkTemplate>

        카카오 알림톡 템플릿 생성

    카카오 알림톡 템플릿 생성 반드시 getKakaoAlimtalkTemplateCategories를 먼저 호출하여 카테고리 값을 확인해야 합니다!

    알림톡 템플릿 생성을 위한 파라미터

    createKakaoChannel: (
        data: {
            categoryCode: string;
            phoneNumber: string;
            searchId: string;
            token: string;
        },
    ) => Promise<
        {
            accountId: string;
            channelId: string;
            dateCreated: string;
            dateUpdated: string;
            phoneNumber: string;
            searchId: string;
        },
    >

    카카오 채널 연동 메소드 getKakaoChannelCategories, requestKakaoChannelToken 메소드를 선행적으로 호출해야 합니다!

    getBalance: () => Promise<
        {
            accountId?: string;
            autoRecharge?: number;
            balance: number;
            balanceOnly?: number;
            deposit?: number;
            lowBalanceAlert?: {
                balances: readonly number[];
                channels: readonly string[];
                currentBalance: string;
                enabled: boolean;
                notificationBalance: string;
            };
            minimumCash?: number;
            point: number;
            rechargeTo?: number;
            rechargeTryCount?: number;
        },
    >

    잔액조회

    Type Declaration

      • (): Promise<
            {
                accountId?: string;
                autoRecharge?: number;
                balance: number;
                balanceOnly?: number;
                deposit?: number;
                lowBalanceAlert?: {
                    balances: readonly number[];
                    channels: readonly string[];
                    currentBalance: string;
                    enabled: boolean;
                    notificationBalance: string;
                };
                minimumCash?: number;
                point: number;
                rechargeTo?: number;
                rechargeTryCount?: number;
            },
        >
      • 잔액조회

        Returns Promise<
            {
                accountId?: string;
                autoRecharge?: number;
                balance: number;
                balanceOnly?: number;
                deposit?: number;
                lowBalanceAlert?: {
                    balances: readonly number[];
                    channels: readonly string[];
                    currentBalance: string;
                    enabled: boolean;
                    notificationBalance: string;
                };
                minimumCash?: number;
                point: number;
                rechargeTo?: number;
                rechargeTryCount?: number;
            },
        >

        GetBalanceResponse

    GetBalanceResponse

    getBlacks: (
        data?: {
            endDate?: string | Date;
            limit?: number;
            senderNumber?: string;
            startDate?: string | Date;
            startKey?: string;
        },
    ) => Promise<
        {
            blackList: readonly {
                dateCreated: string;
                dateUpdated: string;
                handleKey: string;
                recipientNumber: string;
                senderNumber: string;
                type: "DENIAL";
            }[];
            limit: number;
            nextKey: string
            | null
            | undefined;
            startKey: string | null | undefined;
        },
    >

    080 수신 거부 조회

    Type Declaration

      • (
            data?: {
                endDate?: string | Date;
                limit?: number;
                senderNumber?: string;
                startDate?: string | Date;
                startKey?: string;
            },
        ): Promise<
            {
                blackList: readonly {
                    dateCreated: string;
                    dateUpdated: string;
                    handleKey: string;
                    recipientNumber: string;
                    senderNumber: string;
                    type: "DENIAL";
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >
      • 080 수신 거부 조회

        Parameters

        • Optionaldata: {
              endDate?: string | Date;
              limit?: number;
              senderNumber?: string;
              startDate?: string | Date;
              startKey?: string;
          }

          080 수신 거부 상세 조회용 request 데이터

        Returns Promise<
            {
                blackList: readonly {
                    dateCreated: string;
                    dateUpdated: string;
                    handleKey: string;
                    recipientNumber: string;
                    senderNumber: string;
                    type: "DENIAL";
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >

        GetBlacksResponse

    080 수신 거부 상세 조회용 request 데이터

    GetBlacksResponse

    getBlockGroups: (
        data?: {
            blockGroupId?: string;
            limit?: number;
            name?: string | { like: string };
            senderNumber?: string;
            startKey?: string;
            status?: "INACTIVE" | "ACTIVE";
            useAll?: boolean;
        },
    ) => Promise<
        {
            blockGroups: readonly {
                accountId: string;
                blockGroupId: string;
                dateCreated: string;
                dateUpdated: string;
                name: string
                | null
                | undefined;
                senderNumbers: readonly string[];
                status: "INACTIVE" | "ACTIVE";
                useAll: boolean;
            }[];
            limit: number;
            nextKey: string
            | null
            | undefined;
            startKey: string | null | undefined;
        },
    >

    수신 거부 그룹 조회

    Type Declaration

      • (
            data?: {
                blockGroupId?: string;
                limit?: number;
                name?: string | { like: string };
                senderNumber?: string;
                startKey?: string;
                status?: "INACTIVE" | "ACTIVE";
                useAll?: boolean;
            },
        ): Promise<
            {
                blockGroups: readonly {
                    accountId: string;
                    blockGroupId: string;
                    dateCreated: string;
                    dateUpdated: string;
                    name: string
                    | null
                    | undefined;
                    senderNumbers: readonly string[];
                    status: "INACTIVE" | "ACTIVE";
                    useAll: boolean;
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >
      • 수신 거부 그룹 조회

        Parameters

        • Optionaldata: {
              blockGroupId?: string;
              limit?: number;
              name?: string | { like: string };
              senderNumber?: string;
              startKey?: string;
              status?: "INACTIVE" | "ACTIVE";
              useAll?: boolean;
          }

          수신 거부 그룹 조회용 request 데이터

        Returns Promise<
            {
                blockGroups: readonly {
                    accountId: string;
                    blockGroupId: string;
                    dateCreated: string;
                    dateUpdated: string;
                    name: string
                    | null
                    | undefined;
                    senderNumbers: readonly string[];
                    status: "INACTIVE" | "ACTIVE";
                    useAll: boolean;
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >

        GetBlockGroupsResponse

    수신 거부 그룹 조회용 request 데이터

    GetBlockGroupsResponse

    getBlockNumbers: (
        data?: {
            blockGroupId?: string;
            blockNumberId?: string;
            limit?: number;
            memo?: string | { like: string };
            phoneNumber?: string;
            startKey?: string;
        },
    ) => Promise<
        {
            blockNumbers: readonly {
                accountId: string;
                blockGroupIds: readonly string[];
                blockNumberId: string;
                dateCreated: string;
                dateUpdated: string;
                memo: string;
                phoneNumber: string;
            }[];
            limit: number;
            nextKey: string
            | null
            | undefined;
            startKey: string | null | undefined;
        },
    >

    수신 거부 번호 조회

    Type Declaration

      • (
            data?: {
                blockGroupId?: string;
                blockNumberId?: string;
                limit?: number;
                memo?: string | { like: string };
                phoneNumber?: string;
                startKey?: string;
            },
        ): Promise<
            {
                blockNumbers: readonly {
                    accountId: string;
                    blockGroupIds: readonly string[];
                    blockNumberId: string;
                    dateCreated: string;
                    dateUpdated: string;
                    memo: string;
                    phoneNumber: string;
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >
      • 수신 거부 번호 조회

        Parameters

        • Optionaldata: {
              blockGroupId?: string;
              blockNumberId?: string;
              limit?: number;
              memo?: string | { like: string };
              phoneNumber?: string;
              startKey?: string;
          }

          수신 거부 번호 상세 조회용 request 데이터

        Returns Promise<
            {
                blockNumbers: readonly {
                    accountId: string;
                    blockGroupIds: readonly string[];
                    blockNumberId: string;
                    dateCreated: string;
                    dateUpdated: string;
                    memo: string;
                    phoneNumber: string;
                }[];
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >

        GetBlockNumbersResponse

    수신 거부 번호 상세 조회용 request 데이터

    GetBlockNumbersResponse

    getGroup: (
        groupId: string,
    ) => Promise<
        {
            accountId: string;
            allowDuplicates: boolean;
            apiVersion: string;
            app: {
                appId: string
                | null
                | undefined;
                profit: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    voice?: number;
                };
            };
            balance: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            count: {
                refund: number;
                registeredFailed: number;
                registeredSuccess: number;
                sentFailed: number;
                sentPending: number;
                sentReplacement: number;
                sentSuccess: number;
                sentTotal: number;
                total: number;
            };
            countForCharge: {
                ata: { readonly [key: string]: number };
                bms_carousel_commerce?: { readonly [key: string]: number };
                bms_carousel_feed?: { readonly [key: string]: number };
                bms_commerce?: { readonly [key: string]: number };
                bms_free?: { readonly [key: string]: number };
                bms_image?: { readonly [key: string]: number };
                bms_premium_video?: { readonly [key: string]: number };
                bms_text?: { readonly [key: string]: number };
                bms_wide?: { readonly [key: string]: number };
                bms_wide_item_list?: { readonly [key: string]: number };
                cta: { readonly [key: string]: number };
                cti: { readonly [key: string]: number };
                fax?: { readonly [key: string]: number };
                lms: { readonly [key: string]: number };
                mms: { readonly [key: string]: number };
                nsa: { readonly [key: string]: number };
                rcs_itpl?: { readonly [key: string]: number };
                rcs_lms: { readonly [key: string]: number };
                rcs_ltpl?: { readonly [key: string]: number };
                rcs_mms: { readonly [key: string]: number };
                rcs_sms: { readonly [key: string]: number };
                rcs_tpl: { readonly [key: string]: number };
                sms: { readonly [key: string]: number };
                voice?: { readonly [key: string]: number };
            };
            dateCompleted: string
            | null
            | undefined;
            dateCreated: string;
            dateSent: string | null | undefined;
            dateUpdated: string;
            groupId: string;
            isRefunded: boolean;
            log: readonly { readonly [key: string]: unknown }[];
            masterAccountId: string | null;
            point: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            price: { readonly [key: string]: unknown };
            scheduledDate: string | null | undefined;
            status: string;
        },
    >

    단일 그룹정보 조회

    Type Declaration

      • (
            groupId: string,
        ): Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >
      • 단일 그룹정보 조회

        Parameters

        • groupId: string

          그룹 ID

        Returns Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >

    그룹 ID

    getGroupMessages: (
        groupId: string,
        data?: { limit?: number; startKey?: string },
    ) => Promise<
        {
            limit: number;
            messageList: {
                readonly [key: string]: {
                    _id?: string;
                    accountId?: string;
                    autoTypeDetect?: boolean;
                    clusterKey: string
                    | null
                    | undefined;
                    country: string | null | undefined;
                    currentQueue?: unknown;
                    customFields?: { readonly [key: string]: string } | null;
                    dateCreated?: string;
                    dateProcessed: string | null | undefined;
                    dateReceived: string | null | undefined;
                    dateReported: string | null | undefined;
                    dateUpdated?: string;
                    faxOptions?: { readonly [key: string]: unknown } | null;
                    faxPageCount?: number | null;
                    from: string | null | undefined;
                    groupId?: string;
                    imageId: string | null | undefined;
                    kakaoOptions?: { readonly [key: string]: unknown } | null;
                    log?: readonly unknown[] | null;
                    messageId?: string;
                    naverOptions?: { readonly [key: string]: unknown } | null;
                    networkCode: string | null | undefined;
                    networkName: string | null | undefined;
                    queues?: readonly unknown[] | null;
                    rcsOptions?: { readonly [key: string]: unknown } | null;
                    reason: string | null | undefined;
                    replacement?: boolean;
                    replacements?: readonly unknown[] | null;
                    resendCount?: number;
                    status: string | null | undefined;
                    statusCode: string | null | undefined;
                    subject: string | null | undefined;
                    text: string | null | undefined;
                    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"
                        | null
                        | undefined;
                    unavailableSenderNumber?: boolean
                    | null;
                    voiceDuration?: number | null;
                    voiceOptions?: { readonly [key: string]: unknown } | null;
                    voiceReplied?: boolean | null;
                };
            };
            nextKey?: string
            | null;
            startKey?: string | null;
        },
    >

    그룹 내 메시지 목록 조회

    Type Declaration

      • (
            groupId: string,
            data?: { limit?: number; startKey?: string },
        ): Promise<
            {
                limit: number;
                messageList: {
                    readonly [key: string]: {
                        _id?: string;
                        accountId?: string;
                        autoTypeDetect?: boolean;
                        clusterKey: string
                        | null
                        | undefined;
                        country: string | null | undefined;
                        currentQueue?: unknown;
                        customFields?: { readonly [key: string]: string } | null;
                        dateCreated?: string;
                        dateProcessed: string | null | undefined;
                        dateReceived: string | null | undefined;
                        dateReported: string | null | undefined;
                        dateUpdated?: string;
                        faxOptions?: { readonly [key: string]: unknown } | null;
                        faxPageCount?: number | null;
                        from: string | null | undefined;
                        groupId?: string;
                        imageId: string | null | undefined;
                        kakaoOptions?: { readonly [key: string]: unknown } | null;
                        log?: readonly unknown[] | null;
                        messageId?: string;
                        naverOptions?: { readonly [key: string]: unknown } | null;
                        networkCode: string | null | undefined;
                        networkName: string | null | undefined;
                        queues?: readonly unknown[] | null;
                        rcsOptions?: { readonly [key: string]: unknown } | null;
                        reason: string | null | undefined;
                        replacement?: boolean;
                        replacements?: readonly unknown[] | null;
                        resendCount?: number;
                        status: string | null | undefined;
                        statusCode: string | null | undefined;
                        subject: string | null | undefined;
                        text: string | null | undefined;
                        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"
                            | null
                            | undefined;
                        unavailableSenderNumber?: boolean
                        | null;
                        voiceDuration?: number | null;
                        voiceOptions?: { readonly [key: string]: unknown } | null;
                        voiceReplied?: boolean | null;
                    };
                };
                nextKey?: string
                | null;
                startKey?: string | null;
            },
        >
      • 그룹 내 메시지 목록 조회

        Parameters

        • groupId: string

          생성 된 Group ID

        • Optionaldata: { limit?: number; startKey?: string }

          startkey, limit 등 쿼리 조건 파라미터

        Returns Promise<
            {
                limit: number;
                messageList: {
                    readonly [key: string]: {
                        _id?: string;
                        accountId?: string;
                        autoTypeDetect?: boolean;
                        clusterKey: string
                        | null
                        | undefined;
                        country: string | null | undefined;
                        currentQueue?: unknown;
                        customFields?: { readonly [key: string]: string } | null;
                        dateCreated?: string;
                        dateProcessed: string | null | undefined;
                        dateReceived: string | null | undefined;
                        dateReported: string | null | undefined;
                        dateUpdated?: string;
                        faxOptions?: { readonly [key: string]: unknown } | null;
                        faxPageCount?: number | null;
                        from: string | null | undefined;
                        groupId?: string;
                        imageId: string | null | undefined;
                        kakaoOptions?: { readonly [key: string]: unknown } | null;
                        log?: readonly unknown[] | null;
                        messageId?: string;
                        naverOptions?: { readonly [key: string]: unknown } | null;
                        networkCode: string | null | undefined;
                        networkName: string | null | undefined;
                        queues?: readonly unknown[] | null;
                        rcsOptions?: { readonly [key: string]: unknown } | null;
                        reason: string | null | undefined;
                        replacement?: boolean;
                        replacements?: readonly unknown[] | null;
                        resendCount?: number;
                        status: string | null | undefined;
                        statusCode: string | null | undefined;
                        subject: string | null | undefined;
                        text: string | null | undefined;
                        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"
                            | null
                            | undefined;
                        unavailableSenderNumber?: boolean
                        | null;
                        voiceDuration?: number | null;
                        voiceOptions?: { readonly [key: string]: unknown } | null;
                        voiceReplied?: boolean | null;
                    };
                };
                nextKey?: string
                | null;
                startKey?: string | null;
            },
        >

    생성 된 Group ID

    startkey, limit 등 쿼리 조건 파라미터

    getGroups: (
        data?: {
            endDate?: string | Date;
            groupId?: string;
            limit?: number;
            startDate?: string | Date;
            startKey?: string;
        },
    ) => Promise<
        {
            groupList: {
                readonly [key: string]: {
                    accountId: string;
                    app: {
                        appId: string
                        | null
                        | undefined;
                        profit: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            voice?: number;
                        };
                    };
                    balance: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    count: {
                        refund: number;
                        registeredFailed: number;
                        registeredSuccess: number;
                        sentFailed: number;
                        sentPending: number;
                        sentReplacement: number;
                        sentSuccess: number;
                        sentTotal: number;
                        total: number;
                    };
                    countForCharge: {
                        ata: { readonly [key: string]: number };
                        bms_carousel_commerce?: { readonly [key: string]: number };
                        bms_carousel_feed?: { readonly [key: string]: number };
                        bms_commerce?: { readonly [key: string]: number };
                        bms_free?: { readonly [key: string]: number };
                        bms_image?: { readonly [key: string]: number };
                        bms_premium_video?: { readonly [key: string]: number };
                        bms_text?: { readonly [key: string]: number };
                        bms_wide?: { readonly [key: string]: number };
                        bms_wide_item_list?: { readonly [key: string]: number };
                        cta: { readonly [key: string]: number };
                        cti: { readonly [key: string]: number };
                        fax?: { readonly [key: string]: number };
                        lms: { readonly [key: string]: number };
                        mms: { readonly [key: string]: number };
                        nsa: { readonly [key: string]: number };
                        rcs_itpl?: { readonly [key: string]: number };
                        rcs_lms: { readonly [key: string]: number };
                        rcs_ltpl?: { readonly [key: string]: number };
                        rcs_mms: { readonly [key: string]: number };
                        rcs_sms: { readonly [key: string]: number };
                        rcs_tpl: { readonly [key: string]: number };
                        sms: { readonly [key: string]: number };
                        voice?: { readonly [key: string]: number };
                    };
                    dateCompleted: string
                    | null
                    | undefined;
                    dateCreated: string;
                    dateSent: string | null | undefined;
                    dateUpdated: string;
                    groupId: string;
                    isRefunded: boolean;
                    log: readonly { readonly [key: string]: unknown }[];
                    osPlatform: string | null | undefined;
                    point: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    scheduledDate: string
                    | null
                    | undefined;
                    sdkVersion: string | null | undefined;
                    status: string;
                };
            };
            limit: number;
            nextKey: string
            | null
            | undefined;
            startKey: string | null | undefined;
        },
    >

    그룹 목록 정보 조회

    Type Declaration

      • (
            data?: {
                endDate?: string | Date;
                groupId?: string;
                limit?: number;
                startDate?: string | Date;
                startKey?: string;
            },
        ): Promise<
            {
                groupList: {
                    readonly [key: string]: {
                        accountId: string;
                        app: {
                            appId: string
                            | null
                            | undefined;
                            profit: {
                                ata: number;
                                bms_carousel_commerce?: number;
                                bms_carousel_feed?: number;
                                bms_commerce?: number;
                                bms_free?: number;
                                bms_image?: number;
                                bms_premium_video?: number;
                                bms_text?: number;
                                bms_wide?: number;
                                bms_wide_item_list?: number;
                                cta: number;
                                cti: number;
                                fax?: number;
                                lms: number;
                                mms: number;
                                nsa: number;
                                rcs_itpl?: number;
                                rcs_lms: number;
                                rcs_ltpl?: number;
                                rcs_mms: number;
                                rcs_sms: number;
                                rcs_tpl: number;
                                sms: number;
                                voice?: number;
                            };
                        };
                        balance: {
                            refund: number;
                            replacement: number;
                            requested: number;
                            sum: number;
                        };
                        count: {
                            refund: number;
                            registeredFailed: number;
                            registeredSuccess: number;
                            sentFailed: number;
                            sentPending: number;
                            sentReplacement: number;
                            sentSuccess: number;
                            sentTotal: number;
                            total: number;
                        };
                        countForCharge: {
                            ata: { readonly [key: string]: number };
                            bms_carousel_commerce?: { readonly [key: string]: number };
                            bms_carousel_feed?: { readonly [key: string]: number };
                            bms_commerce?: { readonly [key: string]: number };
                            bms_free?: { readonly [key: string]: number };
                            bms_image?: { readonly [key: string]: number };
                            bms_premium_video?: { readonly [key: string]: number };
                            bms_text?: { readonly [key: string]: number };
                            bms_wide?: { readonly [key: string]: number };
                            bms_wide_item_list?: { readonly [key: string]: number };
                            cta: { readonly [key: string]: number };
                            cti: { readonly [key: string]: number };
                            fax?: { readonly [key: string]: number };
                            lms: { readonly [key: string]: number };
                            mms: { readonly [key: string]: number };
                            nsa: { readonly [key: string]: number };
                            rcs_itpl?: { readonly [key: string]: number };
                            rcs_lms: { readonly [key: string]: number };
                            rcs_ltpl?: { readonly [key: string]: number };
                            rcs_mms: { readonly [key: string]: number };
                            rcs_sms: { readonly [key: string]: number };
                            rcs_tpl: { readonly [key: string]: number };
                            sms: { readonly [key: string]: number };
                            voice?: { readonly [key: string]: number };
                        };
                        dateCompleted: string
                        | null
                        | undefined;
                        dateCreated: string;
                        dateSent: string | null | undefined;
                        dateUpdated: string;
                        groupId: string;
                        isRefunded: boolean;
                        log: readonly { readonly [key: string]: unknown }[];
                        osPlatform: string | null | undefined;
                        point: {
                            refund: number;
                            replacement: number;
                            requested: number;
                            sum: number;
                        };
                        scheduledDate: string
                        | null
                        | undefined;
                        sdkVersion: string | null | undefined;
                        status: string;
                    };
                };
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >
      • 그룹 목록 정보 조회

        Parameters

        • Optionaldata: {
              endDate?: string | Date;
              groupId?: string;
              limit?: number;
              startDate?: string | Date;
              startKey?: string;
          }

          그룹 정보 상세 조회용 request 데이터

        Returns Promise<
            {
                groupList: {
                    readonly [key: string]: {
                        accountId: string;
                        app: {
                            appId: string
                            | null
                            | undefined;
                            profit: {
                                ata: number;
                                bms_carousel_commerce?: number;
                                bms_carousel_feed?: number;
                                bms_commerce?: number;
                                bms_free?: number;
                                bms_image?: number;
                                bms_premium_video?: number;
                                bms_text?: number;
                                bms_wide?: number;
                                bms_wide_item_list?: number;
                                cta: number;
                                cti: number;
                                fax?: number;
                                lms: number;
                                mms: number;
                                nsa: number;
                                rcs_itpl?: number;
                                rcs_lms: number;
                                rcs_ltpl?: number;
                                rcs_mms: number;
                                rcs_sms: number;
                                rcs_tpl: number;
                                sms: number;
                                voice?: number;
                            };
                        };
                        balance: {
                            refund: number;
                            replacement: number;
                            requested: number;
                            sum: number;
                        };
                        count: {
                            refund: number;
                            registeredFailed: number;
                            registeredSuccess: number;
                            sentFailed: number;
                            sentPending: number;
                            sentReplacement: number;
                            sentSuccess: number;
                            sentTotal: number;
                            total: number;
                        };
                        countForCharge: {
                            ata: { readonly [key: string]: number };
                            bms_carousel_commerce?: { readonly [key: string]: number };
                            bms_carousel_feed?: { readonly [key: string]: number };
                            bms_commerce?: { readonly [key: string]: number };
                            bms_free?: { readonly [key: string]: number };
                            bms_image?: { readonly [key: string]: number };
                            bms_premium_video?: { readonly [key: string]: number };
                            bms_text?: { readonly [key: string]: number };
                            bms_wide?: { readonly [key: string]: number };
                            bms_wide_item_list?: { readonly [key: string]: number };
                            cta: { readonly [key: string]: number };
                            cti: { readonly [key: string]: number };
                            fax?: { readonly [key: string]: number };
                            lms: { readonly [key: string]: number };
                            mms: { readonly [key: string]: number };
                            nsa: { readonly [key: string]: number };
                            rcs_itpl?: { readonly [key: string]: number };
                            rcs_lms: { readonly [key: string]: number };
                            rcs_ltpl?: { readonly [key: string]: number };
                            rcs_mms: { readonly [key: string]: number };
                            rcs_sms: { readonly [key: string]: number };
                            rcs_tpl: { readonly [key: string]: number };
                            sms: { readonly [key: string]: number };
                            voice?: { readonly [key: string]: number };
                        };
                        dateCompleted: string
                        | null
                        | undefined;
                        dateCreated: string;
                        dateSent: string | null | undefined;
                        dateUpdated: string;
                        groupId: string;
                        isRefunded: boolean;
                        log: readonly { readonly [key: string]: unknown }[];
                        osPlatform: string | null | undefined;
                        point: {
                            refund: number;
                            replacement: number;
                            requested: number;
                            sum: number;
                        };
                        scheduledDate: string
                        | null
                        | undefined;
                        sdkVersion: string | null | undefined;
                        status: string;
                    };
                };
                limit: number;
                nextKey: string
                | null
                | undefined;
                startKey: string | null | undefined;
            },
        >

    그룹 정보 상세 조회용 request 데이터

    getKakaoAlimtalkTemplate: (templateId: string) => Promise<KakaoAlimtalkTemplate>

    카카오 템플릿 상세 조회

    Type Declaration

    카카오 알림톡 템플릿 ID

    getKakaoAlimtalkTemplateCategories: () => Promise<
        { code: string; name: string }[],
    >

    카카오 템플릿 카테고리 조회

    Type Declaration

      • (): Promise<{ code: string; name: string }[]>
      • 카카오 템플릿 카테고리 조회

        Returns Promise<{ code: string; name: string }[]>

    getKakaoAlimtalkTemplates: (
        data?: {
            channelId?: string;
            endDate?: string | Date;
            isHidden?: boolean;
            limit?: number;
            name?: string | { like: string } | { eq?: string; ne?: string };
            startDate?: string | Date;
            startKey?: string;
            status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
            templateId?: string;
        },
    ) => Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>

    카카오 템플릿 목록 조회

    Type Declaration

      • (
            data?: {
                channelId?: string;
                endDate?: string | Date;
                isHidden?: boolean;
                limit?: number;
                name?: string | { like: string } | { eq?: string; ne?: string };
                startDate?: string | Date;
                startKey?: string;
                status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
                templateId?: string;
            },
        ): Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>
      • 카카오 템플릿 목록 조회

        Parameters

        • Optionaldata: {
              channelId?: string;
              endDate?: string | Date;
              isHidden?: boolean;
              limit?: number;
              name?: string | { like: string } | { eq?: string; ne?: string };
              startDate?: string | Date;
              startKey?: string;
              status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
              templateId?: string;
          }

        Returns Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>

    카카오 템플릿 목록을 더 자세하게 조회할 때 필요한 파라미터

    getKakaoChannel: (channelId: string) => Promise<KakaoChannel>

    Type Declaration

      • (channelId: string): Promise<KakaoChannel>
      • Parameters

        • channelId: string

          카카오 채널 ID(구 pfId)

        Returns Promise<KakaoChannel>

    카카오 채널 조회

    getKakaoChannelCategories: () => Promise<{ code: string; name: string }[]>

    카카오 채널 카테고리 조회

    getKakaoChannels: (
        data?: {
            categoryCode?: string;
            channelId?: string;
            endDate?: string | Date;
            isMine?: boolean;
            limit?: number;
            phoneNumber?: string;
            searchId?: string;
            startDate?: string | Date;
            startKey?: string;
        },
    ) => Promise<GetKakaoChannelsFinalizeResponse>

    카카오 채널 목록 조회

    Type Declaration

      • (
            data?: {
                categoryCode?: string;
                channelId?: string;
                endDate?: string | Date;
                isMine?: boolean;
                limit?: number;
                phoneNumber?: string;
                searchId?: string;
                startDate?: string | Date;
                startKey?: string;
            },
        ): Promise<GetKakaoChannelsFinalizeResponse>
      • Parameters

        • Optionaldata: {
              categoryCode?: string;
              channelId?: string;
              endDate?: string | Date;
              isMine?: boolean;
              limit?: number;
              phoneNumber?: string;
              searchId?: string;
              startDate?: string | Date;
              startKey?: string;
          }

          카카오 채널 목록을 더 자세하게 조회할 때 필요한 파라미터

        Returns Promise<GetKakaoChannelsFinalizeResponse>

    getMessages: (
        data?: Readonly<GetMessagesRequest>,
    ) => Promise<
        {
            limit: number;
            messageList: {
                readonly [key: string]: {
                    _id?: string;
                    accountId?: string;
                    autoTypeDetect?: boolean;
                    clusterKey: string
                    | null
                    | undefined;
                    country: string | null | undefined;
                    currentQueue?: unknown;
                    customFields?: { readonly [key: string]: string } | null;
                    dateCreated?: string;
                    dateProcessed: string | null | undefined;
                    dateReceived: string | null | undefined;
                    dateReported: string | null | undefined;
                    dateUpdated?: string;
                    faxOptions?: { readonly [key: string]: unknown } | null;
                    faxPageCount?: number | null;
                    from: string | null | undefined;
                    groupId?: string;
                    imageId: string | null | undefined;
                    kakaoOptions?: { readonly [key: string]: unknown } | null;
                    log?: readonly unknown[] | null;
                    messageId?: string;
                    naverOptions?: { readonly [key: string]: unknown } | null;
                    networkCode: string | null | undefined;
                    networkName: string | null | undefined;
                    queues?: readonly unknown[] | null;
                    rcsOptions?: { readonly [key: string]: unknown } | null;
                    reason: string | null | undefined;
                    replacement?: boolean;
                    replacements?: readonly unknown[] | null;
                    resendCount?: number;
                    status: string | null | undefined;
                    statusCode: string | null | undefined;
                    subject: string | null | undefined;
                    text: string | null | undefined;
                    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"
                        | null
                        | undefined;
                    unavailableSenderNumber?: boolean
                    | null;
                    voiceDuration?: number | null;
                    voiceOptions?: { readonly [key: string]: unknown } | null;
                    voiceReplied?: boolean | null;
                };
            };
            nextKey?: string
            | null;
            startKey?: string | null;
        },
    >

    메시지 목록 조회

    Type Declaration

      • (
            data?: Readonly<GetMessagesRequest>,
        ): Promise<
            {
                limit: number;
                messageList: {
                    readonly [key: string]: {
                        _id?: string;
                        accountId?: string;
                        autoTypeDetect?: boolean;
                        clusterKey: string
                        | null
                        | undefined;
                        country: string | null | undefined;
                        currentQueue?: unknown;
                        customFields?: { readonly [key: string]: string } | null;
                        dateCreated?: string;
                        dateProcessed: string | null | undefined;
                        dateReceived: string | null | undefined;
                        dateReported: string | null | undefined;
                        dateUpdated?: string;
                        faxOptions?: { readonly [key: string]: unknown } | null;
                        faxPageCount?: number | null;
                        from: string | null | undefined;
                        groupId?: string;
                        imageId: string | null | undefined;
                        kakaoOptions?: { readonly [key: string]: unknown } | null;
                        log?: readonly unknown[] | null;
                        messageId?: string;
                        naverOptions?: { readonly [key: string]: unknown } | null;
                        networkCode: string | null | undefined;
                        networkName: string | null | undefined;
                        queues?: readonly unknown[] | null;
                        rcsOptions?: { readonly [key: string]: unknown } | null;
                        reason: string | null | undefined;
                        replacement?: boolean;
                        replacements?: readonly unknown[] | null;
                        resendCount?: number;
                        status: string | null | undefined;
                        statusCode: string | null | undefined;
                        subject: string | null | undefined;
                        text: string | null | undefined;
                        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"
                            | null
                            | undefined;
                        unavailableSenderNumber?: boolean
                        | null;
                        voiceDuration?: number | null;
                        voiceOptions?: { readonly [key: string]: unknown } | null;
                        voiceReplied?: boolean | null;
                    };
                };
                nextKey?: string
                | null;
                startKey?: string | null;
            },
        >
      • 메시지 목록 조회

        Parameters

        Returns Promise<
            {
                limit: number;
                messageList: {
                    readonly [key: string]: {
                        _id?: string;
                        accountId?: string;
                        autoTypeDetect?: boolean;
                        clusterKey: string
                        | null
                        | undefined;
                        country: string | null | undefined;
                        currentQueue?: unknown;
                        customFields?: { readonly [key: string]: string } | null;
                        dateCreated?: string;
                        dateProcessed: string | null | undefined;
                        dateReceived: string | null | undefined;
                        dateReported: string | null | undefined;
                        dateUpdated?: string;
                        faxOptions?: { readonly [key: string]: unknown } | null;
                        faxPageCount?: number | null;
                        from: string | null | undefined;
                        groupId?: string;
                        imageId: string | null | undefined;
                        kakaoOptions?: { readonly [key: string]: unknown } | null;
                        log?: readonly unknown[] | null;
                        messageId?: string;
                        naverOptions?: { readonly [key: string]: unknown } | null;
                        networkCode: string | null | undefined;
                        networkName: string | null | undefined;
                        queues?: readonly unknown[] | null;
                        rcsOptions?: { readonly [key: string]: unknown } | null;
                        reason: string | null | undefined;
                        replacement?: boolean;
                        replacements?: readonly unknown[] | null;
                        resendCount?: number;
                        status: string | null | undefined;
                        statusCode: string | null | undefined;
                        subject: string | null | undefined;
                        text: string | null | undefined;
                        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"
                            | null
                            | undefined;
                        unavailableSenderNumber?: boolean
                        | null;
                        voiceDuration?: number | null;
                        voiceOptions?: { readonly [key: string]: unknown } | null;
                        voiceReplied?: boolean | null;
                    };
                };
                nextKey?: string
                | null;
                startKey?: string | null;
            },
        >

    목록 조회 상세조건 파라미터

    getStatistics: (
        data?: Readonly<
            {
                endDate?: string
                | Date;
                masterAccountId?: string;
                startDate?: string | Date;
            },
        >,
    ) => Promise<
        {
            balance: number;
            dailyBalanceAvg?: number;
            dailyFailedCountAvg?: number;
            dailyPointAvg?: number;
            dailySuccessedCountAvg?: number;
            dailyTotalCountAvg?: number;
            deposit?: number;
            failed: {
                ata: number;
                bms_carousel_commerce?: number;
                bms_carousel_feed?: number;
                bms_commerce?: number;
                bms_free?: number;
                bms_image?: number;
                bms_premium_video?: number;
                bms_text?: number;
                bms_wide?: number;
                bms_wide_item_list?: number;
                cta: number;
                cti: number;
                fax?: number;
                lms: number;
                mms: number;
                nsa: number;
                rcs_itpl?: number;
                rcs_lms: number;
                rcs_ltpl?: number;
                rcs_mms: number;
                rcs_sms: number;
                rcs_tpl: number;
                sms: number;
                total: number;
                voice?: number;
            };
            monthlyBalanceAvg: number;
            monthlyDepositAvg?: number;
            monthlyPointAvg: number;
            monthPeriod: readonly {
                balance: number;
                balanceAvg: number;
                date: string;
                dayPeriod: readonly {
                    _id: string;
                    balance: number;
                    date?: string;
                    deposit?: number;
                    failed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    month: string;
                    point: number;
                    refund: { balance: number; deposit?: number; point: number };
                    statusCode: {
                        readonly [key: string]: {
                            ata?: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta?: number;
                            cti?: number;
                            fax?: number;
                            lms?: number;
                            mms?: number;
                            nsa?: number;
                            rcs_itpl?: number;
                            rcs_lms?: number;
                            rcs_ltpl?: number;
                            rcs_mms?: number;
                            rcs_sms?: number;
                            rcs_tpl?: number;
                            sms?: number;
                            voice?: number;
                        };
                    };
                    successed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    total: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                }[];
                deposit?: number;
                depositAvg?: number;
                failed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                point: number;
                pointAvg: number;
                refund?: {
                    balance: number;
                    balanceAvg: number;
                    deposit?: number;
                    depositAvg?: number;
                    point: number;
                    pointAvg: number;
                };
                successed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                total: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
            }[];
            point: number;
            successed: {
                ata: number;
                bms_carousel_commerce?: number;
                bms_carousel_feed?: number;
                bms_commerce?: number;
                bms_free?: number;
                bms_image?: number;
                bms_premium_video?: number;
                bms_text?: number;
                bms_wide?: number;
                bms_wide_item_list?: number;
                cta: number;
                cti: number;
                fax?: number;
                lms: number;
                mms: number;
                nsa: number;
                rcs_itpl?: number;
                rcs_lms: number;
                rcs_ltpl?: number;
                rcs_mms: number;
                rcs_sms: number;
                rcs_tpl: number;
                sms: number;
                total: number;
                voice?: number;
            };
            total: {
                ata: number;
                bms_carousel_commerce?: number;
                bms_carousel_feed?: number;
                bms_commerce?: number;
                bms_free?: number;
                bms_image?: number;
                bms_premium_video?: number;
                bms_text?: number;
                bms_wide?: number;
                bms_wide_item_list?: number;
                cta: number;
                cti: number;
                fax?: number;
                lms: number;
                mms: number;
                nsa: number;
                rcs_itpl?: number;
                rcs_lms: number;
                rcs_ltpl?: number;
                rcs_mms: number;
                rcs_sms: number;
                rcs_tpl: number;
                sms: number;
                total: number;
                voice?: number;
            };
        },
    >

    통계 조회

    Type Declaration

      • (
            data?: Readonly<
                {
                    endDate?: string
                    | Date;
                    masterAccountId?: string;
                    startDate?: string | Date;
                },
            >,
        ): Promise<
            {
                balance: number;
                dailyBalanceAvg?: number;
                dailyFailedCountAvg?: number;
                dailyPointAvg?: number;
                dailySuccessedCountAvg?: number;
                dailyTotalCountAvg?: number;
                deposit?: number;
                failed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                monthlyBalanceAvg: number;
                monthlyDepositAvg?: number;
                monthlyPointAvg: number;
                monthPeriod: readonly {
                    balance: number;
                    balanceAvg: number;
                    date: string;
                    dayPeriod: readonly {
                        _id: string;
                        balance: number;
                        date?: string;
                        deposit?: number;
                        failed: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                        month: string;
                        point: number;
                        refund: { balance: number; deposit?: number; point: number };
                        statusCode: {
                            readonly [key: string]: {
                                ata?: number;
                                bms_carousel_commerce?: number;
                                bms_carousel_feed?: number;
                                bms_commerce?: number;
                                bms_free?: number;
                                bms_image?: number;
                                bms_premium_video?: number;
                                bms_text?: number;
                                bms_wide?: number;
                                bms_wide_item_list?: number;
                                cta?: number;
                                cti?: number;
                                fax?: number;
                                lms?: number;
                                mms?: number;
                                nsa?: number;
                                rcs_itpl?: number;
                                rcs_lms?: number;
                                rcs_ltpl?: number;
                                rcs_mms?: number;
                                rcs_sms?: number;
                                rcs_tpl?: number;
                                sms?: number;
                                voice?: number;
                            };
                        };
                        successed: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                        total: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                    }[];
                    deposit?: number;
                    depositAvg?: number;
                    failed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    point: number;
                    pointAvg: number;
                    refund?: {
                        balance: number;
                        balanceAvg: number;
                        deposit?: number;
                        depositAvg?: number;
                        point: number;
                        pointAvg: number;
                    };
                    successed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    total: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                }[];
                point: number;
                successed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                total: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
            },
        >
      • 통계 조회

        Parameters

        • Optionaldata: Readonly<
              {
                  endDate?: string
                  | Date;
                  masterAccountId?: string;
                  startDate?: string | Date;
              },
          >

          통계 상세 조건 파라미터

        Returns Promise<
            {
                balance: number;
                dailyBalanceAvg?: number;
                dailyFailedCountAvg?: number;
                dailyPointAvg?: number;
                dailySuccessedCountAvg?: number;
                dailyTotalCountAvg?: number;
                deposit?: number;
                failed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                monthlyBalanceAvg: number;
                monthlyDepositAvg?: number;
                monthlyPointAvg: number;
                monthPeriod: readonly {
                    balance: number;
                    balanceAvg: number;
                    date: string;
                    dayPeriod: readonly {
                        _id: string;
                        balance: number;
                        date?: string;
                        deposit?: number;
                        failed: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                        month: string;
                        point: number;
                        refund: { balance: number; deposit?: number; point: number };
                        statusCode: {
                            readonly [key: string]: {
                                ata?: number;
                                bms_carousel_commerce?: number;
                                bms_carousel_feed?: number;
                                bms_commerce?: number;
                                bms_free?: number;
                                bms_image?: number;
                                bms_premium_video?: number;
                                bms_text?: number;
                                bms_wide?: number;
                                bms_wide_item_list?: number;
                                cta?: number;
                                cti?: number;
                                fax?: number;
                                lms?: number;
                                mms?: number;
                                nsa?: number;
                                rcs_itpl?: number;
                                rcs_lms?: number;
                                rcs_ltpl?: number;
                                rcs_mms?: number;
                                rcs_sms?: number;
                                rcs_tpl?: number;
                                sms?: number;
                                voice?: number;
                            };
                        };
                        successed: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                        total: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            total: number;
                            voice?: number;
                        };
                    }[];
                    deposit?: number;
                    depositAvg?: number;
                    failed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    point: number;
                    pointAvg: number;
                    refund?: {
                        balance: number;
                        balanceAvg: number;
                        deposit?: number;
                        depositAvg?: number;
                        point: number;
                        pointAvg: number;
                    };
                    successed: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                    total: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        total: number;
                        voice?: number;
                    };
                }[];
                point: number;
                successed: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
                total: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    total: number;
                    voice?: number;
                };
            },
        >

        GetStatisticsResponse 통계 결과

    통계 상세 조건 파라미터

    GetStatisticsResponse 통계 결과

    removeGroup: (
        groupId: string,
    ) => Promise<
        {
            accountId: string;
            allowDuplicates: boolean;
            apiVersion: string;
            app: {
                appId: string
                | null
                | undefined;
                profit: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    voice?: number;
                };
            };
            balance: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            count: {
                refund: number;
                registeredFailed: number;
                registeredSuccess: number;
                sentFailed: number;
                sentPending: number;
                sentReplacement: number;
                sentSuccess: number;
                sentTotal: number;
                total: number;
            };
            countForCharge: {
                ata: { readonly [key: string]: number };
                bms_carousel_commerce?: { readonly [key: string]: number };
                bms_carousel_feed?: { readonly [key: string]: number };
                bms_commerce?: { readonly [key: string]: number };
                bms_free?: { readonly [key: string]: number };
                bms_image?: { readonly [key: string]: number };
                bms_premium_video?: { readonly [key: string]: number };
                bms_text?: { readonly [key: string]: number };
                bms_wide?: { readonly [key: string]: number };
                bms_wide_item_list?: { readonly [key: string]: number };
                cta: { readonly [key: string]: number };
                cti: { readonly [key: string]: number };
                fax?: { readonly [key: string]: number };
                lms: { readonly [key: string]: number };
                mms: { readonly [key: string]: number };
                nsa: { readonly [key: string]: number };
                rcs_itpl?: { readonly [key: string]: number };
                rcs_lms: { readonly [key: string]: number };
                rcs_ltpl?: { readonly [key: string]: number };
                rcs_mms: { readonly [key: string]: number };
                rcs_sms: { readonly [key: string]: number };
                rcs_tpl: { readonly [key: string]: number };
                sms: { readonly [key: string]: number };
                voice?: { readonly [key: string]: number };
            };
            dateCompleted: string
            | null
            | undefined;
            dateCreated: string;
            dateSent: string | null | undefined;
            dateUpdated: string;
            groupId: string;
            isRefunded: boolean;
            log: readonly { readonly [key: string]: unknown }[];
            masterAccountId: string | null;
            point: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            price: { readonly [key: string]: unknown };
            scheduledDate: string | null | undefined;
            status: string;
        },
    >

    그룹 삭제

    Type Declaration

      • (
            groupId: string,
        ): Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >
      • 그룹 삭제

        Parameters

        • groupId: string

        Returns Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >

    removeGroupMessages: (
        groupId: string,
        messageIds: string[],
    ) => Promise<
        {
            errorCount: number;
            groupId: string;
            resultList: readonly { messageId: string; resultCode: string }[];
        },
    >

    그룹 내 특정 메시지 삭제

    Type Declaration

      • (
            groupId: string,
            messageIds: string[],
        ): Promise<
            {
                errorCount: number;
                groupId: string;
                resultList: readonly { messageId: string; resultCode: string }[];
            },
        >
      • 그룹 내 특정 메시지 삭제

        Parameters

        • groupId: string

          생성 된 Group Id

        • messageIds: string[]

          생성 된 메시지 ID 목록

        Returns Promise<
            {
                errorCount: number;
                groupId: string;
                resultList: readonly { messageId: string; resultCode: string }[];
            },
        >

    생성 된 Group Id

    생성 된 메시지 ID 목록

    removeKakaoAlimtalkTemplate: (
        templateId: string,
    ) => Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 삭제(대기, 반려 상태일 때만 삭제가능)

    Type Declaration

    카카오 알림톡 템플릿 ID

    removeKakaoChannel: (channelId: string) => Promise<KakaoChannel>

    Type Declaration

    카카오 채널 삭제, 채널이 삭제 될 경우 해당 채널의 템플릿이 모두 삭제됩니다!

    removeReservationToGroup: (
        groupId: string,
    ) => Promise<
        {
            accountId: string;
            allowDuplicates: boolean;
            apiVersion: string;
            app: {
                appId: string
                | null
                | undefined;
                profit: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    voice?: number;
                };
            };
            balance: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            count: {
                refund: number;
                registeredFailed: number;
                registeredSuccess: number;
                sentFailed: number;
                sentPending: number;
                sentReplacement: number;
                sentSuccess: number;
                sentTotal: number;
                total: number;
            };
            countForCharge: {
                ata: { readonly [key: string]: number };
                bms_carousel_commerce?: { readonly [key: string]: number };
                bms_carousel_feed?: { readonly [key: string]: number };
                bms_commerce?: { readonly [key: string]: number };
                bms_free?: { readonly [key: string]: number };
                bms_image?: { readonly [key: string]: number };
                bms_premium_video?: { readonly [key: string]: number };
                bms_text?: { readonly [key: string]: number };
                bms_wide?: { readonly [key: string]: number };
                bms_wide_item_list?: { readonly [key: string]: number };
                cta: { readonly [key: string]: number };
                cti: { readonly [key: string]: number };
                fax?: { readonly [key: string]: number };
                lms: { readonly [key: string]: number };
                mms: { readonly [key: string]: number };
                nsa: { readonly [key: string]: number };
                rcs_itpl?: { readonly [key: string]: number };
                rcs_lms: { readonly [key: string]: number };
                rcs_ltpl?: { readonly [key: string]: number };
                rcs_mms: { readonly [key: string]: number };
                rcs_sms: { readonly [key: string]: number };
                rcs_tpl: { readonly [key: string]: number };
                sms: { readonly [key: string]: number };
                voice?: { readonly [key: string]: number };
            };
            dateCompleted: string
            | null
            | undefined;
            dateCreated: string;
            dateSent: string | null | undefined;
            dateUpdated: string;
            groupId: string;
            isRefunded: boolean;
            log: readonly { readonly [key: string]: unknown }[];
            masterAccountId: string | null;
            point: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            price: { readonly [key: string]: unknown };
            scheduledDate: string | null | undefined;
            status: string;
        },
    >

    그룹 내 예약 발송 취소(메시지 실패 전체 처리 됨)

    Type Declaration

      • (
            groupId: string,
        ): Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >
      • 그룹 내 예약 발송 취소(메시지 실패 전체 처리 됨)

        Parameters

        • groupId: string

          생성 된 Group ID

        Returns Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >

    생성 된 Group ID

    requestKakaoChannelToken: (
        data: { phoneNumber: string; searchId: string },
    ) => Promise<{ success: boolean }>

    카카오 채널 연동을 위한 인증 토큰 요청

    reserveGroup: (
        groupId: string,
        scheduledDate: string | Date,
    ) => Promise<
        {
            accountId: string;
            allowDuplicates: boolean;
            apiVersion: string;
            app: {
                appId: string
                | null
                | undefined;
                profit: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    voice?: number;
                };
            };
            balance: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            count: {
                refund: number;
                registeredFailed: number;
                registeredSuccess: number;
                sentFailed: number;
                sentPending: number;
                sentReplacement: number;
                sentSuccess: number;
                sentTotal: number;
                total: number;
            };
            countForCharge: {
                ata: { readonly [key: string]: number };
                bms_carousel_commerce?: { readonly [key: string]: number };
                bms_carousel_feed?: { readonly [key: string]: number };
                bms_commerce?: { readonly [key: string]: number };
                bms_free?: { readonly [key: string]: number };
                bms_image?: { readonly [key: string]: number };
                bms_premium_video?: { readonly [key: string]: number };
                bms_text?: { readonly [key: string]: number };
                bms_wide?: { readonly [key: string]: number };
                bms_wide_item_list?: { readonly [key: string]: number };
                cta: { readonly [key: string]: number };
                cti: { readonly [key: string]: number };
                fax?: { readonly [key: string]: number };
                lms: { readonly [key: string]: number };
                mms: { readonly [key: string]: number };
                nsa: { readonly [key: string]: number };
                rcs_itpl?: { readonly [key: string]: number };
                rcs_lms: { readonly [key: string]: number };
                rcs_ltpl?: { readonly [key: string]: number };
                rcs_mms: { readonly [key: string]: number };
                rcs_sms: { readonly [key: string]: number };
                rcs_tpl: { readonly [key: string]: number };
                sms: { readonly [key: string]: number };
                voice?: { readonly [key: string]: number };
            };
            dateCompleted: string
            | null
            | undefined;
            dateCreated: string;
            dateSent: string | null | undefined;
            dateUpdated: string;
            groupId: string;
            isRefunded: boolean;
            log: readonly { readonly [key: string]: unknown }[];
            masterAccountId: string | null;
            point: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            price: { readonly [key: string]: unknown };
            scheduledDate: string | null | undefined;
            status: string;
        },
    >

    그룹 예약 발송 설정

    Type Declaration

      • (
            groupId: string,
            scheduledDate: string | Date,
        ): Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >
      • 그룹 예약 발송 설정

        Parameters

        • groupId: string

          생성 된 Group ID

        • scheduledDate: string | Date

          예약발송 할 날짜

        Returns Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >

    생성 된 Group ID

    예약발송 할 날짜

    send: (
        messages:
            | {
                autoTypeDetect?: boolean;
                country?: string;
                customFields?: { readonly [key: string]: string };
                faxOptions?: { fileIds: readonly string[] };
                imageId?: string;
                kakaoOptions?: {
                    adFlag?: boolean;
                    bms?: {
                        additionalContent?: string;
                        adult?: boolean;
                        buttons?: readonly (
                            (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                        )[];
                        carousel?:
                            | { list: readonly (...)[]; tail?: (...) | (...) }
                            | {
                                head?: (...) | (...);
                                list: readonly (...)[];
                                tail?: (...) | (...);
                            };
                        chatBubbleType: | "TEXT"
                        | "IMAGE"
                        | "WIDE"
                        | "WIDE_ITEM_LIST"
                        | "COMMERCE"
                        | "CAROUSEL_FEED"
                        | "CAROUSEL_COMMERCE"
                        | "PREMIUM_VIDEO";
                        commerce?: {
                            discountFixed?: (...)
                            | (...);
                            discountPrice?: (...) | (...);
                            discountRate?: (...) | (...);
                            regularPrice: number;
                            title: string;
                        };
                        content?: string;
                        coupon?: {
                            description: string;
                            linkAndroid?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMobile?: (...) | (...);
                            linkPc?: (...) | (...);
                            title: string;
                        };
                        header?: string;
                        imageId?: string;
                        imageLink?: string;
                        mainWideItem?: {
                            imageId: string;
                            linkAndroid?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMobile: string;
                            linkPc?: (...) | (...);
                            title?: (...) | (...);
                        };
                        subWideItemList?: readonly {
                            imageId: ...;
                            linkAndroid?: ...;
                            linkIos?: ...;
                            linkMobile: ...;
                            linkPc?: ...;
                            title: ...;
                        }[];
                        targeting: "I"
                        | "M"
                        | "N";
                        video?: {
                            imageId?: (...) | (...);
                            imageLink?: (...) | (...);
                            videoUrl: string;
                        };
                    };
                    buttons?: readonly (
                        | {
                            buttonName: string;
                            buttonType: "WL";
                            linkMo: string;
                            linkPc?: (...)
                            | (...)
                            | (...);
                        }
                        | {
                            buttonName: string;
                            buttonType: "AL";
                            linkAnd: string;
                            linkIos: string;
                        }
                        | {
                            buttonName: string;
                            buttonType: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        }
                    )[];
                    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 ((...) | (...) | (...))[];
                        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: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            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;
                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?: 2
                    | 1
                    | 3
                    | 4
                    | 5
                    | 6
                    | 7
                    | 8
                    | 9;
                    tailMessage?: string;
                    voiceType: "FEMALE" | "MALE";
                };
            } & { from?: string; to: string
            | readonly string[] }
            | readonly (
                {
                    autoTypeDetect?: boolean;
                    country?: string;
                    customFields?: { readonly [key: string]: string };
                    faxOptions?: { fileIds: readonly string[] };
                    imageId?: string;
                    kakaoOptions?: {
                        adFlag?: boolean;
                        bms?: {
                            additionalContent?: string;
                            adult?: boolean;
                            buttons?: readonly (...)[];
                            carousel?:
                                | { list: ...; tail?: ... }
                                | { head?: ...; list: ...; tail?: ... };
                            chatBubbleType:
                                | "TEXT"
                                | "IMAGE"
                                | "WIDE"
                                | "WIDE_ITEM_LIST"
                                | "COMMERCE"
                                | "CAROUSEL_FEED"
                                | "CAROUSEL_COMMERCE"
                                | "PREMIUM_VIDEO";
                            commerce?: {
                                discountFixed?: ...;
                                discountPrice?: ...;
                                discountRate?: ...;
                                regularPrice: ...;
                                title: ...;
                            };
                            content?: string;
                            coupon?: {
                                description: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile?: ...;
                                linkPc?: ...;
                                title: ...;
                            };
                            header?: string;
                            imageId?: string;
                            imageLink?: string;
                            mainWideItem?: {
                                imageId: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                                title?: ...;
                            };
                            subWideItemList?: readonly (...)[];
                            targeting: "I" | "M" | "N";
                            video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                        };
                        buttons?: readonly (
                            | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                            | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                            | { buttonName: ...; buttonType: ... }
                        )[];
                        disableSms?: boolean;
                        imageId?: string;
                        pfId: string;
                        templateId?: string;
                        variables?: { readonly [key: string]: string };
                    };
                    naverOptions?: {
                        buttons?: readonly {
                            buttonName: string;
                            buttonType: string;
                            linkAnd?: (...)
                            | (...);
                            linkIos?: (...) | (...);
                            linkMo?: (...) | (...);
                            linkPc?: (...) | (...);
                        }[];
                        disableSms?: boolean;
                        talkId: string;
                        templateId: string;
                        variables?: { readonly [key: string]: string };
                    };
                    rcsOptions?: {
                        additionalBody?: {
                            buttons?: readonly (...)[];
                            description: string;
                            imaggeId?: string;
                            title: string;
                        };
                        brandId: string;
                        buttons?: readonly (
                            | { buttonName: ...; buttonType: ...; link: ... }
                            | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                            | { buttonName: ...; buttonType: ...; link: ... }
                        )[];
                        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;
                    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?: 2
                        | 1
                        | 3
                        | 4
                        | 5
                        | 6
                        | 7
                        | 8
                        | 9;
                        tailMessage?: string;
                        voiceType: "FEMALE" | "MALE";
                    };
                } & { from?: string; to: string
                | readonly string[] }
            )[],
        requestConfigParameter?: {
            allowDuplicates?: boolean;
            appId?: string;
            scheduledDate?: string;
            showMessageList?: boolean;
        },
    ) => Promise<
        {
            failedMessageList: readonly {
                accountId: string;
                country: string;
                customFields?: { readonly [key: string]: string };
                from: string;
                messageId: string;
                statusCode: string;
                statusMessage: string;
                to: string;
                type: string;
            }[];
            groupInfo: {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            };
            messageList?: readonly {
                customFields?: { readonly [key: string]: string };
                messageId: string;
                statusCode: string;
                statusMessage: string;
            }[];
        },
    >

    메시지 발송 기능, sendMany 함수보다 개선된 오류 표시 기능등을 제공합니다. 한번의 요청으로 최대 10,000건까지 발송할 수 있습니다.

    Type Declaration

      • (
            messages:
                | {
                    autoTypeDetect?: boolean;
                    country?: string;
                    customFields?: { readonly [key: string]: string };
                    faxOptions?: { fileIds: readonly string[] };
                    imageId?: string;
                    kakaoOptions?: {
                        adFlag?: boolean;
                        bms?: {
                            additionalContent?: string;
                            adult?: boolean;
                            buttons?: readonly (
                                (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                            )[];
                            carousel?:
                                | { list: readonly (...)[]; tail?: (...) | (...) }
                                | {
                                    head?: (...) | (...);
                                    list: readonly (...)[];
                                    tail?: (...) | (...);
                                };
                            chatBubbleType: | "TEXT"
                            | "IMAGE"
                            | "WIDE"
                            | "WIDE_ITEM_LIST"
                            | "COMMERCE"
                            | "CAROUSEL_FEED"
                            | "CAROUSEL_COMMERCE"
                            | "PREMIUM_VIDEO";
                            commerce?: {
                                discountFixed?: (...)
                                | (...);
                                discountPrice?: (...) | (...);
                                discountRate?: (...) | (...);
                                regularPrice: number;
                                title: string;
                            };
                            content?: string;
                            coupon?: {
                                description: string;
                                linkAndroid?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMobile?: (...) | (...);
                                linkPc?: (...) | (...);
                                title: string;
                            };
                            header?: string;
                            imageId?: string;
                            imageLink?: string;
                            mainWideItem?: {
                                imageId: string;
                                linkAndroid?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMobile: string;
                                linkPc?: (...) | (...);
                                title?: (...) | (...);
                            };
                            subWideItemList?: readonly {
                                imageId: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                                title: ...;
                            }[];
                            targeting: "I"
                            | "M"
                            | "N";
                            video?: {
                                imageId?: (...) | (...);
                                imageLink?: (...) | (...);
                                videoUrl: string;
                            };
                        };
                        buttons?: readonly (
                            | {
                                buttonName: string;
                                buttonType: "WL";
                                linkMo: string;
                                linkPc?: (...)
                                | (...)
                                | (...);
                            }
                            | {
                                buttonName: string;
                                buttonType: "AL";
                                linkAnd: string;
                                linkIos: string;
                            }
                            | {
                                buttonName: string;
                                buttonType: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            }
                        )[];
                        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 ((...) | (...) | (...))[];
                            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: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                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;
                    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?: 2
                        | 1
                        | 3
                        | 4
                        | 5
                        | 6
                        | 7
                        | 8
                        | 9;
                        tailMessage?: string;
                        voiceType: "FEMALE" | "MALE";
                    };
                } & { from?: string; to: string
                | readonly string[] }
                | readonly (
                    {
                        autoTypeDetect?: boolean;
                        country?: string;
                        customFields?: { readonly [key: string]: string };
                        faxOptions?: { fileIds: readonly string[] };
                        imageId?: string;
                        kakaoOptions?: {
                            adFlag?: boolean;
                            bms?: {
                                additionalContent?: string;
                                adult?: boolean;
                                buttons?: readonly (...)[];
                                carousel?:
                                    | { list: ...; tail?: ... }
                                    | { head?: ...; list: ...; tail?: ... };
                                chatBubbleType:
                                    | "TEXT"
                                    | "IMAGE"
                                    | "WIDE"
                                    | "WIDE_ITEM_LIST"
                                    | "COMMERCE"
                                    | "CAROUSEL_FEED"
                                    | "CAROUSEL_COMMERCE"
                                    | "PREMIUM_VIDEO";
                                commerce?: {
                                    discountFixed?: ...;
                                    discountPrice?: ...;
                                    discountRate?: ...;
                                    regularPrice: ...;
                                    title: ...;
                                };
                                content?: string;
                                coupon?: {
                                    description: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile?: ...;
                                    linkPc?: ...;
                                    title: ...;
                                };
                                header?: string;
                                imageId?: string;
                                imageLink?: string;
                                mainWideItem?: {
                                    imageId: ...;
                                    linkAndroid?: ...;
                                    linkIos?: ...;
                                    linkMobile: ...;
                                    linkPc?: ...;
                                    title?: ...;
                                };
                                subWideItemList?: readonly (...)[];
                                targeting: "I" | "M" | "N";
                                video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                            };
                            buttons?: readonly (
                                | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                                | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                                | { buttonName: ...; buttonType: ... }
                            )[];
                            disableSms?: boolean;
                            imageId?: string;
                            pfId: string;
                            templateId?: string;
                            variables?: { readonly [key: string]: string };
                        };
                        naverOptions?: {
                            buttons?: readonly {
                                buttonName: string;
                                buttonType: string;
                                linkAnd?: (...)
                                | (...);
                                linkIos?: (...) | (...);
                                linkMo?: (...) | (...);
                                linkPc?: (...) | (...);
                            }[];
                            disableSms?: boolean;
                            talkId: string;
                            templateId: string;
                            variables?: { readonly [key: string]: string };
                        };
                        rcsOptions?: {
                            additionalBody?: {
                                buttons?: readonly (...)[];
                                description: string;
                                imaggeId?: string;
                                title: string;
                            };
                            brandId: string;
                            buttons?: readonly (
                                | { buttonName: ...; buttonType: ...; link: ... }
                                | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                                | { buttonName: ...; buttonType: ...; link: ... }
                            )[];
                            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;
                        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?: 2
                            | 1
                            | 3
                            | 4
                            | 5
                            | 6
                            | 7
                            | 8
                            | 9;
                            tailMessage?: string;
                            voiceType: "FEMALE" | "MALE";
                        };
                    } & { from?: string; to: string
                    | readonly string[] }
                )[],
            requestConfigParameter?: {
                allowDuplicates?: boolean;
                appId?: string;
                scheduledDate?: string;
                showMessageList?: boolean;
            },
        ): Promise<
            {
                failedMessageList: readonly {
                    accountId: string;
                    country: string;
                    customFields?: { readonly [key: string]: string };
                    from: string;
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                    to: string;
                    type: string;
                }[];
                groupInfo: {
                    accountId: string;
                    allowDuplicates: boolean;
                    apiVersion: string;
                    app: {
                        appId: string
                        | null
                        | undefined;
                        profit: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            voice?: number;
                        };
                    };
                    balance: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    count: {
                        refund: number;
                        registeredFailed: number;
                        registeredSuccess: number;
                        sentFailed: number;
                        sentPending: number;
                        sentReplacement: number;
                        sentSuccess: number;
                        sentTotal: number;
                        total: number;
                    };
                    countForCharge: {
                        ata: { readonly [key: string]: number };
                        bms_carousel_commerce?: { readonly [key: string]: number };
                        bms_carousel_feed?: { readonly [key: string]: number };
                        bms_commerce?: { readonly [key: string]: number };
                        bms_free?: { readonly [key: string]: number };
                        bms_image?: { readonly [key: string]: number };
                        bms_premium_video?: { readonly [key: string]: number };
                        bms_text?: { readonly [key: string]: number };
                        bms_wide?: { readonly [key: string]: number };
                        bms_wide_item_list?: { readonly [key: string]: number };
                        cta: { readonly [key: string]: number };
                        cti: { readonly [key: string]: number };
                        fax?: { readonly [key: string]: number };
                        lms: { readonly [key: string]: number };
                        mms: { readonly [key: string]: number };
                        nsa: { readonly [key: string]: number };
                        rcs_itpl?: { readonly [key: string]: number };
                        rcs_lms: { readonly [key: string]: number };
                        rcs_ltpl?: { readonly [key: string]: number };
                        rcs_mms: { readonly [key: string]: number };
                        rcs_sms: { readonly [key: string]: number };
                        rcs_tpl: { readonly [key: string]: number };
                        sms: { readonly [key: string]: number };
                        voice?: { readonly [key: string]: number };
                    };
                    dateCompleted: string
                    | null
                    | undefined;
                    dateCreated: string;
                    dateSent: string | null | undefined;
                    dateUpdated: string;
                    groupId: string;
                    isRefunded: boolean;
                    log: readonly { readonly [key: string]: unknown }[];
                    masterAccountId: string | null;
                    point: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    price: { readonly [key: string]: unknown };
                    scheduledDate: string | null | undefined;
                    status: string;
                };
                messageList?: readonly {
                    customFields?: { readonly [key: string]: string };
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                }[];
            },
        >
      • 메시지 발송 기능, sendMany 함수보다 개선된 오류 표시 기능등을 제공합니다. 한번의 요청으로 최대 10,000건까지 발송할 수 있습니다.

        Parameters

        • messages:
              | {
                  autoTypeDetect?: boolean;
                  country?: string;
                  customFields?: { readonly [key: string]: string };
                  faxOptions?: { fileIds: readonly string[] };
                  imageId?: string;
                  kakaoOptions?: {
                      adFlag?: boolean;
                      bms?: {
                          additionalContent?: string;
                          adult?: boolean;
                          buttons?: readonly (
                              (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                          )[];
                          carousel?:
                              | { list: readonly (...)[]; tail?: (...) | (...) }
                              | {
                                  head?: (...) | (...);
                                  list: readonly (...)[];
                                  tail?: (...) | (...);
                              };
                          chatBubbleType: | "TEXT"
                          | "IMAGE"
                          | "WIDE"
                          | "WIDE_ITEM_LIST"
                          | "COMMERCE"
                          | "CAROUSEL_FEED"
                          | "CAROUSEL_COMMERCE"
                          | "PREMIUM_VIDEO";
                          commerce?: {
                              discountFixed?: (...)
                              | (...);
                              discountPrice?: (...) | (...);
                              discountRate?: (...) | (...);
                              regularPrice: number;
                              title: string;
                          };
                          content?: string;
                          coupon?: {
                              description: string;
                              linkAndroid?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMobile?: (...) | (...);
                              linkPc?: (...) | (...);
                              title: string;
                          };
                          header?: string;
                          imageId?: string;
                          imageLink?: string;
                          mainWideItem?: {
                              imageId: string;
                              linkAndroid?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMobile: string;
                              linkPc?: (...) | (...);
                              title?: (...) | (...);
                          };
                          subWideItemList?: readonly {
                              imageId: ...;
                              linkAndroid?: ...;
                              linkIos?: ...;
                              linkMobile: ...;
                              linkPc?: ...;
                              title: ...;
                          }[];
                          targeting: "I"
                          | "M"
                          | "N";
                          video?: {
                              imageId?: (...) | (...);
                              imageLink?: (...) | (...);
                              videoUrl: string;
                          };
                      };
                      buttons?: readonly (
                          | {
                              buttonName: string;
                              buttonType: "WL";
                              linkMo: string;
                              linkPc?: (...)
                              | (...)
                              | (...);
                          }
                          | {
                              buttonName: string;
                              buttonType: "AL";
                              linkAnd: string;
                              linkIos: string;
                          }
                          | {
                              buttonName: string;
                              buttonType: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          }
                      )[];
                      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 ((...) | (...) | (...))[];
                          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: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                              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;
                  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?: 2
                      | 1
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9;
                      tailMessage?: string;
                      voiceType: "FEMALE" | "MALE";
                  };
              } & { from?: string; to: string
              | readonly string[] }
              | readonly (
                  {
                      autoTypeDetect?: boolean;
                      country?: string;
                      customFields?: { readonly [key: string]: string };
                      faxOptions?: { fileIds: readonly string[] };
                      imageId?: string;
                      kakaoOptions?: {
                          adFlag?: boolean;
                          bms?: {
                              additionalContent?: string;
                              adult?: boolean;
                              buttons?: readonly (...)[];
                              carousel?:
                                  | { list: ...; tail?: ... }
                                  | { head?: ...; list: ...; tail?: ... };
                              chatBubbleType:
                                  | "TEXT"
                                  | "IMAGE"
                                  | "WIDE"
                                  | "WIDE_ITEM_LIST"
                                  | "COMMERCE"
                                  | "CAROUSEL_FEED"
                                  | "CAROUSEL_COMMERCE"
                                  | "PREMIUM_VIDEO";
                              commerce?: {
                                  discountFixed?: ...;
                                  discountPrice?: ...;
                                  discountRate?: ...;
                                  regularPrice: ...;
                                  title: ...;
                              };
                              content?: string;
                              coupon?: {
                                  description: ...;
                                  linkAndroid?: ...;
                                  linkIos?: ...;
                                  linkMobile?: ...;
                                  linkPc?: ...;
                                  title: ...;
                              };
                              header?: string;
                              imageId?: string;
                              imageLink?: string;
                              mainWideItem?: {
                                  imageId: ...;
                                  linkAndroid?: ...;
                                  linkIos?: ...;
                                  linkMobile: ...;
                                  linkPc?: ...;
                                  title?: ...;
                              };
                              subWideItemList?: readonly (...)[];
                              targeting: "I" | "M" | "N";
                              video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
                          };
                          buttons?: readonly (
                              | { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
                              | { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
                              | { buttonName: ...; buttonType: ... }
                          )[];
                          disableSms?: boolean;
                          imageId?: string;
                          pfId: string;
                          templateId?: string;
                          variables?: { readonly [key: string]: string };
                      };
                      naverOptions?: {
                          buttons?: readonly {
                              buttonName: string;
                              buttonType: string;
                              linkAnd?: (...)
                              | (...);
                              linkIos?: (...) | (...);
                              linkMo?: (...) | (...);
                              linkPc?: (...) | (...);
                          }[];
                          disableSms?: boolean;
                          talkId: string;
                          templateId: string;
                          variables?: { readonly [key: string]: string };
                      };
                      rcsOptions?: {
                          additionalBody?: {
                              buttons?: readonly (...)[];
                              description: string;
                              imaggeId?: string;
                              title: string;
                          };
                          brandId: string;
                          buttons?: readonly (
                              | { buttonName: ...; buttonType: ...; link: ... }
                              | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                              | { buttonName: ...; buttonType: ...; link: ... }
                          )[];
                          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;
                      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?: 2
                          | 1
                          | 3
                          | 4
                          | 5
                          | 6
                          | 7
                          | 8
                          | 9;
                          tailMessage?: string;
                          voiceType: "FEMALE" | "MALE";
                      };
                  } & { from?: string; to: string
                  | readonly string[] }
              )[]

          발송 요청할 메시지 파라미터(문자, 알림톡 등)

        • OptionalrequestConfigParameter: {
              allowDuplicates?: boolean;
              appId?: string;
              scheduledDate?: string;
              showMessageList?: boolean;
          }

          request시 필요한 파라미터 오브젝트

        Returns Promise<
            {
                failedMessageList: readonly {
                    accountId: string;
                    country: string;
                    customFields?: { readonly [key: string]: string };
                    from: string;
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                    to: string;
                    type: string;
                }[];
                groupInfo: {
                    accountId: string;
                    allowDuplicates: boolean;
                    apiVersion: string;
                    app: {
                        appId: string
                        | null
                        | undefined;
                        profit: {
                            ata: number;
                            bms_carousel_commerce?: number;
                            bms_carousel_feed?: number;
                            bms_commerce?: number;
                            bms_free?: number;
                            bms_image?: number;
                            bms_premium_video?: number;
                            bms_text?: number;
                            bms_wide?: number;
                            bms_wide_item_list?: number;
                            cta: number;
                            cti: number;
                            fax?: number;
                            lms: number;
                            mms: number;
                            nsa: number;
                            rcs_itpl?: number;
                            rcs_lms: number;
                            rcs_ltpl?: number;
                            rcs_mms: number;
                            rcs_sms: number;
                            rcs_tpl: number;
                            sms: number;
                            voice?: number;
                        };
                    };
                    balance: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    count: {
                        refund: number;
                        registeredFailed: number;
                        registeredSuccess: number;
                        sentFailed: number;
                        sentPending: number;
                        sentReplacement: number;
                        sentSuccess: number;
                        sentTotal: number;
                        total: number;
                    };
                    countForCharge: {
                        ata: { readonly [key: string]: number };
                        bms_carousel_commerce?: { readonly [key: string]: number };
                        bms_carousel_feed?: { readonly [key: string]: number };
                        bms_commerce?: { readonly [key: string]: number };
                        bms_free?: { readonly [key: string]: number };
                        bms_image?: { readonly [key: string]: number };
                        bms_premium_video?: { readonly [key: string]: number };
                        bms_text?: { readonly [key: string]: number };
                        bms_wide?: { readonly [key: string]: number };
                        bms_wide_item_list?: { readonly [key: string]: number };
                        cta: { readonly [key: string]: number };
                        cti: { readonly [key: string]: number };
                        fax?: { readonly [key: string]: number };
                        lms: { readonly [key: string]: number };
                        mms: { readonly [key: string]: number };
                        nsa: { readonly [key: string]: number };
                        rcs_itpl?: { readonly [key: string]: number };
                        rcs_lms: { readonly [key: string]: number };
                        rcs_ltpl?: { readonly [key: string]: number };
                        rcs_mms: { readonly [key: string]: number };
                        rcs_sms: { readonly [key: string]: number };
                        rcs_tpl: { readonly [key: string]: number };
                        sms: { readonly [key: string]: number };
                        voice?: { readonly [key: string]: number };
                    };
                    dateCompleted: string
                    | null
                    | undefined;
                    dateCreated: string;
                    dateSent: string | null | undefined;
                    dateUpdated: string;
                    groupId: string;
                    isRefunded: boolean;
                    log: readonly { readonly [key: string]: unknown }[];
                    masterAccountId: string | null;
                    point: {
                        refund: number;
                        replacement: number;
                        requested: number;
                        sum: number;
                    };
                    price: { readonly [key: string]: unknown };
                    scheduledDate: string | null | undefined;
                    status: string;
                };
                messageList?: readonly {
                    customFields?: { readonly [key: string]: string };
                    messageId: string;
                    statusCode: string;
                    statusMessage: string;
                }[];
            },
        >

        MessageNotReceivedError 모든 메시지 접수건이 실패건으로 진행되는 경우 반환되는 에러

        BadRequestError 잘못된 파라미터를 기입했거나, 데이터가 아예 없는 경우 반환되는 에러

    발송 요청할 메시지 파라미터(문자, 알림톡 등)

    request시 필요한 파라미터 오브젝트

    MessageNotReceivedError 모든 메시지 접수건이 실패건으로 진행되는 경우 반환되는 에러

    BadRequestError 잘못된 파라미터를 기입했거나, 데이터가 아예 없는 경우 반환되는 에러

    sendGroup: (
        groupId: string,
    ) => Promise<
        {
            accountId: string;
            allowDuplicates: boolean;
            apiVersion: string;
            app: {
                appId: string
                | null
                | undefined;
                profit: {
                    ata: number;
                    bms_carousel_commerce?: number;
                    bms_carousel_feed?: number;
                    bms_commerce?: number;
                    bms_free?: number;
                    bms_image?: number;
                    bms_premium_video?: number;
                    bms_text?: number;
                    bms_wide?: number;
                    bms_wide_item_list?: number;
                    cta: number;
                    cti: number;
                    fax?: number;
                    lms: number;
                    mms: number;
                    nsa: number;
                    rcs_itpl?: number;
                    rcs_lms: number;
                    rcs_ltpl?: number;
                    rcs_mms: number;
                    rcs_sms: number;
                    rcs_tpl: number;
                    sms: number;
                    voice?: number;
                };
            };
            balance: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            count: {
                refund: number;
                registeredFailed: number;
                registeredSuccess: number;
                sentFailed: number;
                sentPending: number;
                sentReplacement: number;
                sentSuccess: number;
                sentTotal: number;
                total: number;
            };
            countForCharge: {
                ata: { readonly [key: string]: number };
                bms_carousel_commerce?: { readonly [key: string]: number };
                bms_carousel_feed?: { readonly [key: string]: number };
                bms_commerce?: { readonly [key: string]: number };
                bms_free?: { readonly [key: string]: number };
                bms_image?: { readonly [key: string]: number };
                bms_premium_video?: { readonly [key: string]: number };
                bms_text?: { readonly [key: string]: number };
                bms_wide?: { readonly [key: string]: number };
                bms_wide_item_list?: { readonly [key: string]: number };
                cta: { readonly [key: string]: number };
                cti: { readonly [key: string]: number };
                fax?: { readonly [key: string]: number };
                lms: { readonly [key: string]: number };
                mms: { readonly [key: string]: number };
                nsa: { readonly [key: string]: number };
                rcs_itpl?: { readonly [key: string]: number };
                rcs_lms: { readonly [key: string]: number };
                rcs_ltpl?: { readonly [key: string]: number };
                rcs_mms: { readonly [key: string]: number };
                rcs_sms: { readonly [key: string]: number };
                rcs_tpl: { readonly [key: string]: number };
                sms: { readonly [key: string]: number };
                voice?: { readonly [key: string]: number };
            };
            dateCompleted: string
            | null
            | undefined;
            dateCreated: string;
            dateSent: string | null | undefined;
            dateUpdated: string;
            groupId: string;
            isRefunded: boolean;
            log: readonly { readonly [key: string]: unknown }[];
            masterAccountId: string | null;
            point: {
                refund: number;
                replacement: number;
                requested: number;
                sum: number;
            };
            price: { readonly [key: string]: unknown };
            scheduledDate: string | null | undefined;
            status: string;
        },
    >

    그룹 메시지 전송 요청

    Type Declaration

      • (
            groupId: string,
        ): Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >
      • 그룹 메시지 전송 요청

        Parameters

        • groupId: string

          생성 된 Group ID

        Returns Promise<
            {
                accountId: string;
                allowDuplicates: boolean;
                apiVersion: string;
                app: {
                    appId: string
                    | null
                    | undefined;
                    profit: {
                        ata: number;
                        bms_carousel_commerce?: number;
                        bms_carousel_feed?: number;
                        bms_commerce?: number;
                        bms_free?: number;
                        bms_image?: number;
                        bms_premium_video?: number;
                        bms_text?: number;
                        bms_wide?: number;
                        bms_wide_item_list?: number;
                        cta: number;
                        cti: number;
                        fax?: number;
                        lms: number;
                        mms: number;
                        nsa: number;
                        rcs_itpl?: number;
                        rcs_lms: number;
                        rcs_ltpl?: number;
                        rcs_mms: number;
                        rcs_sms: number;
                        rcs_tpl: number;
                        sms: number;
                        voice?: number;
                    };
                };
                balance: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                count: {
                    refund: number;
                    registeredFailed: number;
                    registeredSuccess: number;
                    sentFailed: number;
                    sentPending: number;
                    sentReplacement: number;
                    sentSuccess: number;
                    sentTotal: number;
                    total: number;
                };
                countForCharge: {
                    ata: { readonly [key: string]: number };
                    bms_carousel_commerce?: { readonly [key: string]: number };
                    bms_carousel_feed?: { readonly [key: string]: number };
                    bms_commerce?: { readonly [key: string]: number };
                    bms_free?: { readonly [key: string]: number };
                    bms_image?: { readonly [key: string]: number };
                    bms_premium_video?: { readonly [key: string]: number };
                    bms_text?: { readonly [key: string]: number };
                    bms_wide?: { readonly [key: string]: number };
                    bms_wide_item_list?: { readonly [key: string]: number };
                    cta: { readonly [key: string]: number };
                    cti: { readonly [key: string]: number };
                    fax?: { readonly [key: string]: number };
                    lms: { readonly [key: string]: number };
                    mms: { readonly [key: string]: number };
                    nsa: { readonly [key: string]: number };
                    rcs_itpl?: { readonly [key: string]: number };
                    rcs_lms: { readonly [key: string]: number };
                    rcs_ltpl?: { readonly [key: string]: number };
                    rcs_mms: { readonly [key: string]: number };
                    rcs_sms: { readonly [key: string]: number };
                    rcs_tpl: { readonly [key: string]: number };
                    sms: { readonly [key: string]: number };
                    voice?: { readonly [key: string]: number };
                };
                dateCompleted: string
                | null
                | undefined;
                dateCreated: string;
                dateSent: string | null | undefined;
                dateUpdated: string;
                groupId: string;
                isRefunded: boolean;
                log: readonly { readonly [key: string]: unknown }[];
                masterAccountId: string | null;
                point: {
                    refund: number;
                    replacement: number;
                    requested: number;
                    sum: number;
                };
                price: { readonly [key: string]: unknown };
                scheduledDate: string | null | undefined;
                status: string;
            },
        >

    생성 된 Group ID

    updateKakaoAlimtalkTemplate: (
        templateId: string,
        data: {
            buttons?: readonly (
                | {
                    buttonName: string;
                    buttonType: "WL";
                    linkMo: string;
                    linkPc?: string
                    | null;
                }
                | {
                    buttonName: string;
                    buttonType: "AL";
                    linkAnd: string;
                    linkIos: string;
                }
                | {
                    buttonName: string;
                    buttonType: "AC"
                    | "BK"
                    | "MD"
                    | "BC"
                    | "BT"
                    | "DS";
                }
            )[];
            categoryCode?: string;
            content?: string;
            emphasizeSubTitle?: string;
            emphasizeTitle?: string;
            emphasizeType?: "TEXT"
            | "IMAGE"
            | "NONE"
            | "ITEM_LIST";
            extra?: string;
            header?: string;
            highlight?: {
                description?: string | null;
                imageId?: string | null;
                title?: string | null;
            };
            imageId?: string;
            item?: {
                list: readonly { description: string; title: string }[];
                summary: { description?: string | null; title?: string | null };
            };
            messageType?: "BA"
            | "EX"
            | "AD"
            | "MI";
            name?: string;
            quickReplies?: readonly (
                | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                | { linkType: "BK" | "BC" | "BT"; name: string }
            )[];
            securityFlag?: boolean;
        },
    ) => Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 수정(검수 X)

    Type Declaration

      • (
            templateId: string,
            data: {
                buttons?: readonly (
                    | {
                        buttonName: string;
                        buttonType: "WL";
                        linkMo: string;
                        linkPc?: string
                        | null;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AL";
                        linkAnd: string;
                        linkIos: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AC"
                        | "BK"
                        | "MD"
                        | "BC"
                        | "BT"
                        | "DS";
                    }
                )[];
                categoryCode?: string;
                content?: string;
                emphasizeSubTitle?: string;
                emphasizeTitle?: string;
                emphasizeType?: "TEXT"
                | "IMAGE"
                | "NONE"
                | "ITEM_LIST";
                extra?: string;
                header?: string;
                highlight?: {
                    description?: string | null;
                    imageId?: string | null;
                    title?: string | null;
                };
                imageId?: string;
                item?: {
                    list: readonly { description: string; title: string }[];
                    summary: { description?: string | null; title?: string | null };
                };
                messageType?: "BA"
                | "EX"
                | "AD"
                | "MI";
                name?: string;
                quickReplies?: readonly (
                    | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                    | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                    | { linkType: "BK" | "BC" | "BT"; name: string }
                )[];
                securityFlag?: boolean;
            },
        ): Promise<KakaoAlimtalkTemplate>
      • 카카오 알림톡 템플릿 수정(검수 X)

        Parameters

        • templateId: string
        • data: {
              buttons?: readonly (
                  | {
                      buttonName: string;
                      buttonType: "WL";
                      linkMo: string;
                      linkPc?: string
                      | null;
                  }
                  | {
                      buttonName: string;
                      buttonType: "AL";
                      linkAnd: string;
                      linkIos: string;
                  }
                  | {
                      buttonName: string;
                      buttonType: "AC"
                      | "BK"
                      | "MD"
                      | "BC"
                      | "BT"
                      | "DS";
                  }
              )[];
              categoryCode?: string;
              content?: string;
              emphasizeSubTitle?: string;
              emphasizeTitle?: string;
              emphasizeType?: "TEXT"
              | "IMAGE"
              | "NONE"
              | "ITEM_LIST";
              extra?: string;
              header?: string;
              highlight?: {
                  description?: string | null;
                  imageId?: string | null;
                  title?: string | null;
              };
              imageId?: string;
              item?: {
                  list: readonly { description: string; title: string }[];
                  summary: { description?: string | null; title?: string | null };
              };
              messageType?: "BA"
              | "EX"
              | "AD"
              | "MI";
              name?: string;
              quickReplies?: readonly (
                  | { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
                  | { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
                  | { linkType: "BK" | "BC" | "BT"; name: string }
              )[];
              securityFlag?: boolean;
          }

        Returns Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 ID

    카카오 알림톡 템플릿 수정을 위한 파라미터

    updateKakaoAlimtalkTemplateName: (
        templateId: string,
        name: string,
    ) => Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 이름 수정(검수 상태 상관없이 변경가능)

    Type Declaration

      • (templateId: string, name: string): Promise<KakaoAlimtalkTemplate>
      • 카카오 알림톡 템플릿 이름 수정(검수 상태 상관없이 변경가능)

        Parameters

        • templateId: string
        • name: string

        Returns Promise<KakaoAlimtalkTemplate>

    카카오 알림톡 템플릿 ID

    카카오 알림톡 템플릿 이름 변경을 위한 파라미터

    uploadFile: (
        filePath: string,
        fileType:
            | "MMS"
            | "FAX"
            | "BMS_WIDE"
            | "KAKAO"
            | "DOCUMENT"
            | "RCS"
            | "BMS"
            | "BMS_WIDE_MAIN_ITEM_LIST"
            | "BMS_WIDE_SUB_ITEM_LIST"
            | "BMS_CAROUSEL_FEED_LIST"
            | "BMS_CAROUSEL_COMMERCE_LIST",
        name?: string,
        link?: string,
    ) => Promise<
        { fileId: string; link: string
        | null
        | undefined; type: string },
    >

    파일(이미지) 업로드 카카오 친구톡 이미지는 500kb, MMS는 200kb, 발신번호 서류 인증용 파일은 2mb의 제한이 있음

    Type Declaration

      • (
            filePath: string,
            fileType:
                | "MMS"
                | "FAX"
                | "BMS_WIDE"
                | "KAKAO"
                | "DOCUMENT"
                | "RCS"
                | "BMS"
                | "BMS_WIDE_MAIN_ITEM_LIST"
                | "BMS_WIDE_SUB_ITEM_LIST"
                | "BMS_CAROUSEL_FEED_LIST"
                | "BMS_CAROUSEL_COMMERCE_LIST",
            name?: string,
            link?: string,
        ): Promise<
            { fileId: string; link: string
            | null
            | undefined; type: string },
        >
      • 파일(이미지) 업로드 카카오 친구톡 이미지는 500kb, MMS는 200kb, 발신번호 서류 인증용 파일은 2mb의 제한이 있음

        Parameters

        • filePath: string

          해당 파일의 경로 또는 접근 가능한 이미지 URL

        • fileType:
              | "MMS"
              | "FAX"
              | "BMS_WIDE"
              | "KAKAO"
              | "DOCUMENT"
              | "RCS"
              | "BMS"
              | "BMS_WIDE_MAIN_ITEM_LIST"
              | "BMS_WIDE_SUB_ITEM_LIST"
              | "BMS_CAROUSEL_FEED_LIST"
              | "BMS_CAROUSEL_COMMERCE_LIST"

          저장할 파일의 유형, 예) 카카오 친구톡 용 이미지 -> KAKAO, MMS용 사진 -> MMS, 발신번호 서류 인증에 쓰이는 문서 등 -> DOCUMENT, RCS 이미지 -> RCS

        • Optionalname: string

          파일 이름

        • Optionallink: string

          파일 링크, 친구톡의 경우 필수 값

        Returns Promise<{ fileId: string; link: string | null | undefined; type: string }>

    해당 파일의 경로 또는 접근 가능한 이미지 URL

    저장할 파일의 유형, 예) 카카오 친구톡 용 이미지 -> KAKAO, MMS용 사진 -> MMS, 발신번호 서류 인증에 쓰이는 문서 등 -> DOCUMENT, RCS 이미지 -> RCS

    파일 이름

    파일 링크, 친구톡의 경우 필수 값