Class SmsManagementClient

SMS 관리 클라이언트

SMS 발신번호, 통계, 수신거부, 결과 조회, 다운로드, 태그, UID, 첨부파일 등의 관리 기능을 제공합니다.

Example

const client = new SmsManagementClient({ accessKeyId, secretAccessKey });

// 발신번호 조회
const senders = await client.listSenders("client-1");

// 통계 조회
const stats = await client.listStats("client-1", {
  statisticsType: "DATE",
  from: "2024-01-01 00:00:00",
  to: "2024-01-31 23:59:59"
});

// 태그 생성
const tag = await client.createTag("client-1", { tagName: "VIP고객" });

// 첨부파일 업로드
const attachment = await client.uploadAttachment("client-1", {
  fileName: "image.jpg",
  fileBody: "base64EncodedData..."
});

Constructors

constructor

new SmsManagementClient(
credentials: AwesomeMessageCredentials,
): SmsManagementClient
SMS 관리 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns SmsManagementClient
Overrides BaseClient.constructor

Methods

`Protected`createSendHeaders

createSendHeaders(options?: SendOptions): Record<string, string>
SendOptions에서 HTTP 헤더를 생성합니다
Parameters
- Optionaloptions: SendOptions
  발송 옵션
Returns Record<string, string>
생성된 헤더 객체

Inherited from BaseClient.createSendHeaders

`Protected`get

get<T>(path: string, headers?: Record<string, string>): Promise<T>
GET 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.get

`Protected`post

post<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
POST 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.post

`Protected`postFormData

postFormData<T>(
    path: string,
    formData: FormData,
    headers?: Record<string, string>,
): Promise<T>
FormData를 사용한 POST 요청 (multipart/form-data)
Type Parameters
- T
Parameters
- path: string
  API 경로
- formData: FormData
  undici의 FormData 객체
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.postFormData

`Protected`put

put<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
PUT 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.put

`Protected`delete

delete<T>(path: string, headers?: Record<string, string>): Promise<T>
DELETE 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.delete

`Protected`deleteWithBody

deleteWithBody<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
DELETE 요청 (body 포함)
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.deleteWithBody

listSenders

listSenders(
externalId: string,
query?: ListSmsSendersRequest,
): Promise<ListSmsSendersResponse>
SMS 발신번호 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsSendersRequest
  조회 조건
Returns Promise<ListSmsSendersResponse>
발신번호 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listSenders("client-1", {
  sendNo: "15881234",
  useYn: "Y",
  pageNum: 1,
  pageSize: 15
});
```

listStats

listStats(
externalId: string,
query: ListSmsStatsRequest,
): Promise<ListSmsStatsResponse>
SMS 통계를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: ListSmsStatsRequest
  조회 조건
Returns Promise<ListSmsStatsResponse>
통계 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listStats("client-1", {
  statisticsType: "DATE",
  from: "2024-01-01 00:00:00",
  to: "2024-01-31 23:59:59",
  statsIds: ["stat1", "stat2"]
});
```

registerBlockReceivers

registerBlockReceivers(
externalId: string,
request: RegisterSmsBlockReceiversRequest,
): Promise<void>
SMS 수신거부 대상을 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: RegisterSmsBlockReceiversRequest
  수신거부 등록 요청 데이터
Returns Promise<void>
등록 결과
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.registerBlockReceivers("client-1", {
  unsubscribeNo: "08012345678",
  recipientNoList: ["01012345678", "01087654321"],
  registerUser: "admin"
});
```

listBlockReceivers

listBlockReceivers(
externalId: string,
query?: ListSmsBlockReceiversRequest,
): Promise<ListSmsBlockReceiversResponse>
SMS 수신거부 대상 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsBlockReceiversRequest
  조회 조건
Returns Promise<ListSmsBlockReceiversResponse>
수신거부 대상 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listBlockReceivers("client-1", {
  unsubscribeNo: "08012345678",
  startRequestDate: "2024-01-01",
  endRequestDate: "2024-01-31",
  pageNum: 1,
  pageSize: 15
});
```

deleteBlockReceivers

deleteBlockReceivers(
externalId: string,
params: DeleteSmsBlockReceiversRequest,
): Promise<void>
SMS 수신거부 대상을 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- params: DeleteSmsBlockReceiversRequest
  수신거부 삭제 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteBlockReceivers("client-1", {
  unsubscribeNo: "08012345678",
  recipientNoList: ["01012345678", "01087654321"],
  updateUser: "admin"
});
```

listResults

listResults(
externalId: string,
query: ListSmsMessageResultsRequest,
): Promise<ListSmsMessageResultsResponse>
SMS 발송 결과를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: ListSmsMessageResultsRequest
  조회 조건
Returns Promise<ListSmsMessageResultsResponse>
발송 결과 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listResults("client-1", {
  startUpdateDate: "2024-01-01 00:00:00",
  endUpdateDate: "2024-01-31 23:59:59",
  msgStatus: "3",
  pageNum: 1,
  pageSize: 15
});
```

requestDownload

requestDownload(
externalId: string,
request: RequestSmsDownloadRequest,
): Promise<RequestSmsDownloadResponse>
SMS 발송 내역 다운로드를 예약합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: RequestSmsDownloadRequest
  다운로드 예약 요청 데이터
