Class SmsReservationClient

SMS 예약 클라이언트

SMS 예약 발송 관리 기능을 제공합니다. 예약 발송 목록 조회, 상세 조회, 취소 기능을 포함합니다.

Example

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

// 예약 발송 목록 조회
const list = await client.listReservations("client-1", {
  messageStatus: "RESERVED",
  pageNum: 1,
  pageSize: 20
});

// 예약 발송 상세 조회
const detail = await client.getReservation("client-1", "REQ123", 1);

// 예약 발송 취소
await client.cancelReservations("client-1", {
  reservationList: [
    { requestId: "20240101000000ABC123", recipientSeq: 1 }
  ],
  updateUser: "admin"
});

Index

Constructors

constructor

new SmsReservationClient(
credentials: AwesomeMessageCredentials,
): SmsReservationClient
SMS 예약 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns SmsReservationClient
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

listReservations

listReservations(
externalId: string,
query?: ListSmsReservationsRequest,
): Promise<ListSmsReservationsResponse>
SMS 예약 발송 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsReservationsRequest
  조회 조건
Returns Promise<ListSmsReservationsResponse>
예약 발송 목록
Example
```
const result = await client.listReservations("client-1", {
  messageStatus: "RESERVED",
  startRequestDate: "2024-01-01 00:00:00",
  endRequestDate: "2024-01-31 23:59:59",
  pageNum: 1,
  pageSize: 20
});
```

getReservation

getReservation(
    externalId: string,
    requestId: string,
    recipientSeq: number,
): Promise<GetSmsReservationResponse>
SMS 예약 발송 상세 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- requestId: string
  요청 ID
- recipientSeq: number
  수신자 시퀀스
Returns Promise<GetSmsReservationResponse>
예약 발송 상세 정보
Example
```
const detail = await client.getReservation("client-1", "REQ123456", 1);
```

cancelReservations

cancelReservations(
externalId: string,
request: CancelSmsReservationsRequest,
): Promise<CancelSmsReservationsResponse>
SMS 예약 발송을 취소합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CancelSmsReservationsRequest
  예약 취소 요청 데이터
Returns Promise<CancelSmsReservationsResponse>
취소 결과
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.cancelReservations("client-1", {
  reservationList: [
    { requestId: "20240101000000ABC123", recipientSeq: 1 },
    { requestId: "20240101000000ABC123", recipientSeq: 2 }
  ],
  updateUser: "admin"
});
```

cancelReservationsByFilter

cancelReservationsByFilter(
externalId: string,
request: CancelSmsReservationsByFilterRequest,
): Promise<CancelSmsReservationsResponse>
SMS 예약 발송을 다중 필터로 취소합니다.

⚠️ startRequestDate+endRequestDate 또는 startCreateDate+endCreateDate 중 하나 필수
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CancelSmsReservationsByFilterRequest
  다중 필터 취소 요청 데이터
Returns Promise<CancelSmsReservationsResponse>
취소 결과
Example
```
const result = await client.cancelReservationsByFilter("client-1", {
  searchParameter: {
    sendType: "0",
    startRequestDate: "2024-01-01 00:00:00",
    endRequestDate: "2024-01-01 23:59:59",
    sendNo: "15880000"
  },
  updateUser: "admin"
});
```

listReservationCancels

listReservationCancels(
externalId: string,
query?: ListSmsReservationCancelsRequest,
): Promise<ListSmsReservationCancelsResponse>
SMS 예약 발송 취소 요청 목록을 조회합니다. (다중 필터)
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListSmsReservationCancelsRequest
  조회 조건
Returns Promise<ListSmsReservationCancelsResponse>
취소 요청 목록
Example
```
const result = await client.listReservationCancels("client-1", {
  startRequestedDateTime: "2024-01-01 00:00:00",
  endRequestedDateTime: "2024-01-31 23:59:59",
  pageNum: 1,
  pageSize: 20
});
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class SmsReservationClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SmsReservationClient

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>

listReservations

Parameters

Returns Promise<ListSmsReservationsResponse>

Example

getReservation

Parameters

Returns Promise<GetSmsReservationResponse>

Example

cancelReservations

Parameters

Returns Promise<CancelSmsReservationsResponse>

Throws

Throws

Throws

Example

cancelReservationsByFilter

Parameters

Returns Promise<CancelSmsReservationsResponse>

Example

listReservationCancels

Parameters

Returns Promise<ListSmsReservationCancelsResponse>

Example

Properties

Protectedcredentials

Settings

On This Page

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials