ReadonlyaddMessagesToGroup
addMessagesToGroup: (
groupId: string,
messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[],
) => Promise<
{
errorCount: string;
resultList: readonly {
accountId: string;
country: string;
customFields?: { readonly [key: string]: string };
from: string;
messageId: string;
statusCode: string;
statusMessage: string;
to: string;
type: string;
}[];
},
>
Type Declaration
- (
groupId: string,
messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[],
): Promise<
{
errorCount: string;
resultList: readonly {
accountId: string;
country: string;
customFields?: { readonly [key: string]: string };
from: string;
messageId: string;
statusCode: string;
statusMessage: string;
to: string;
type: string;
}[];
},
> Parameters
- groupId: string
- messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[]
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;
}[];
},
>
ReadonlycancelInspectionKakaoAlimtalkTemplate
ReadonlycreateGroup
createGroup: (
allowDuplicates?: boolean,
appId?: string,
customFields?: Record<string, string>,
) => Promise<string>
Type Declaration
- (
allowDuplicates?: boolean,
appId?: string,
customFields?: Record<string, string>,
): Promise<string> Parameters
- allowDuplicates: boolean = false
OptionalappId: stringOptionalcustomFields: Record<string, string>
Returns Promise<string>
ReadonlycreateKakaoAlimtalkTemplate
createKakaoAlimtalkTemplate: ( data: | { buttons?: readonly (
| { buttonName: string; buttonType: "WL"; linkMo: string; linkPc?: string | null; } | { buttonName: string; buttonType: "AL"; linkAnd: string; linkIos: string; } | { buttonName: string; buttonType: "AC" | "BK" | "MD" | "BC" | "BT" | "DS"; } )
[]; categoryCode: string; content: string; emphasizeSubTitle?: string; emphasizeTitle?: string; emphasizeType?: "TEXT" | "IMAGE" | "NONE" | "ITEM_LIST"; extra?: string; header?: string; highlight?: { description?: string | null; imageId?: string | null; title?: string | null; }; imageId?: string; item?: { list: readonly { description: string; title: string }[]; summary: { description?: string | null; title?: string | null }; }; messageType?: "BA" | "EX" | "AD" | "MI"; name: string; quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string } | { linkAnd: string; linkIos: string; linkType: "AL"; name: string } | { linkType: "BK" | "BC" | "BT"; name: string } )
[]; securityFlag?: boolean; } & { channelId: string } | { buttons?: readonly (
| { buttonName: string; buttonType: "WL"; linkMo: string; linkPc?: string | null; } | { buttonName: string; buttonType: "AL"; linkAnd: string; linkIos: string; } | { buttonName: string; buttonType: "AC" | "BK" | "MD" | "BC" | "BT" | "DS"; } )
[]; categoryCode: string; content: string; emphasizeSubTitle?: string; emphasizeTitle?: string; emphasizeType?: "TEXT" | "IMAGE" | "NONE" | "ITEM_LIST"; extra?: string; header?: string; highlight?: { description?: string | null; imageId?: string | null; title?: string | null; }; imageId?: string; item?: { list: readonly { description: string; title: string }[]; summary: { description?: string | null; title?: string | null }; }; messageType?: "BA" | "EX" | "AD" | "MI"; name: string; quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string } | { linkAnd: string; linkIos: string; linkType: "AL"; name: string } | { linkType: "BK" | "BC" | "BT"; name: string } )
[]; securityFlag?: boolean; } & { channelGroupId: string },) => Promise<KakaoAlimtalkTemplate> Type Declaration
- (
data:
| {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode: string;
content: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
} & { channelId: string }
| {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode: string;
content: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
} & { channelGroupId: string },
): Promise<KakaoAlimtalkTemplate> Parameters
- data:
| {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode: string;
content: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
} & { channelId: string }
| {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode: string;
content: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
} & { channelGroupId: string }
ReadonlycreateKakaoChannel
createKakaoChannel: (
data: {
categoryCode: string;
phoneNumber: string;
searchId: string;
token: string;
},
) => Promise<
{
accountId: string;
channelId: string;
dateCreated: string;
dateUpdated: string;
phoneNumber: string;
searchId: string;
},
>
ReadonlygetBalance
getBalance: () => Promise<
{
accountId?: string;
autoRecharge?: number;
balance: number;
balanceOnly?: number;
deposit?: number;
lowBalanceAlert?: {
balances: readonly number[];
channels: readonly string[];
currentBalance: string;
enabled: boolean;
notificationBalance: string;
};
minimumCash?: number;
point: number;
rechargeTo?: number;
rechargeTryCount?: number;
},
>
Type Declaration
- (): Promise<
{
accountId?: string;
autoRecharge?: number;
balance: number;
balanceOnly?: number;
deposit?: number;
lowBalanceAlert?: {
balances: readonly number[];
channels: readonly string[];
currentBalance: string;
enabled: boolean;
notificationBalance: string;
};
minimumCash?: number;
point: number;
rechargeTo?: number;
rechargeTryCount?: number;
},
> Returns Promise<
{
accountId?: string;
autoRecharge?: number;
balance: number;
balanceOnly?: number;
deposit?: number;
lowBalanceAlert?: {
balances: readonly number[];
channels: readonly string[];
currentBalance: string;
enabled: boolean;
notificationBalance: string;
};
minimumCash?: number;
point: number;
rechargeTo?: number;
rechargeTryCount?: number;
},
>
GetBalanceResponse
ReadonlygetBlacks
getBlacks: (
data?: {
endDate?: string | Date;
limit?: number;
senderNumber?: string;
startDate?: string | Date;
startKey?: string;
},
) => Promise<
{
blackList: readonly {
dateCreated: string;
dateUpdated: string;
handleKey: string;
recipientNumber: string;
senderNumber: string;
type: "DENIAL";
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
Type Declaration
- (
data?: {
endDate?: string | Date;
limit?: number;
senderNumber?: string;
startDate?: string | Date;
startKey?: string;
},
): Promise<
{
blackList: readonly {
dateCreated: string;
dateUpdated: string;
handleKey: string;
recipientNumber: string;
senderNumber: string;
type: "DENIAL";
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
> Parameters
Optionaldata: {
endDate?: string | Date;
limit?: number;
senderNumber?: string;
startDate?: string | Date;
startKey?: string;
}
Returns Promise<
{
blackList: readonly {
dateCreated: string;
dateUpdated: string;
handleKey: string;
recipientNumber: string;
senderNumber: string;
type: "DENIAL";
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
GetBlacksResponse
ReadonlygetBlockGroups
getBlockGroups: (
data?: {
blockGroupId?: string;
limit?: number;
name?: string | { like: string };
senderNumber?: string;
startKey?: string;
status?: "INACTIVE" | "ACTIVE";
useAll?: boolean;
},
) => Promise<
{
blockGroups: readonly {
accountId: string;
blockGroupId: string;
dateCreated: string;
dateUpdated: string;
name: string
| null
| undefined;
senderNumbers: readonly string[];
status: "INACTIVE" | "ACTIVE";
useAll: boolean;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
Type Declaration
- (
data?: {
blockGroupId?: string;
limit?: number;
name?: string | { like: string };
senderNumber?: string;
startKey?: string;
status?: "INACTIVE" | "ACTIVE";
useAll?: boolean;
},
): Promise<
{
blockGroups: readonly {
accountId: string;
blockGroupId: string;
dateCreated: string;
dateUpdated: string;
name: string
| null
| undefined;
senderNumbers: readonly string[];
status: "INACTIVE" | "ACTIVE";
useAll: boolean;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
> Parameters
Optionaldata: {
blockGroupId?: string;
limit?: number;
name?: string | { like: string };
senderNumber?: string;
startKey?: string;
status?: "INACTIVE" | "ACTIVE";
useAll?: boolean;
}
Returns Promise<
{
blockGroups: readonly {
accountId: string;
blockGroupId: string;
dateCreated: string;
dateUpdated: string;
name: string
| null
| undefined;
senderNumbers: readonly string[];
status: "INACTIVE" | "ACTIVE";
useAll: boolean;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
GetBlockGroupsResponse
ReadonlygetBlockNumbers
getBlockNumbers: (
data?: {
blockGroupId?: string;
blockNumberId?: string;
limit?: number;
memo?: string | { like: string };
phoneNumber?: string;
startKey?: string;
},
) => Promise<
{
blockNumbers: readonly {
accountId: string;
blockGroupIds: readonly string[];
blockNumberId: string;
dateCreated: string;
dateUpdated: string;
memo: string;
phoneNumber: string;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
Type Declaration
- (
data?: {
blockGroupId?: string;
blockNumberId?: string;
limit?: number;
memo?: string | { like: string };
phoneNumber?: string;
startKey?: string;
},
): Promise<
{
blockNumbers: readonly {
accountId: string;
blockGroupIds: readonly string[];
blockNumberId: string;
dateCreated: string;
dateUpdated: string;
memo: string;
phoneNumber: string;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
> Parameters
Optionaldata: {
blockGroupId?: string;
blockNumberId?: string;
limit?: number;
memo?: string | { like: string };
phoneNumber?: string;
startKey?: string;
}
Returns Promise<
{
blockNumbers: readonly {
accountId: string;
blockGroupIds: readonly string[];
blockNumberId: string;
dateCreated: string;
dateUpdated: string;
memo: string;
phoneNumber: string;
}[];
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
GetBlockNumbersResponse
ReadonlygetGroup
getGroup: (
groupId: string,
) => Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
>
Type Declaration
- (
groupId: string,
): Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
> 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;
},
>
ReadonlygetGroupMessages
getGroupMessages: (
groupId: string,
data?: { limit?: number; startKey?: string },
) => Promise<
{
limit: number;
messageList: {
readonly [key: string]: {
_id?: string;
accountId?: string;
autoTypeDetect?: boolean;
clusterKey: string
| null
| undefined;
country: string | null | undefined;
currentQueue?: unknown;
customFields?: { readonly [key: string]: string } | null;
dateCreated?: string;
dateProcessed: string | null | undefined;
dateReceived: string | null | undefined;
dateReported: string | null | undefined;
dateUpdated?: string;
faxOptions?: { readonly [key: string]: unknown } | null;
faxPageCount?: number | null;
from: string | null | undefined;
groupId?: string;
imageId: string | null | undefined;
kakaoOptions?: { readonly [key: string]: unknown } | null;
log?: readonly unknown[] | null;
messageId?: string;
naverOptions?: { readonly [key: string]: unknown } | null;
networkCode: string | null | undefined;
networkName: string | null | undefined;
queues?: readonly unknown[] | null;
rcsOptions?: { readonly [key: string]: unknown } | null;
reason: string | null | undefined;
replacement?: boolean;
replacements?: readonly unknown[] | null;
resendCount?: number;
status: string | null | undefined;
statusCode: string | null | undefined;
subject: string | null | undefined;
text: string | null | undefined;
to?: string | readonly string[];
type:
| "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE"
| null
| undefined;
unavailableSenderNumber?: boolean
| null;
voiceDuration?: number | null;
voiceOptions?: { readonly [key: string]: unknown } | null;
voiceReplied?: boolean | null;
};
};
nextKey?: string
| null;
startKey?: string | null;
},
>
Type Declaration
- (
groupId: string,
data?: { limit?: number; startKey?: string },
): Promise<
{
limit: number;
messageList: {
readonly [key: string]: {
_id?: string;
accountId?: string;
autoTypeDetect?: boolean;
clusterKey: string
| null
| undefined;
country: string | null | undefined;
currentQueue?: unknown;
customFields?: { readonly [key: string]: string } | null;
dateCreated?: string;
dateProcessed: string | null | undefined;
dateReceived: string | null | undefined;
dateReported: string | null | undefined;
dateUpdated?: string;
faxOptions?: { readonly [key: string]: unknown } | null;
faxPageCount?: number | null;
from: string | null | undefined;
groupId?: string;
imageId: string | null | undefined;
kakaoOptions?: { readonly [key: string]: unknown } | null;
log?: readonly unknown[] | null;
messageId?: string;
naverOptions?: { readonly [key: string]: unknown } | null;
networkCode: string | null | undefined;
networkName: string | null | undefined;
queues?: readonly unknown[] | null;
rcsOptions?: { readonly [key: string]: unknown } | null;
reason: string | null | undefined;
replacement?: boolean;
replacements?: readonly unknown[] | null;
resendCount?: number;
status: string | null | undefined;
statusCode: string | null | undefined;
subject: string | null | undefined;
text: string | null | undefined;
to?: string | readonly string[];
type:
| "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE"
| null
| undefined;
unavailableSenderNumber?: boolean
| null;
voiceDuration?: number | null;
voiceOptions?: { readonly [key: string]: unknown } | null;
voiceReplied?: boolean | null;
};
};
nextKey?: string
| null;
startKey?: string | null;
},
> Parameters
- groupId: string
Optionaldata: { limit?: number; startKey?: string }
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;
},
>
ReadonlygetGroups
getGroups: (
data?: {
endDate?: string | Date;
groupId?: string;
limit?: number;
startDate?: string | Date;
startKey?: string;
},
) => Promise<
{
groupList: {
readonly [key: string]: {
accountId: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
osPlatform: string | null | undefined;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
scheduledDate: string
| null
| undefined;
sdkVersion: string | null | undefined;
status: string;
};
};
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
>
Type Declaration
- (
data?: {
endDate?: string | Date;
groupId?: string;
limit?: number;
startDate?: string | Date;
startKey?: string;
},
): Promise<
{
groupList: {
readonly [key: string]: {
accountId: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
osPlatform: string | null | undefined;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
scheduledDate: string
| null
| undefined;
sdkVersion: string | null | undefined;
status: string;
};
};
limit: number;
nextKey: string
| null
| undefined;
startKey: string | null | undefined;
},
> Parameters
Optionaldata: {
endDate?: string | Date;
groupId?: string;
limit?: number;
startDate?: string | Date;
startKey?: string;
}
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;
},
>
ReadonlygetKakaoAlimtalkTemplate
ReadonlygetKakaoAlimtalkTemplateCategories
getKakaoAlimtalkTemplateCategories: () => Promise<
{ code: string; name: string }[],
>
Type Declaration
- (): Promise<{ code: string; name: string }[]>
Returns Promise<{ code: string; name: string }[]>
ReadonlygetKakaoAlimtalkTemplates
getKakaoAlimtalkTemplates: ( data?: { channelId?: string; endDate?: string | Date; isHidden?: boolean; limit?: number; name?: string | { like: string } | { eq?: string; ne?: string }; startDate?: string | Date; startKey?: string; status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED"; templateId?: string; },) => Promise<GetKakaoAlimtalkTemplatesFinalizeResponse> Type Declaration
- (
data?: {
channelId?: string;
endDate?: string | Date;
isHidden?: boolean;
limit?: number;
name?: string | { like: string } | { eq?: string; ne?: string };
startDate?: string | Date;
startKey?: string;
status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
templateId?: string;
},
): Promise<GetKakaoAlimtalkTemplatesFinalizeResponse> Parameters
Optionaldata: {
channelId?: string;
endDate?: string | Date;
isHidden?: boolean;
limit?: number;
name?: string | { like: string } | { eq?: string; ne?: string };
startDate?: string | Date;
startKey?: string;
status?: "PENDING" | "INSPECTING" | "APPROVED" | "REJECTED";
templateId?: string;
}
ReadonlygetKakaoChannel
getKakaoChannel: (channelId: string) => Promise<KakaoChannel> ReadonlygetKakaoChannelCategories
getKakaoChannelCategories: () => Promise<{ code: string; name: string }[]>
ReadonlygetKakaoChannels
getKakaoChannels: ( data?: { categoryCode?: string; channelId?: string; endDate?: string | Date; isMine?: boolean; limit?: number; phoneNumber?: string; searchId?: string; startDate?: string | Date; startKey?: string; },) => Promise<GetKakaoChannelsFinalizeResponse> Type Declaration
- (
data?: {
categoryCode?: string;
channelId?: string;
endDate?: string | Date;
isMine?: boolean;
limit?: number;
phoneNumber?: string;
searchId?: string;
startDate?: string | Date;
startKey?: string;
},
): Promise<GetKakaoChannelsFinalizeResponse> Parameters
Optionaldata: {
categoryCode?: string;
channelId?: string;
endDate?: string | Date;
isMine?: boolean;
limit?: number;
phoneNumber?: string;
searchId?: string;
startDate?: string | Date;
startKey?: string;
}
ReadonlygetMessages
getMessages: ( data?: Readonly<GetMessagesRequest>,) => Promise< { limit: number; messageList: { readonly [key: string]: { _id?: string; accountId?: string; autoTypeDetect?: boolean; clusterKey: string | null | undefined; country: string | null | undefined; currentQueue?: unknown; customFields?: { readonly [key: string]: string } | null; dateCreated?: string; dateProcessed: string | null | undefined; dateReceived: string | null | undefined; dateReported: string | null | undefined; dateUpdated?: string; faxOptions?: { readonly [key: string]: unknown } | null; faxPageCount?: number | null; from: string | null | undefined; groupId?: string; imageId: string | null | undefined; kakaoOptions?: { readonly [key: string]: unknown } | null; log?: readonly unknown[] | null; messageId?: string; naverOptions?: { readonly [key: string]: unknown } | null; networkCode: string | null | undefined; networkName: string | null | undefined; queues?: readonly unknown[] | null; rcsOptions?: { readonly [key: string]: unknown } | null; reason: string | null | undefined; replacement?: boolean; replacements?: readonly unknown[] | null; resendCount?: number; status: string | null | undefined; statusCode: string | null | undefined; subject: string | null | undefined; text: string | null | undefined; to?: string | readonly string[]; type: | "SMS" | "LMS" | "MMS" | "ATA" | "CTA" | "CTI" | "NSA" | "RCS_SMS" | "RCS_LMS" | "RCS_MMS" | "RCS_TPL" | "RCS_ITPL" | "RCS_LTPL" | "FAX" | "VOICE" | "BMS_TEXT" | "BMS_IMAGE" | "BMS_WIDE" | "BMS_WIDE_ITEM_LIST" | "BMS_CAROUSEL_FEED" | "BMS_PREMIUM_VIDEO" | "BMS_COMMERCE" | "BMS_CAROUSEL_COMMERCE" | "BMS_FREE" | null | undefined; unavailableSenderNumber?: boolean | null; voiceDuration?: number | null; voiceOptions?: { readonly [key: string]: unknown } | null; voiceReplied?: boolean | null; }; }; nextKey?: string | null; startKey?: string | null; },> Type Declaration
- (
data?: Readonly<GetMessagesRequest>,
): Promise<
{
limit: number;
messageList: {
readonly [key: string]: {
_id?: string;
accountId?: string;
autoTypeDetect?: boolean;
clusterKey: string
| null
| undefined;
country: string | null | undefined;
currentQueue?: unknown;
customFields?: { readonly [key: string]: string } | null;
dateCreated?: string;
dateProcessed: string | null | undefined;
dateReceived: string | null | undefined;
dateReported: string | null | undefined;
dateUpdated?: string;
faxOptions?: { readonly [key: string]: unknown } | null;
faxPageCount?: number | null;
from: string | null | undefined;
groupId?: string;
imageId: string | null | undefined;
kakaoOptions?: { readonly [key: string]: unknown } | null;
log?: readonly unknown[] | null;
messageId?: string;
naverOptions?: { readonly [key: string]: unknown } | null;
networkCode: string | null | undefined;
networkName: string | null | undefined;
queues?: readonly unknown[] | null;
rcsOptions?: { readonly [key: string]: unknown } | null;
reason: string | null | undefined;
replacement?: boolean;
replacements?: readonly unknown[] | null;
resendCount?: number;
status: string | null | undefined;
statusCode: string | null | undefined;
subject: string | null | undefined;
text: string | null | undefined;
to?: string | readonly string[];
type:
| "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE"
| null
| undefined;
unavailableSenderNumber?: boolean
| null;
voiceDuration?: number | null;
voiceOptions?: { readonly [key: string]: unknown } | null;
voiceReplied?: boolean | null;
};
};
nextKey?: string
| null;
startKey?: string | null;
},
> 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;
},
>
ReadonlygetStatistics
getStatistics: (
data?: Readonly<
{
endDate?: string
| Date;
masterAccountId?: string;
startDate?: string | Date;
},
>,
) => Promise<
{
balance: number;
dailyBalanceAvg?: number;
dailyFailedCountAvg?: number;
dailyPointAvg?: number;
dailySuccessedCountAvg?: number;
dailyTotalCountAvg?: number;
deposit?: number;
failed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
monthlyBalanceAvg: number;
monthlyDepositAvg?: number;
monthlyPointAvg: number;
monthPeriod: readonly {
balance: number;
balanceAvg: number;
date: string;
dayPeriod: readonly {
_id: string;
balance: number;
date?: string;
deposit?: number;
failed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
month: string;
point: number;
refund: { balance: number; deposit?: number; point: number };
statusCode: {
readonly [key: string]: {
ata?: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta?: number;
cti?: number;
fax?: number;
lms?: number;
mms?: number;
nsa?: number;
rcs_itpl?: number;
rcs_lms?: number;
rcs_ltpl?: number;
rcs_mms?: number;
rcs_sms?: number;
rcs_tpl?: number;
sms?: number;
voice?: number;
};
};
successed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
total: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
}[];
deposit?: number;
depositAvg?: number;
failed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
point: number;
pointAvg: number;
refund?: {
balance: number;
balanceAvg: number;
deposit?: number;
depositAvg?: number;
point: number;
pointAvg: number;
};
successed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
total: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
}[];
point: number;
successed: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
total: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
total: number;
voice?: number;
};
},
>
ReadonlyremoveGroup
removeGroup: (
groupId: string,
) => Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
>
Type Declaration
- (
groupId: string,
): Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
> 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;
},
>
ReadonlyremoveGroupMessages
removeGroupMessages: (
groupId: string,
messageIds: string[],
) => Promise<
{
errorCount: number;
groupId: string;
resultList: readonly { messageId: string; resultCode: string }[];
},
>
Type Declaration
- (
groupId: string,
messageIds: string[],
): Promise<
{
errorCount: number;
groupId: string;
resultList: readonly { messageId: string; resultCode: string }[];
},
> Parameters
- groupId: string
- messageIds: string[]
Returns Promise<
{
errorCount: number;
groupId: string;
resultList: readonly { messageId: string; resultCode: string }[];
},
>
ReadonlyremoveKakaoAlimtalkTemplate
ReadonlyremoveKakaoChannel
removeKakaoChannel: (channelId: string) => Promise<KakaoChannel> ReadonlyremoveReservationToGroup
removeReservationToGroup: (
groupId: string,
) => Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
>
Type Declaration
- (
groupId: string,
): Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
> 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;
},
>
ReadonlyrequestKakaoChannelToken
requestKakaoChannelToken: (
data: { phoneNumber: string; searchId: string },
) => Promise<{ success: boolean }>
ReadonlyreserveGroup
reserveGroup: (
groupId: string,
scheduledDate: string | Date,
) => Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
>
Type Declaration
- (
groupId: string,
scheduledDate: string | Date,
): Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
> Parameters
- groupId: string
- 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;
},
>
Readonlysend
send: (
messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[],
requestConfigParameter?: {
allowDuplicates?: boolean;
appId?: string;
scheduledDate?: string;
showMessageList?: boolean;
},
) => Promise<
{
failedMessageList: readonly {
accountId: string;
country: string;
customFields?: { readonly [key: string]: string };
from: string;
messageId: string;
statusCode: string;
statusMessage: string;
to: string;
type: string;
}[];
groupInfo: {
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
};
messageList?: readonly {
customFields?: { readonly [key: string]: string };
messageId: string;
statusCode: string;
statusMessage: string;
}[];
},
>
Type Declaration
- (
messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[],
requestConfigParameter?: {
allowDuplicates?: boolean;
appId?: string;
scheduledDate?: string;
showMessageList?: boolean;
},
): Promise<
{
failedMessageList: readonly {
accountId: string;
country: string;
customFields?: { readonly [key: string]: string };
from: string;
messageId: string;
statusCode: string;
statusMessage: string;
to: string;
type: string;
}[];
groupInfo: {
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
};
messageList?: readonly {
customFields?: { readonly [key: string]: string };
messageId: string;
statusCode: string;
statusMessage: string;
}[];
},
> Parameters
- messages:
| {
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (
(...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
carousel?:
| { list: readonly (...)[]; tail?: (...) | (...) }
| {
head?: (...) | (...);
list: readonly (...)[];
tail?: (...) | (...);
};
chatBubbleType: | "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: (...)
| (...);
discountPrice?: (...) | (...);
discountRate?: (...) | (...);
regularPrice: number;
title: string;
};
content?: string;
coupon?: {
description: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile?: (...) | (...);
linkPc?: (...) | (...);
title: string;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: string;
linkAndroid?: (...)
| (...);
linkIos?: (...) | (...);
linkMobile: string;
linkPc?: (...) | (...);
title?: (...) | (...);
};
subWideItemList?: readonly {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title: ...;
}[];
targeting: "I"
| "M"
| "N";
video?: {
imageId?: (...) | (...);
imageLink?: (...) | (...);
videoUrl: string;
};
};
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: (...)
| (...)
| (...);
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: string;
linkIos?: string;
linkMo?: string;
linkPc?: string;
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly ((...) | (...) | (...))[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: string; buttonType: "WL"; link: string }
| {
buttonName: string;
buttonType: "ML";
latitude: string;
longitude: string;
}
| {
buttonName: string;
buttonType: (...)
| (...)
| (...)
| (...)
| (...)
| (...);
link: string;
}
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3"
| "S3"
| "M4"
| "S4"
| "M5"
| "S5"
| "M6"
| "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
| readonly (
{
autoTypeDetect?: boolean;
country?: string;
customFields?: { readonly [key: string]: string };
faxOptions?: { fileIds: readonly string[] };
imageId?: string;
kakaoOptions?: {
adFlag?: boolean;
bms?: {
additionalContent?: string;
adult?: boolean;
buttons?: readonly (...)[];
carousel?:
| { list: ...; tail?: ... }
| { head?: ...; list: ...; tail?: ... };
chatBubbleType:
| "TEXT"
| "IMAGE"
| "WIDE"
| "WIDE_ITEM_LIST"
| "COMMERCE"
| "CAROUSEL_FEED"
| "CAROUSEL_COMMERCE"
| "PREMIUM_VIDEO";
commerce?: {
discountFixed?: ...;
discountPrice?: ...;
discountRate?: ...;
regularPrice: ...;
title: ...;
};
content?: string;
coupon?: {
description: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile?: ...;
linkPc?: ...;
title: ...;
};
header?: string;
imageId?: string;
imageLink?: string;
mainWideItem?: {
imageId: ...;
linkAndroid?: ...;
linkIos?: ...;
linkMobile: ...;
linkPc?: ...;
title?: ...;
};
subWideItemList?: readonly (...)[];
targeting: "I" | "M" | "N";
video?: { imageId?: ...; imageLink?: ...; videoUrl: ... };
};
buttons?: readonly (
| { buttonName: ...; buttonType: ...; linkMo: ...; linkPc?: ... }
| { buttonName: ...; buttonType: ...; linkAnd: ...; linkIos: ... }
| { buttonName: ...; buttonType: ... }
)[];
disableSms?: boolean;
imageId?: string;
pfId: string;
templateId?: string;
variables?: { readonly [key: string]: string };
};
naverOptions?: {
buttons?: readonly {
buttonName: string;
buttonType: string;
linkAnd?: (...)
| (...);
linkIos?: (...) | (...);
linkMo?: (...) | (...);
linkPc?: (...) | (...);
}[];
disableSms?: boolean;
talkId: string;
templateId: string;
variables?: { readonly [key: string]: string };
};
rcsOptions?: {
additionalBody?: {
buttons?: readonly (...)[];
description: string;
imaggeId?: string;
title: string;
};
brandId: string;
buttons?: readonly (
| { buttonName: ...; buttonType: ...; link: ... }
| { buttonName: ...; buttonType: ...; latitude: ...; longitude: ... }
| { buttonName: ...; buttonType: ...; link: ... }
)[];
commercialType?: boolean;
copyAllowed?: boolean;
disableSms?: boolean;
mmsType?: "M3" | "S3" | "M4" | "S4" | "M5" | "S5" | "M6" | "S6";
templateId?: string;
variables?: { readonly [key: string]: string };
};
replacements?: readonly {}[];
subject?: string;
text?: string;
type?: | "SMS"
| "LMS"
| "MMS"
| "ATA"
| "CTA"
| "CTI"
| "NSA"
| "RCS_SMS"
| "RCS_LMS"
| "RCS_MMS"
| "RCS_TPL"
| "RCS_ITPL"
| "RCS_LTPL"
| "FAX"
| "VOICE"
| "BMS_TEXT"
| "BMS_IMAGE"
| "BMS_WIDE"
| "BMS_WIDE_ITEM_LIST"
| "BMS_CAROUSEL_FEED"
| "BMS_PREMIUM_VIDEO"
| "BMS_COMMERCE"
| "BMS_CAROUSEL_COMMERCE"
| "BMS_FREE";
voiceOptions?: {
counselorNumber?: string;
headerMessage?: string;
replyRange?: 2
| 1
| 3
| 4
| 5
| 6
| 7
| 8
| 9;
tailMessage?: string;
voiceType: "FEMALE" | "MALE";
};
} & { from?: string; to: string
| readonly string[] }
)[] OptionalrequestConfigParameter: {
allowDuplicates?: boolean;
appId?: string;
scheduledDate?: string;
showMessageList?: boolean;
}
Returns Promise<
{
failedMessageList: readonly {
accountId: string;
country: string;
customFields?: { readonly [key: string]: string };
from: string;
messageId: string;
statusCode: string;
statusMessage: string;
to: string;
type: string;
}[];
groupInfo: {
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
};
messageList?: readonly {
customFields?: { readonly [key: string]: string };
messageId: string;
statusCode: string;
statusMessage: string;
}[];
},
>
ReadonlysendGroup
sendGroup: (
groupId: string,
) => Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
>
Type Declaration
- (
groupId: string,
): Promise<
{
accountId: string;
allowDuplicates: boolean;
apiVersion: string;
app: {
appId: string
| null
| undefined;
profit: {
ata: number;
bms_carousel_commerce?: number;
bms_carousel_feed?: number;
bms_commerce?: number;
bms_free?: number;
bms_image?: number;
bms_premium_video?: number;
bms_text?: number;
bms_wide?: number;
bms_wide_item_list?: number;
cta: number;
cti: number;
fax?: number;
lms: number;
mms: number;
nsa: number;
rcs_itpl?: number;
rcs_lms: number;
rcs_ltpl?: number;
rcs_mms: number;
rcs_sms: number;
rcs_tpl: number;
sms: number;
voice?: number;
};
};
balance: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
count: {
refund: number;
registeredFailed: number;
registeredSuccess: number;
sentFailed: number;
sentPending: number;
sentReplacement: number;
sentSuccess: number;
sentTotal: number;
total: number;
};
countForCharge: {
ata: { readonly [key: string]: number };
bms_carousel_commerce?: { readonly [key: string]: number };
bms_carousel_feed?: { readonly [key: string]: number };
bms_commerce?: { readonly [key: string]: number };
bms_free?: { readonly [key: string]: number };
bms_image?: { readonly [key: string]: number };
bms_premium_video?: { readonly [key: string]: number };
bms_text?: { readonly [key: string]: number };
bms_wide?: { readonly [key: string]: number };
bms_wide_item_list?: { readonly [key: string]: number };
cta: { readonly [key: string]: number };
cti: { readonly [key: string]: number };
fax?: { readonly [key: string]: number };
lms: { readonly [key: string]: number };
mms: { readonly [key: string]: number };
nsa: { readonly [key: string]: number };
rcs_itpl?: { readonly [key: string]: number };
rcs_lms: { readonly [key: string]: number };
rcs_ltpl?: { readonly [key: string]: number };
rcs_mms: { readonly [key: string]: number };
rcs_sms: { readonly [key: string]: number };
rcs_tpl: { readonly [key: string]: number };
sms: { readonly [key: string]: number };
voice?: { readonly [key: string]: number };
};
dateCompleted: string
| null
| undefined;
dateCreated: string;
dateSent: string | null | undefined;
dateUpdated: string;
groupId: string;
isRefunded: boolean;
log: readonly { readonly [key: string]: unknown }[];
masterAccountId: string | null;
point: {
refund: number;
replacement: number;
requested: number;
sum: number;
};
price: { readonly [key: string]: unknown };
scheduledDate: string | null | undefined;
status: string;
},
> 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;
},
>
ReadonlyupdateKakaoAlimtalkTemplate
updateKakaoAlimtalkTemplate: ( templateId: string, data: { buttons?: readonly (
| { buttonName: string; buttonType: "WL"; linkMo: string; linkPc?: string | null; } | { buttonName: string; buttonType: "AL"; linkAnd: string; linkIos: string; } | { buttonName: string; buttonType: "AC" | "BK" | "MD" | "BC" | "BT" | "DS"; } )
[]; categoryCode?: string; content?: string; emphasizeSubTitle?: string; emphasizeTitle?: string; emphasizeType?: "TEXT" | "IMAGE" | "NONE" | "ITEM_LIST"; extra?: string; header?: string; highlight?: { description?: string | null; imageId?: string | null; title?: string | null; }; imageId?: string; item?: { list: readonly { description: string; title: string }[]; summary: { description?: string | null; title?: string | null }; }; messageType?: "BA" | "EX" | "AD" | "MI"; name?: string; quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string } | { linkAnd: string; linkIos: string; linkType: "AL"; name: string } | { linkType: "BK" | "BC" | "BT"; name: string } )
[]; securityFlag?: boolean; },) => Promise<KakaoAlimtalkTemplate> Type Declaration
- (
templateId: string,
data: {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode?: string;
content?: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name?: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
},
): Promise<KakaoAlimtalkTemplate> Parameters
- templateId: string
- data: {
buttons?: readonly (
| {
buttonName: string;
buttonType: "WL";
linkMo: string;
linkPc?: string
| null;
}
| {
buttonName: string;
buttonType: "AL";
linkAnd: string;
linkIos: string;
}
| {
buttonName: string;
buttonType: "AC"
| "BK"
| "MD"
| "BC"
| "BT"
| "DS";
}
)[];
categoryCode?: string;
content?: string;
emphasizeSubTitle?: string;
emphasizeTitle?: string;
emphasizeType?: "TEXT"
| "IMAGE"
| "NONE"
| "ITEM_LIST";
extra?: string;
header?: string;
highlight?: {
description?: string | null;
imageId?: string | null;
title?: string | null;
};
imageId?: string;
item?: {
list: readonly { description: string; title: string }[];
summary: { description?: string | null; title?: string | null };
};
messageType?: "BA"
| "EX"
| "AD"
| "MI";
name?: string;
quickReplies?: readonly (
| { linkMo: string; linkPc?: string; linkType: "WL"; name: string }
| { linkAnd: string; linkIos: string; linkType: "AL"; name: string }
| { linkType: "BK" | "BC" | "BT"; name: string }
)[];
securityFlag?: boolean;
}
ReadonlyupdateKakaoAlimtalkTemplateName
Type Declaration
- (templateId: string, name: string): Promise<KakaoAlimtalkTemplate>
Parameters
- templateId: string
- name: string
ReadonlyuploadFile
uploadFile: (
filePath: string,
fileType:
| "MMS"
| "FAX"
| "BMS_WIDE"
| "KAKAO"
| "DOCUMENT"
| "RCS"
| "BMS"
| "BMS_WIDE_MAIN_ITEM_LIST"
| "BMS_WIDE_SUB_ITEM_LIST"
| "BMS_CAROUSEL_FEED_LIST"
| "BMS_CAROUSEL_COMMERCE_LIST",
name?: string,
link?: string,
) => Promise<
{ fileId: string; link: string
| null
| undefined; type: string },
>
Type Declaration
- (
filePath: string,
fileType:
| "MMS"
| "FAX"
| "BMS_WIDE"
| "KAKAO"
| "DOCUMENT"
| "RCS"
| "BMS"
| "BMS_WIDE_MAIN_ITEM_LIST"
| "BMS_WIDE_SUB_ITEM_LIST"
| "BMS_CAROUSEL_FEED_LIST"
| "BMS_CAROUSEL_COMMERCE_LIST",
name?: string,
link?: string,
): Promise<
{ fileId: string; link: string
| null
| undefined; type: string },
> Parameters
- filePath: string
- fileType:
| "MMS"
| "FAX"
| "BMS_WIDE"
| "KAKAO"
| "DOCUMENT"
| "RCS"
| "BMS"
| "BMS_WIDE_MAIN_ITEM_LIST"
| "BMS_WIDE_SUB_ITEM_LIST"
| "BMS_CAROUSEL_FEED_LIST"
| "BMS_CAROUSEL_COMMERCE_LIST" Optionalname: stringOptionallink: string
Returns Promise<{ fileId: string; link: string | null | undefined; type: string }>
SOLAPI 메시지 서비스 발송 및 조회 등 SOLAPI에서 제공되는 여러 API의 기능을 쉽게 사용할 수 있습니다. SOLAPI 자체의 서비스에 관한 사항은 SOLAPI 홈페이지를 참고해주세요.
See