Class SolapiMessageService

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

See

https://solapi.github.io/solapi-nodejs

Hierarchy

SolapiMessageService

Constructors

constructor

new SolapiMessageService(apiKey: string, apiSecret: string): SolapiMessageService
Parameters
- apiKey: string
- apiSecret: string
Returns SolapiMessageService
- Defined in src/solapi.ts:112

Properties

`Private` `Readonly` authInfo

authInfo: {
apiKey: string;
apiSecret: string;
}

Type declaration

apiKey: string
apiSecret: string

`Private` `Readonly` baseUrl

baseUrl: "https://api.solapi.com" = 'https://api.solapi.com'

Methods

addMessagesToGroup

addMessagesToGroup(groupId: string, messages: Message[]): Promise<AddMessageResponse>
그룹 메시지 추가 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
Parameters
- groupId: string
  
  생성 된 Group ID
- messages: Message[]
  
  여러 메시지(문자, 알림톡 등)
Returns Promise<AddMessageResponse>
- Defined in src/solapi.ts:291

cancelInspectionKakaoAlimtalkTemplate

cancelInspectionKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 검수 취소 요청
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:781

createGroup

createGroup(allowDuplicates?: boolean, appId?: string, customFields?: Record<string, string>): Promise<string>
그룹 생성
Parameters
- Optional allowDuplicates: boolean
- Optional appId: string
- Optional customFields: Record<string, string>
Returns Promise<string>
- Defined in src/solapi.ts:261

createKakaoAlimtalkTemplate

createKakaoAlimtalkTemplate(data: CreateKakaoAlimtalkTemplateRequest): Promise<KakaoAlimtalkTemplate>
Description
카카오 알림톡 템플릿 생성 반드시 getKakaoAlimtalkTemplateCategories를 먼저 호출하여 카테고리 값을 확인해야 합니다!
Parameters
- data: CreateKakaoAlimtalkTemplateRequest
  
  알림톡 템플릿 생성을 위한 파라미터
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:742

createKakaoChannel

createKakaoChannel(data: CreateKakaoChannelRequest): Promise<CreateKakaoChannelResponse>
Description
카카오 채널 연동 메소드 getKakaoChannelCategories, requestKakaoChannelToken 메소드를 선행적으로 호출해야 합니다!
Parameters
- data: CreateKakaoChannelRequest
Returns Promise<CreateKakaoChannelResponse>
- Defined in src/solapi.ts:642

deleteKakaoAlimtalkTemplate

deleteKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
Deprecated
해당 메소드는 더이상 사용되지 않습니다. removeKakaoAlimtalkTemplate를 이용해주세요! 카카오 알림톡 템플릿 삭제(대기, 반려 상태일 때만 삭제가능)
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:845

getBalance

getBalance(): Promise<GetBalanceResponse>
잔액조회

Returns
GetBalanceResponse

Returns Promise<GetBalanceResponse>
- Defined in src/solapi.ts:512

getBlacks

getBlacks(data?: GetBlacksRequest): Promise<GetBlacksResponse>
080 수신 거부 조회

Returns
GetBlacksResponse
Parameters
- Optional data: GetBlacksRequest
  
  080 수신 거부 상세 조회용 request 데이터
Returns Promise<GetBlacksResponse>
- Defined in src/solapi.ts:875

getBlockGroups

getBlockGroups(data?: GetBlockGroupsRequest): Promise<GetBlockGroupsResponse>
수신 거부 그룹 조회

Returns
GetBlockGroupsResponse
Parameters
- Optional data: GetBlockGroupsRequest
  
  수신 거부 그룹 조회용 request 데이터
Returns Promise<GetBlockGroupsResponse>
- Defined in src/solapi.ts:900

getBlockNumbers

getBlockNumbers(data?: GetBlockNumbersRequest): Promise<GetBlockNumbersResponse>
수신 차단 그룹 별 수신번호 조회

Returns
GetBlockNumbersResponse
Parameters
- Optional data: GetBlockNumbersRequest
  
  수신 거부 그룹 별 수신번호 조회용 request 데이터
Returns Promise<GetBlockNumbersResponse>
- Defined in src/solapi.ts:925

getGroup

getGroup(groupId: string): Promise<GroupMessageResponse>
단일 그룹정보 조회
Parameters
- groupId: string
  
  그룹 ID
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:345

getGroupMessages

getGroupMessages(groupId: string, data?: GetGroupMessagesRequest): Promise<GetMessagesResponse>
그룹 내 메시지 목록 조회
Parameters
- groupId: string
  
  생성 된 Group ID
- Optional data: GetGroupMessagesRequest
  
  startkey, limit 등 쿼리 조건 파라미터
Returns Promise<GetMessagesResponse>
- Defined in src/solapi.ts:385

getGroups

getGroups(data?: GetGroupsRequest): Promise<GetGroupsResponse>
그룹 목록 정보 조회
Parameters
- Optional data: GetGroupsRequest
  
  그룹 정보 상세 조회용 request 데이터
Returns Promise<GetGroupsResponse>
- Defined in src/solapi.ts:360

getKakaoAlimtalkTemplate

getKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 템플릿 상세 조회
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:707

getKakaoAlimtalkTemplateCategories

getKakaoAlimtalkTemplateCategories(): Promise<KakaoChannelCategory[]>
카카오 템플릿 카테고리 조회

Returns Promise<KakaoChannelCategory[]>
- Defined in src/solapi.ts:724

getKakaoAlimtalkTemplates

getKakaoAlimtalkTemplates(data?: GetKakaoAlimtalkTemplatesRequest): Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>
카카오 템플릿 목록 조회
Parameters
- Optional data: GetKakaoAlimtalkTemplatesRequest
  
  카카오 템플릿 목록을 더 자세하게 조회할 때 필요한 파라미터
Returns Promise<GetKakaoAlimtalkTemplatesFinalizeResponse>
- Defined in src/solapi.ts:671

getKakaoChannel

getKakaoChannel(channelId: string): Promise<KakaoChannel>
Description
카카오 채널 조회
Parameters
- channelId: string
  
  카카오 채널 ID(구 pfId)
Returns Promise<KakaoChannel>
- Defined in src/solapi.ts:610

getKakaoChannelCategories

getKakaoChannelCategories(): Promise<KakaoChannelCategory[]>
카카오 채널 카테고리 조회

Returns Promise<KakaoChannelCategory[]>
- Defined in src/solapi.ts:562

getKakaoChannels

getKakaoChannels(data?: GetKakaoChannelsRequest): Promise<GetKakaoChannelsFinalizeResponse>
카카오 채널 목록 조회
Parameters
- Optional data: GetKakaoChannelsRequest
  
  카카오 채널 목록을 더 자세하게 조회할 때 필요한 파라미터
Returns Promise<GetKakaoChannelsFinalizeResponse>
- Defined in src/solapi.ts:577

getMessages

getMessages(data?: Readonly<GetMessagesRequest>): Promise<GetMessagesResponse>
메시지 목록 조회
Parameters
- Optional data: Readonly<GetMessagesRequest>
  
  목록 조회 상세조건 파라미터
Returns Promise<GetMessagesResponse>
- Defined in src/solapi.ts:459

getStatistics

getStatistics(data?: Readonly<GetStatisticsRequest>): Promise<GetStatisticsResponse>
통계 조회

Returns
GetStatisticsResponse 통계 결과
Parameters
- Optional data: Readonly<GetStatisticsRequest>
  
  통계 상세 조건 파라미터
Returns Promise<GetStatisticsResponse>
- Defined in src/solapi.ts:486

removeGroup

removeGroup(groupId: string): Promise<GroupMessageResponse>
그룹 삭제
Parameters
- groupId: string
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:444

removeGroupMessages

removeGroupMessages(groupId: string, messageIds: string[]): Promise<RemoveGroupMessagesResponse>
그룹 내 특정 메시지 삭제
Parameters
- groupId: string
  
  생성 된 Group Id
- messageIds: string[]
  
  생성 된 메시지 ID 목록
Returns Promise<RemoveGroupMessagesResponse>
- Defined in src/solapi.ts:409

removeKakaoAlimtalkTemplate

removeKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 삭제(대기, 반려 상태일 때만 삭제가능)
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:855

removeKakaoChannel

removeKakaoChannel(channelId: string): Promise<KakaoChannel>
Description
카카오 채널 삭제, 채널이 삭제 될 경우 해당 채널의 템플릿이 모두 삭제됩니다!
Parameters
- channelId: string
  
  카카오 채널 ID
Returns Promise<KakaoChannel>
- Defined in src/solapi.ts:659

removeReservationToGroup

removeReservationToGroup(groupId: string): Promise<GroupMessageResponse>
그룹 내 예약 발송 취소(메시지 실패 전체 처리 됨)
Parameters
- groupId: string
  
  생성 된 Group ID
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:427

requestInspectionKakaoAlimtalkTemplate

requestInspectionKakaoAlimtalkTemplate(templateId: string): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 검수 요청
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:762

requestKakaoChannelToken

requestKakaoChannelToken(data: CreateKakaoChannelTokenRequest): Promise<RequestKakaoChannelTokenResponse>
Description
카카오 채널 연동을 위한 인증 토큰 요청
Parameters
- data: CreateKakaoChannelTokenRequest
Returns Promise<RequestKakaoChannelTokenResponse>
- Defined in src/solapi.ts:625

reserveGroup

reserveGroup(groupId: string, scheduledDate: Date): Promise<GroupMessageResponse>
그룹 예약 발송 설정
Parameters
- groupId: string
  
  생성 된 Group ID
- scheduledDate: Date
  
  예약발송 할 날짜
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:326

send

send(messages: MessageParameter | MessageParameter[], requestConfigParameter?: SendRequestConfig): Promise<DetailGroupMessageResponse>
메시지 발송 기능, sendMany 함수에서 조금 더 개선된 오류 표시 기능등을 제공합니다. 한번의 요청으로 최대 10,000건까지 발송할 수 있습니다.

Throws
MessageNotReceivedError
Parameters
- messages: MessageParameter | MessageParameter[]
  
  발송 요청할 메시지 파라미터(문자, 알림톡 등)
- Optional requestConfigParameter: SendRequestConfig
  
  request시 필요한 파라미터 오브젝트
Returns Promise<DetailGroupMessageResponse>
- Defined in src/solapi.ts:126

sendGroup

sendGroup(groupId: string): Promise<GroupMessageResponse>
그룹 메시지 전송 요청
Parameters
- groupId: string
  
  생성 된 Group ID
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:310

sendMany

sendMany(messages: Message[], allowDuplicates?: boolean, appId?: string): Promise<GroupMessageResponse>
Deprecated
이 기능은 더이상 사용되지 않습니다. send 메소드를 이용하세요! 여러 메시지 즉시 발송 기능 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
Parameters
- messages: Message[]
  
  여러 메시지(문자, 알림톡 등)
- allowDuplicates: boolean = false
  
  중복 수신번호 허용
- Optional appId: string
  
  appstore용 app id
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:216

sendManyFuture

sendManyFuture(messages: Message[], scheduledDate: string | Date, allowDuplicates?: boolean, appId?: string): Promise<GroupMessageResponse>
Deprecated
이 기능은 더이상 사용되지 않습니다. send 메소드를 이용하세요! 여러 메시지 예약 발송 기능 한번 요청으로 최대 10,000건의 메시지를 추가할 수 있습니다.
Parameters
- messages: Message[]
  
  여러 메시지(문자, 알림톡 등)
- scheduledDate: string | Date
  
  예약 발송 일자
- allowDuplicates: boolean = false
  
  중복 수신번호 허용
- Optional appId: string
  
  appstore용 app id
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:246

sendOne

sendOne(message: Message, appId?: string): Promise<SingleMessageSentResponse>
단일 메시지 발송 기능
Parameters
- message: Message
  
  메시지(문자, 알림톡 등)
- Optional appId: string
  
  appstore용 app id
Returns Promise<SingleMessageSentResponse>
- Defined in src/solapi.ts:178

sendOneFuture

sendOneFuture(message: Message, scheduledDate: string | Date): Promise<GroupMessageResponse>
단일 메시지 예약 발송 기능
Parameters
- message: Message
  
  메시지(문자, 알림톡 등)
- scheduledDate: string | Date
  
  예약일시
Returns Promise<GroupMessageResponse>
- Defined in src/solapi.ts:198

updateKakaoAlimtalkTemplate

updateKakaoAlimtalkTemplate(templateId: string, data: UpdateKakaoAlimtalkTemplateRequest): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 수정(검수 X)
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
- data: UpdateKakaoAlimtalkTemplateRequest
  
  카카오 알림톡 템플릿 수정을 위한 파라미터
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:801

updateKakaoAlimtalkTemplateName

updateKakaoAlimtalkTemplateName(templateId: string, name: string): Promise<KakaoAlimtalkTemplate>
카카오 알림톡 템플릿 이름 수정(검수 상태 상관없이 변경가능)
Parameters
- templateId: string
  
  카카오 알림톡 템플릿 ID
- name: string
  
  카카오 알림톡 템플릿 이름 변경을 위한 파라미터
Returns Promise<KakaoAlimtalkTemplate>
- Defined in src/solapi.ts:822

uploadFile

uploadFile(filePath: string, fileType: FileType, name?: string, link?: string): Promise<FileUploadResponse>
파일(이미지) 업로드 카카오 친구톡 이미지는 500kb, MMS는 200kb, 발신번호 서류 인증용 파일은 2mb의 제한이 있음
Parameters
- filePath: string
  
  해당 파일의 경로 또는 접근 가능한 이미지 URL
- fileType: FileType
  
  저장할 파일의 유형, 예) 카카오 친구톡 용 이미지 -> KAKAO, MMS용 사진 -> MMS, 발신번호 서류 인증에 쓰이는 문서 등 -> DOCUMENT, RCS 이미지 -> RCS
- Optional name: string
  
  파일 이름
- Optional link: string
  
  파일 링크, 친구톡의 경우 필수 값
Returns Promise<FileUploadResponse>
- Defined in src/solapi.ts:535

Class SolapiMessageService

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKey: string

apiSecret: string

Returns SolapiMessageService

Properties

Private Readonly authInfo

Type declaration

apiKey: string

apiSecret: string

Private Readonly baseUrl

Methods

addMessagesToGroup

Parameters

groupId: string

messages: Message[]

Returns Promise<AddMessageResponse>

cancelInspectionKakaoAlimtalkTemplate

Parameters

templateId: string

Returns Promise<KakaoAlimtalkTemplate>

createGroup

Parameters

Optional allowDuplicates: boolean

Optional appId: string

Optional customFields: Record<string, string>

Returns Promise<string>

createKakaoAlimtalkTemplate

Description

Parameters

data: CreateKakaoAlimtalkTemplateRequest

Returns Promise<KakaoAlimtalkTemplate>

createKakaoChannel

Description

Parameters

data: CreateKakaoChannelRequest

Returns Promise<CreateKakaoChannelResponse>

deleteKakaoAlimtalkTemplate

Deprecated

Parameters

templateId: string

Returns Promise<KakaoAlimtalkTemplate>

getBalance

Returns

Returns Promise<GetBalanceResponse>

getBlacks

Returns

Parameters

Optional data: GetBlacksRequest

Returns Promise<GetBlacksResponse>

getBlockGroups

Returns

Parameters

Optional data: GetBlockGroupsRequest

Returns Promise<GetBlockGroupsResponse>

getBlockNumbers

Returns

Parameters

Optional data: GetBlockNumbersRequest

Returns Promise<GetBlockNumbersResponse>

getGroup

Parameters

groupId: string

Returns Promise<GroupMessageResponse>

getGroupMessages

Parameters

groupId: string

Optional data: GetGroupMessagesRequest

Returns Promise<GetMessagesResponse>

getGroups

Parameters

Optional data: GetGroupsRequest

`Private` `Readonly` authInfo

`Private` `Readonly` baseUrl

`Optional` allowDuplicates: boolean

`Optional` appId: string

`Optional` customFields: Record<string, string>

`Optional` data: GetBlacksRequest

`Optional` data: GetBlockGroupsRequest

`Optional` data: GetBlockNumbersRequest

`Optional` data: GetGroupMessagesRequest

`Optional` data: GetGroupsRequest

`Optional` data: GetKakaoAlimtalkTemplatesRequest

`Optional` data: GetKakaoChannelsRequest

`Optional` data: Readonly<GetMessagesRequest>

`Optional` data: Readonly<GetStatisticsRequest>