Class SmsTemplateClient

SMS 템플릿 클라이언트

SMS 템플릿 및 카테고리 관리 기능을 제공합니다. 템플릿을 사용하면 자주 사용하는 메시지 형식을 저장하고 재사용할 수 있으며, 카테고리를 통해 템플릿을 체계적으로 분류하고 관리할 수 있습니다.

Example

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

// 카테고리 생성
const category = await client.createCategory("client-1", {
  categoryName: "주문 관련",
  useYn: "Y"
});

// 템플릿 생성
const template = await client.createTemplate("client-1", {
  categoryId: category.body.data.categoryId,
  templateName: "주문 확인",
  templateBody: "#{name}님의 주문이 완료되었습니다. 주문번호: #{orderNo}"
});

Index

Constructors

constructor

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

createTemplate

createTemplate(
externalId: string,
request: CreateSmsTemplateRequest,
): Promise<CreateSmsTemplateResponse>
SMS 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateSmsTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateSmsTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.createTemplate("client-1", {
  categoryId: 1,
  templateName: "배송 알림",
  templateBody: "#{name}님, 상품이 발송되었습니다.",
  useYn: "Y"
});
```

listTemplates

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

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

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

getTemplate

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

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

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

updateTemplate

updateTemplate(
    externalId: string,
    templateId: string,
    request: UpdateSmsTemplateRequest,
): Promise<void>
SMS 템플릿을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- templateId: string
  템플릿 ID
- request: UpdateSmsTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateTemplate("client-1", "template123", {
  templateName: "배송 완료 알림",
  templateBody: "#{name}님, 배송이 완료되었습니다.",
  useYn: "Y"
});
```

deleteTemplate

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

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

Throws
NotFoundException 해당 템플릿을 찾을 수 없는 경우

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

createCategory

createCategory(
externalId: string,
request: CreateSmsCategoryRequest,
): Promise<CreateSmsCategoryResponse>
SMS 카테고리를 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateSmsCategoryRequest
  카테고리 생성 요청 데이터
Returns Promise<CreateSmsCategoryResponse>
생성된 카테고리 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.createCategory("client-1", {
  categoryName: "배송 알림",
  categoryDesc: "배송 관련 메시지 카테고리",
  useYn: "Y"
});
```

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

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

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

getCategory

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

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

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

updateCategory

updateCategory(
    externalId: string,
    categoryId: number,
    request: UpdateSmsCategoryRequest,
): Promise<void>
SMS 카테고리를 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- categoryId: number
  카테고리 ID
- request: UpdateSmsCategoryRequest
  카테고리 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateCategory("client-1", 123, {
  categoryName: "배송 완료",
  useYn: "Y"
});
```

deleteCategory

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

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

Throws
NotFoundException 해당 카테고리를 찾을 수 없는 경우

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

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class SmsTemplateClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SmsTemplateClient

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>

createTemplate

Parameters

Returns Promise<CreateSmsTemplateResponse>

Throws

Throws

Throws

Example

listTemplates

Parameters

Returns Promise<ListSmsTemplatesResponse>

Throws

Throws

Throws

Example

getTemplate

Parameters

Returns Promise<GetSmsTemplateResponse>

Throws

Throws

Throws

Throws

Example

updateTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

deleteTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

createCategory

Parameters

Returns Promise<CreateSmsCategoryResponse>

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials