Class default

그룹 서비스 그룹 생성, 메시지 추가 등 그룹 관련 기능을 제공합니다.

Hierarchy (View Summary)

default
- default

Index

Constructors

Methods

addMessagesToGroup createGroup getGroup getGroupMessages getGroups getWithQuery removeGroup removeGroupMessages removeReservationToGroup request requestEffect reserveGroup sendGroup

Constructors

constructor

new default(apiKey: string, apiSecret: string): default
Parameters
- apiKey: string
- apiSecret: string
Returns default
Inherited from default.constructor
- Defined in src/services/defaultService.ts:44

Methods

addMessagesToGroup

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 (
                        | {
                            linkMobile: ...;
                            linkPc?: ...;
                            linkType: ...;
                            name: ...;
                            targetOut?: ...;
                        }
                        | {
                            linkAndroid?: ...;
                            linkIos?: ...;
                            linkMobile?: ...;
                            linkType: ...;
                            name: ...;
                            targetOut?: ...;
                        }
                        | { linkType: ...; name?: ... }
                        | { chatExtra?: ...; linkType: ...; name: ... }
                        | { chatExtra?: ...; linkType: ...; name: ... }
                        | { chatExtra?: ...; linkType: ...; name: ... }
                        | { chatExtra?: ...; linkType: ...; name: ... }
                        | { linkType: ...; name: ... }
                    )[];
                    carousel?:
                        | {
                            list: readonly {
                                buttons: ...;
                                content: ...;
                                coupon?: ...;
                                header: ...;
                                imageId: ...;
                                imageLink?: ...;
                            }[];
                            tail?: {
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                            };
                        }
                        | {
                            head?: {
                                content: ...;
                                header: ...;
                                imageId: ...;
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile?: ...;
                                linkPc?: ...;
                            };
                            list: readonly {
                                additionalContent?: ...;
                                buttons: ...;
                                commerce: ...;
                                coupon?: ...;
                                imageId: ...;
                                imageLink?: ...;
                            }[];
                            tail?: {
                                linkAndroid?: ...;
                                linkIos?: ...;
                                linkMobile: ...;
                                linkPc?: ...;
                            };
                        };
                    chatBubbleType: | "TEXT"
                    | "IMAGE"
                    | "WIDE"
                    | "WIDE_ITEM_LIST"
                    | "COMMERCE"
                    | "CAROUSEL_FEED"
                    | "CAROUSEL_COMMERCE"
                    | "PREMIUM_VIDEO";
                    commerce?: {
                        discountFixed?: number;
                        discountPrice?: number;
                        discountRate?: number;
                        regularPrice: number;
                        title: string;
                    };
                    content?: string;
                    coupon?: {
                        description: string;
                        linkAndroid?: string;
                        linkIos?: string;
                        linkMobile?: string;
                        linkPc?: string;
                        title: string;
                    };
                    header?: string;
                    imageId?: string;
                    imageLink?: string;
                    mainWideItem?: {
                        imageId: string;
                        linkAndroid?: string;
                        linkIos?: string;
                        linkMobile: string;
                        linkPc?: string;
                        title?: string;
                    };
                    subWideItemList?: readonly {
                        imageId: string;
                        linkAndroid?: (...)
                        | (...);
                        linkIos?: (...) | (...);
                        linkMobile: string;
                        linkPc?: (...) | (...);
                        title: string;
                    }[];
                    targeting: "I"
                    | "M"
                    | "N";
                    video?: { imageId?: string; imageLink?: string; videoUrl: string };
                };
                buttons?: readonly (
                    | {
                        buttonName: string;
                        buttonType: "WL";
                        linkMo: string;
                        linkPc?: string
                        | null;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AL";
                        linkAnd: string;
                        linkIos: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "AC"
                        | "BK"
                        | "MD"
                        | "BC"
                        | "BT"
                        | "DS";
                    }
                )[];
                disableSms?: boolean;
                imageId?: string;
                pfId: string;
                templateId?: string;
                variables?: { readonly [key: string]: string };
            };
            naverOptions?: {
                buttons?: readonly {
                    buttonName: string;
                    buttonType: string;
                    linkAnd?: string;
                    linkIos?: string;
                    linkMo?: string;
                    linkPc?: string;
                }[];
                disableSms?: boolean;
                talkId: string;
                templateId: string;
                variables?: { readonly [key: string]: string };
            };
            rcsOptions?: {
                additionalBody?: {
                    buttons?: readonly (
                        | { buttonName: ...; buttonType: ...; link: ... }
                        | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                        | { buttonName: ...; buttonType: ...; link: ... }
                    )[];
                    description: string;
                    imaggeId?: string;
                    title: string;
                };
                brandId: string;
                buttons?: readonly (
                    | { buttonName: string; buttonType: "WL"; link: string }
                    | {
                        buttonName: string;
                        buttonType: "ML";
                        latitude: string;
                        longitude: string;
                    }
                    | {
                        buttonName: string;
                        buttonType: "MQ"
                        | "MR"
                        | "CA"
                        | "CL"
                        | "DL"
                        | "MS";
                        link: string;
                    }
                )[];
                commercialType?: boolean;
                copyAllowed?: boolean;
                disableSms?: boolean;
                mmsType?: "M3"
                | "S3"
                | "M4"
                | "S4"
                | "M5"
                | "S5"
                | "M6"
                | "S6";
                templateId?: string;
                variables?: { readonly [key: string]: string };
            };
            replacements?: readonly {}[];
            subject?: string;
            text?: string;
            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: 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[] }
        )[],
): 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 (
                      | {
                          linkMobile: ...;
                          linkPc?: ...;
                          linkType: ...;
                          name: ...;
                          targetOut?: ...;
                      }
                      | {
                          linkAndroid?: ...;
                          linkIos?: ...;
                          linkMobile?: ...;
                          linkType: ...;
                          name: ...;
                          targetOut?: ...;
                      }
                      | { linkType: ...; name?: ... }
                      | { chatExtra?: ...; linkType: ...; name: ... }
                      | { chatExtra?: ...; linkType: ...; name: ... }
                      | { chatExtra?: ...; linkType: ...; name: ... }
                      | { chatExtra?: ...; linkType: ...; name: ... }
                      | { linkType: ...; name: ... }
                  )[];
                  carousel?:
                      | {
                          list: readonly {
                              buttons: ...;
                              content: ...;
                              coupon?: ...;
                              header: ...;
                              imageId: ...;
                              imageLink?: ...;
                          }[];
                          tail?: {
                              linkAndroid?: ...;
                              linkIos?: ...;
                              linkMobile: ...;
                              linkPc?: ...;
                          };
                      }
                      | {
                          head?: {
                              content: ...;
                              header: ...;
                              imageId: ...;
                              linkAndroid?: ...;
                              linkIos?: ...;
                              linkMobile?: ...;
                              linkPc?: ...;
                          };
                          list: readonly {
                              additionalContent?: ...;
                              buttons: ...;
                              commerce: ...;
                              coupon?: ...;
                              imageId: ...;
                              imageLink?: ...;
                          }[];
                          tail?: {
                              linkAndroid?: ...;
                              linkIos?: ...;
                              linkMobile: ...;
                              linkPc?: ...;
                          };
                      };
                  chatBubbleType: | "TEXT"
                  | "IMAGE"
                  | "WIDE"
                  | "WIDE_ITEM_LIST"
                  | "COMMERCE"
                  | "CAROUSEL_FEED"
                  | "CAROUSEL_COMMERCE"
                  | "PREMIUM_VIDEO";
                  commerce?: {
                      discountFixed?: number;
                      discountPrice?: number;
                      discountRate?: number;
                      regularPrice: number;
                      title: string;
                  };
                  content?: string;
                  coupon?: {
                      description: string;
                      linkAndroid?: string;
                      linkIos?: string;
                      linkMobile?: string;
                      linkPc?: string;
                      title: string;
                  };
                  header?: string;
                  imageId?: string;
                  imageLink?: string;
                  mainWideItem?: {
                      imageId: string;
                      linkAndroid?: string;
                      linkIos?: string;
                      linkMobile: string;
                      linkPc?: string;
                      title?: string;
                  };
                  subWideItemList?: readonly {
                      imageId: string;
                      linkAndroid?: (...)
                      | (...);
                      linkIos?: (...) | (...);
                      linkMobile: string;
                      linkPc?: (...) | (...);
                      title: string;
                  }[];
                  targeting: "I"
                  | "M"
                  | "N";
                  video?: { imageId?: string; imageLink?: string; videoUrl: string };
              };
              buttons?: readonly (
                  | {
                      buttonName: string;
                      buttonType: "WL";
                      linkMo: string;
                      linkPc?: string
                      | null;
                  }
                  | {
                      buttonName: string;
                      buttonType: "AL";
                      linkAnd: string;
                      linkIos: string;
                  }
                  | {
                      buttonName: string;
                      buttonType: "AC"
                      | "BK"
                      | "MD"
                      | "BC"
                      | "BT"
                      | "DS";
                  }
              )[];
              disableSms?: boolean;
              imageId?: string;
              pfId: string;
              templateId?: string;
              variables?: { readonly [key: string]: string };
          };
          naverOptions?: {
              buttons?: readonly {
                  buttonName: string;
                  buttonType: string;
                  linkAnd?: string;
                  linkIos?: string;
                  linkMo?: string;
                  linkPc?: string;
              }[];
              disableSms?: boolean;
              talkId: string;
              templateId: string;
              variables?: { readonly [key: string]: string };
          };
          rcsOptions?: {
              additionalBody?: {
                  buttons?: readonly (
                      | { buttonName: ...; buttonType: ...; link: ... }
                      | { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
                      | { buttonName: ...; buttonType: ...; link: ... }
                  )[];
                  description: string;
                  imaggeId?: string;
                  title: string;
              };
              brandId: string;
              buttons?: readonly (
                  | { buttonName: string; buttonType: "WL"; link: string }
                  | {
                      buttonName: string;
                      buttonType: "ML";
                      latitude: string;
                      longitude: string;
                  }
                  | {
                      buttonName: string;
                      buttonType: "MQ"
                      | "MR"
                      | "CA"
                      | "CL"
                      | "DL"
                      | "MS";
                      link: string;
                  }
              )[];
              commercialType?: boolean;
              copyAllowed?: boolean;
              disableSms?: boolean;
              mmsType?: "M3"
              | "S3"
              | "M4"
              | "S4"
              | "M5"
              | "S5"
              | "M6"
              | "S6";
              templateId?: string;
              variables?: { readonly [key: string]: string };
          };
          replacements?: readonly {}[];
          subject?: string;
          text?: string;
          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: 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[] }
      )[]
  여러 메시지(문자, 알림톡 등)
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;
        }[];
    },
>
- Defined in src/services/messages/groupService.ts:76

createGroup

createGroup(
    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>
- Defined in src/services/messages/groupService.ts:46

getGroup

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;
    },
>
단일 그룹정보 조회
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;
    },
>
- Defined in src/services/messages/groupService.ts:166

getGroupMessages

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;
    },
>
그룹 내 메시지 목록 조회
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;
    },
>
- Defined in src/services/messages/groupService.ts:181

getGroups

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;
    },
>
그룹 목록 정보 조회
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;
    },
>
- Defined in src/services/messages/groupService.ts:150

`Protected`getWithQuery

getWithQuery<A, R, I = unknown>(
    config: {
        data?: unknown;
        finalize: (validated?: A) => object;
        responseSchema?: Schema<R, I, never>;
        schema: Schema<A>;
        url: string;
    },
): Effect<
    R,
    | InvalidDateError
    | ApiKeyError
    | DefaultError
    | BadRequestError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Type Parameters
- A
- R
- I = unknown
Parameters
- config: {
      data?: unknown;
      finalize: (validated?: A) => object;
      responseSchema?: Schema<R, I, never>;
      schema: Schema<A>;
      url: string;
  }
Returns Effect<
    R,
    | InvalidDateError
    | ApiKeyError
    | DefaultError
    | BadRequestError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Inherited from default.getWithQuery
- Defined in src/services/defaultService.ts:83

removeGroup

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;
    },
>
그룹 삭제
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;
    },
>
- Defined in src/services/messages/groupService.ts:223

removeGroupMessages

removeGroupMessages(
    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 }[];
    },
>
- Defined in src/services/messages/groupService.ts:203

removeReservationToGroup

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;
    },
>
그룹 내 예약 발송 취소(메시지 실패 전체 처리 됨)
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;
    },
>
- Defined in src/services/messages/groupService.ts:135

`Protected`request

request<T, R, I = unknown>(
parameter: DefaultServiceParameter<T, R, I>,
): Promise<R>
Type Parameters
- T
- R
- I = unknown
Parameters
- parameter: DefaultServiceParameter<T, R, I>
Returns Promise<R>
Inherited from default.request
- Defined in src/services/defaultService.ts:77

`Protected`requestEffect

requestEffect<T, R, I = unknown>(
    parameter: DefaultServiceParameter<T, R, I>,
): Effect<
    R,
    | ApiKeyError
    | DefaultError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Type Parameters
- T
- R
- I = unknown
Parameters
- parameter: DefaultServiceParameter<T, R, I>
Returns Effect<
    R,
    | ApiKeyError
    | DefaultError
    | NetworkError
    | ClientError
    | ResponseSchemaMismatchError
    | ServerError,
>
Inherited from default.requestEffect
- Defined in src/services/defaultService.ts:51

reserveGroup

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;
    },
>
그룹 예약 발송 설정
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;
    },
>
- Defined in src/services/messages/groupService.ts:116

sendGroup

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;
    },
>
그룹 메시지 전송 요청
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;
    },
>
- Defined in src/services/messages/groupService.ts:102

Class default

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

addMessagesToGroup

Parameters

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; }[]; },>

createGroup

Parameters

Returns Promise<string>

getGroup

Parameters

getGroupMessages

Parameters

getGroups

Parameters

ProtectedgetWithQuery

Type Parameters

Parameters

Returns Effect< R, | InvalidDateError | ApiKeyError | DefaultError | BadRequestError | NetworkError | ClientError | ResponseSchemaMismatchError | ServerError,>

removeGroup

Parameters

removeGroupMessages

Parameters

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

removeReservationToGroup

Parameters

Protectedrequest

Type Parameters

Parameters

Returns Promise<R>

ProtectedrequestEffect

Type Parameters

Parameters

Returns Effect< R, | ApiKeyError | DefaultError | NetworkError | ClientError | ResponseSchemaMismatchError | ServerError,>

reserveGroup

Parameters

sendGroup

Parameters

Settings

On This Page

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;
}[];
},
>

`Protected`getWithQuery

Returns Effect<
R,
| InvalidDateError
| ApiKeyError
| DefaultError
| BadRequestError
| NetworkError
| ClientError
| ResponseSchemaMismatchError
| ServerError,
>

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

`Protected`request

`Protected`requestEffect

Returns Effect<
R,
| ApiKeyError
| DefaultError
| NetworkError
| ClientError
| ResponseSchemaMismatchError
| ServerError,
>