Class KakaoFriendtalkResultClient

카카오 친구톡 결과 조회 클라이언트

카카오 친구톡 메시지 발송 결과 조회 기능을 제공합니다. 메시지 목록 조회 및 단건 조회를 지원합니다.

Example

const kakaoResultClient = new KakaoFriendtalkResultClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});

// 친구톡 메시지 목록 조회
const listResult = await kakaoResultClient.listFriendtalkMessages("my-client-1", {
  startRequestDate: new Date("2023-01-01T00:00:00+09:00"),
  endRequestDate: new Date("2023-01-31T23:59:00+09:00")
});

// 친구톡 메시지 단건 조회
const messageDetail = await kakaoResultClient.getFriendtalkMessage("my-client-1", "MSG123456", 1);

Index

Constructors

constructor

new KakaoFriendtalkResultClient(
credentials: AwesomeMessageCredentials,
): KakaoFriendtalkResultClient
카카오 친구톡 결과 조회 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoFriendtalkResultClient
Example
```
const client = new KakaoFriendtalkResultClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});
```
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

listFriendtalkMessages

listFriendtalkMessages(
externalId: string,
query: ListFriendtalkMessagesRequest,
): Promise<ListFriendtalkMessagesResponse>
친구톡 메시지 목록을 조회합니다.

다양한 조건으로 친구톡 메시지 발송 결과를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: ListFriendtalkMessagesRequest
  조회 조건
Returns Promise<ListFriendtalkMessagesResponse>
메시지 목록 및 총 개수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await kakaoResultClient.listFriendtalkMessages("my-client-1", {
  startRequestDate: new Date("2023-01-01T00:00:00+09:00"),
  endRequestDate: new Date("2023-01-31T23:59:00+09:00"),
  pageNum: 1,
  pageSize: 20
});
// result: { messages: [{ requestId: "MSG123", recipientSeq: 1, senderKey: "SENDER_KEY", templateCode: "TEMPLATE_001", messageStatus: "COMPLETED", resultCode: "MRC01" }], totalCount: 42 }
```

getFriendtalkMessage

getFriendtalkMessage(
    externalId: string,
    requestId: string,
    recipientSeq: number,
): Promise<GetFriendtalkMessageResponse>
친구톡 메시지 단건을 조회합니다.

특정 요청 ID와 수신자 시퀀스 번호로 발송된 단일 메시지의 상세 내용을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- requestId: string
  조회할 메시지의 요청 ID
- recipientSeq: number
  조회할 메시지의 수신자 시퀀스 번호
Returns Promise<GetFriendtalkMessageResponse>
메시지 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우

Throws
NotFoundException 해당 메시지를 찾을 수 없는 경우
Example
```
const result = await kakaoResultClient.getFriendtalkMessage("my-client-1", "MSG123456", 1);
// result: { message: { requestId: "MSG123456", recipientSeq: 1, senderKey: "SENDER_KEY", messageStatus: "COMPLETED", content: "메시지 내용", adult: false } }
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoFriendtalkResultClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoFriendtalkResultClient

Example

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>

listFriendtalkMessages

Parameters

Returns Promise<ListFriendtalkMessagesResponse>

Throws

Throws

Throws

Example

getFriendtalkMessage

Parameters

Returns Promise<GetFriendtalkMessageResponse>

Throws

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