Returns Promise<RequestSmsDownloadResponse>
다운로드 ID
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.requestDownload("client-1", {
  sendType: "0",
  startRequestDate: "2024-01-01 00:00:00",
  endRequestDate: "2024-01-31 23:59:59",
  isIncludeTitleAndBody: true
});
```

listDownloads

listDownloads(
externalId: string,
query?: ListSmsDownloadsRequest,
): Promise<ListSmsDownloadsResponse>
SMS 다운로드 예약 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsDownloadsRequest
  조회 조건
Returns Promise<ListSmsDownloadsResponse>
다운로드 예약 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listDownloads("client-1", {
  downloadId: 12345,
  pageNum: 1,
  pageSize: 15
});
```

createTag

createTag(
externalId: string,
request: CreateSmsTagRequest,
): Promise<CreateSmsTagResponse>
SMS 태그를 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateSmsTagRequest
  태그 생성 요청 데이터
Returns Promise<CreateSmsTagResponse>
생성된 태그 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.createTag("client-1", {
  tagName: "신규고객"
});
```

listTags(
externalId: string,
query?: ListSmsTagsRequest,
): Promise<ListSmsTagsResponse>
SMS 태그 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsTagsRequest
  조회 조건
Returns Promise<ListSmsTagsResponse>
태그 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listTags("client-1", {
  pageNum: 1,
  pageSize: 15
});
```

updateTag

updateTag(
    externalId: string,
    tagId: string,
    request: UpdateSmsTagRequest,
): Promise<void>
SMS 태그를 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- tagId: string
  태그 ID
- request: UpdateSmsTagRequest
  태그 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 태그를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateTag("client-1", "tag123", {
  tagName: "우수고객"
});
```

deleteTag

deleteTag(externalId: string, tagId: string): Promise<void>
SMS 태그를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- tagId: string
  태그 ID
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 태그를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteTag("client-1", "tag123");
```

sendTagMessage

sendTagMessage(
    externalId: string,
    request: SendSmsTagMessageRequest,
    options?: SendOptions,
): Promise<SendSmsMessageResponse>
태그 기반으로 SMS 메시지를 발송합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: SendSmsTagMessageRequest
  태그 메시지 발송 요청 데이터
- Optionaloptions: SendOptions
  발송 옵션 (멱등성 키)
Returns Promise<SendSmsMessageResponse>
발송 결과 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.sendTagMessage("client-1", {
  sendNo: "15881234",
  tagExpression: ["VIP고객", "신규고객"],
  body: "특별 할인 이벤트 안내"
});
```

createUid

createUid(externalId: string, request: CreateSmsUidRequest): Promise<void>
SMS UID를 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateSmsUidRequest
  UID 생성 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.createUid("client-1", {
  uids: [{
    uid: "user123",
    tagIds: ["tag1", "tag2"],
    contacts: [{ contactType: "PHONE_NUMBER", contact: "01012345678" }]
  }]
});
```

listUids

listUids(
externalId: string,
query?: ListSmsUidsRequest,
): Promise<ListSmsUidsResponse>
SMS UID 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsUidsRequest
  조회 조건
Returns Promise<ListSmsUidsResponse>
UID 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listUids("client-1", {
  pageNum: 1,
  pageSize: 15
});
```

getUid

getUid(externalId: string, uid: string): Promise<GetSmsUidResponse>
SMS UID 단건을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
Returns Promise<GetSmsUidResponse>
UID 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getUid("client-1", "user123");
```

deleteUid

deleteUid(externalId: string, uid: string): Promise<void>
SMS UID를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteUid("client-1", "user123");
```

uploadAttachment

uploadAttachment(
externalId: string,
request: UploadSmsAttachmentRequest,
): Promise<UploadSmsAttachmentResponse>
MMS 첨부파일을 업로드합니다.

이미지 파일을 Base64로 인코딩하여 업로드합니다. 업로드된 파일은 파일 ID로 관리되며, MMS 발송 시 사용할 수 있습니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: UploadSmsAttachmentRequest
  첨부파일 업로드 요청 데이터
Returns Promise<UploadSmsAttachmentResponse>
업로드된 파일 정보 (파일 ID 포함)
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
// 파일을 Base64로 인코딩
const fileBuffer = fs.readFileSync('image.jpg');
const base64Data = fileBuffer.toString('base64');

const result = await client.uploadAttachment("client-1", {
  fileName: "image.jpg",
  fileBody: base64Data,
  createUser: "admin"
});

console.log("File ID:", result.body.data.fileId);
// 이 fileId를 MMS 발송 시 attachFileIdList에 사용
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class SmsManagementClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SmsManagementClient

Methods

ProtectedcreateSendHeaders

Parameters

Returns Record<string, string>

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Protectedpost

Type Parameters

Parameters

Returns Promise<T>

ProtectedpostFormData

Type Parameters

Parameters

Returns Promise<T>

Protectedput

Type Parameters

Parameters

Returns Promise<T>

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

ProtecteddeleteWithBody

Type Parameters

Parameters

Returns Promise<T>

listSenders

Parameters

Returns Promise<ListSmsSendersResponse>

Throws

Throws

Throws

Example

listStats

Parameters

Returns Promise<ListSmsStatsResponse>

Throws

Throws

Throws

Example

registerBlockReceivers

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

listBlockReceivers

Parameters

Returns Promise<ListSmsBlockReceiversResponse>

Throws

Throws

Throws

Example

deleteBlockReceivers

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

listResults

Parameters

Returns Promise<ListSmsMessageResultsResponse>

Throws

Throws

Throws

Example

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody