Skip to content

Class: ChatResource ​

Defined in: src/resources/chat.ts:35

Chat 리소스. 모두 유저 토큰 필요. https://chzzk.gitbook.io/chzzk/chzzk-api/chat

참고: 채팅 채널은 라이브 상태와 무관하게 존재한다 — 실측(2026-07-22)으로 라이브가 꺼진 상태에서도 전송이 성공함을 확인.

Constructors ​

Constructor ​

ts
new ChatResource(deps): ChatResource;

Defined in: src/resources/chat.ts:36

Parameters ​

deps ​

ResourceDeps

Returns ​

ChatResource

Methods ​

blindMessage() ​

ts
blindMessage(params): Promise<void>;

Defined in: src/resources/chat.ts:134

채팅 메시지 숨기기 — POST /open/v1/chats/blind-message 〔Scope: 채팅 메시지 쓰기〕 (2026.03 추가) 이미 발생한 메시지의 사후 숨김만 가능하다. 파라미터는 세션 CHAT 이벤트의 chatChannelId/messageTime/senderChannelId를 사용한다.

Parameters ​

params ​

BlindMessageParams

Returns ​

Promise<void>


getSettings() ​

ts
getSettings(): Promise<{
[key: string]: unknown;
  allowSubscriberInFollowerMode: boolean;
  chatAvailableCondition: ChatAvailableCondition;
  chatAvailableGroup: ChatAvailableGroup;
  chatEmojiMode: boolean;
  chatSlowModeSec: number;
  minFollowerMinute: number;
}>;

Defined in: src/resources/chat.ts:84

채팅 설정 조회 — GET /open/v1/chats/settings 〔Scope: 채팅 설정 조회〕

Returns ​

Promise<{ [key: string]: unknown; allowSubscriberInFollowerMode: boolean; chatAvailableCondition: ChatAvailableCondition; chatAvailableGroup: ChatAvailableGroup; chatEmojiMode: boolean; chatSlowModeSec: number; minFollowerMinute: number; }>


notice() ​

ts
notice(params): Promise<void>;

Defined in: src/resources/chat.ts:64

채팅 공지 등록 — POST /open/v1/chats/notice 〔Scope: 채팅 공지 쓰기〕 message(신규) 또는 messageId(기존 메시지) 중 정확히 하나를 전달한다.

Parameters ​

params ​

ChatNoticeParams

Returns ​

Promise<void>


send() ​

ts
send(message): Promise<string>;

Defined in: src/resources/chat.ts:43

채팅 메시지 전송 — POST /open/v1/chats/send 〔Scope: 채팅 메시지 쓰기〕

Parameters ​

message ​

string

최대 100자

Returns ​

Promise<string>

전송된 메시지 ID (공지 등록에 사용 가능)


updateSettings() ​

ts
updateSettings(update): Promise<void>;

Defined in: src/resources/chat.ts:99

채팅 설정 변경 — PUT /open/v1/chats/settings 〔Scope: 채팅 설정 변경〕 minFollowerMinute·chatSlowModeSec는 문서가 허용하는 값만 통과시킨다.

Parameters ​

update ​

ChatSettingsUpdate

Returns ​

Promise<void>

공식 OPEN API만 지원 — 비공식 엔드포인트 0건