Class PushClient

푸시 클라이언트

푸시 메시지 발송 및 조회 기능을 제공합니다. 즉시 발송, 발송 결과 조회, 에러 조회, 로그 조회 등의 기능을 포함합니다.

Example

const client = new PushClient({ accessKeyId, secretAccessKey });
const result = await client.sendMessage("client-1", {
  target: { type: "UID", to: ["user1", "user2"] },
  content: { default: { title: "알림", body: "새 메시지가 도착했습니다." } },
  messageType: "NOTIFICATION"
});
// { message: { messageId: 12345, messageIdString: "12345" } }

Index

Constructors

constructor

new PushClient(credentials: AwesomeMessageCredentials): PushClient
푸시 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns PushClient
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

sendMessage

sendMessage(
    externalId: string,
    request: SendPushMessageRequest,
    options?: SendOptions,
): Promise<SendPushMessageResponse>
푸시 메시지를 발송합니다.

UID, TAG, 또는 전체 대상에게 푸시 메시지를 즉시 발송합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: SendPushMessageRequest
  메시지 발송 요청 데이터
- Optionaloptions: SendOptions
  발송 옵션 (멱등성 키)
Returns Promise<SendPushMessageResponse>
발송 결과 정보 (메시지 ID)
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.sendMessage("client-1", {
  target: { type: "UID", to: ["user1"], pushTypes: ["FCM", "APNS"] },
  content: { default: { title: "알림", body: "새 메시지" } },
  messageType: "NOTIFICATION",
  timeToLiveMinute: 60
});
// { message: { messageId: 12345, messageIdString: "12345" } }
```

listMessages

listMessages(
externalId: string,
query?: ListPushMessagesRequest,
): Promise<ListPushMessagesResponse>
메시지 목록을 조회합니다.

발송된 푸시 메시지 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListPushMessagesRequest
  조회 조건
Returns Promise<ListPushMessagesResponse>
메시지 목록 및 총 개수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listMessages("client-1", {
  from: "2024-01-01T00:00:00+09:00",
  to: "2024-01-31T23:59:59+09:00",
  deliveryType: "INSTANT",
  pageIndex: 0,
  pageSize: 25
});
// { messages: [{ messageId, messageStatus, ... }], totalCount: 100 }
```

getMessage

getMessage(
externalId: string,
messageId: number,
): Promise<GetPushMessageResponse>
메시지 단건을 조회합니다.

특정 메시지 ID의 상세 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- messageId: number
  메시지 ID
Returns Promise<GetPushMessageResponse>
메시지 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
NotFoundException 해당 메시지를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getMessage("client-1", 12345);
// { message: { messageId: 12345, messageStatus: "COMPLETE", ... } }
```

listMessageErrors

listMessageErrors(
externalId: string,
query?: ListPushMessageErrorsRequest,
): Promise<ListPushMessageErrorsResponse>
발송 실패 메시지를 조회합니다.

발송 실패한 메시지의 에러 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListPushMessageErrorsRequest
  조회 조건
Returns Promise<ListPushMessageErrorsResponse>
에러 메시지 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listMessageErrors("client-1", {
  messageId: 12345,
  messageErrorType: "CLIENT_ERROR",
  limit: 100
});
// { messageErrors: [{ token, messageErrorType, ... }], totalCount: 10 }
```

listMessageLogs

listMessageLogs(
externalId: string,
query?: ListPushMessageLogsRequest,
): Promise<ListPushMessageLogsResponse>
메시지 발송 로그를 조회합니다.

메시지 발송 상세 로그를 조회합니다. (Logging 기능 활성화 필요)
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListPushMessageLogsRequest
  조회 조건
Returns Promise<ListPushMessageLogsResponse>
로그 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listMessageLogs("client-1", {
  messageId: 12345,
  uid: "user1",
  pushType: "FCM",
  limit: 100
});
// { data: { logs: [{ uid, token, pushType, sentDateTime }] } }
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class PushClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns PushClient

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>

sendMessage

Parameters

Returns Promise<SendPushMessageResponse>

Throws

Throws

Throws

Example

listMessages

Parameters

Returns Promise<ListPushMessagesResponse>

Throws

Throws

Throws

Example

getMessage

Parameters

Returns Promise<GetPushMessageResponse>

Throws

Throws

Throws

Throws

Example

listMessageErrors

Parameters

Returns Promise<ListPushMessageErrorsResponse>

Throws

Throws

Throws

Example

listMessageLogs

Parameters

Returns Promise<ListPushMessageLogsResponse>

Throws

Throws

Throws

Example

Properties

Protectedcredentials

Settings

On This Page

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials