Class: RestrictionResource

Defined in: src/resources/restriction.ts:29

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

실측(2026-07-22) 참고:

• 채널 관리자 계정은 활동 제한/임시제한 등록이 400으로 거부된다
• 미제한 유저 해제 시 400 "활동제한되지 않은 유저입니다." / "임시제한된 유저가 아닙니다."

Constructors

Constructor

new RestrictionResource(deps): RestrictionResource;

Defined in: src/resources/restriction.ts:30

Parameters

deps

ResourceDeps

Returns

RestrictionResource

Methods

add()

add(targetChannelId): Promise<void>;

Defined in: src/resources/restriction.ts:68

활동 제한 추가 — POST /open/v1/restrict-channels 〔Scope: 활동제한 쓰기〕

Parameters

targetChannelId

string

Returns

Promise<void>

---

addTemporary()

addTemporary(params): Promise<void>;

Defined in: src/resources/restriction.ts:98

임시제한 추가 — POST /open/v1/temporary-restrict-channels 〔Scope: 활동제한 쓰기〕 (2026.03 추가) chatChannelId는 세션 CHAT 이벤트에서 얻는다.

Parameters

params

TemporaryRestrictionParams

Returns

Promise<void>

---

iterate()

iterate(params?): AsyncGenerator<{
[key: string]: unknown;
  createdDate: string;
  releaseDate?: string | null;
  restrictedChannelId: string;
  restrictedChannelName: string;
}, void>;

Defined in: src/resources/restriction.ts:55

활동 제한 전체 자동 순회 (page.next 커서 소진까지).

Parameters

params?

Pick<RestrictionListParams, "size"> = {}

Returns

AsyncGenerator<{ [key: string]: unknown; createdDate: string; releaseDate?: string | null; restrictedChannelId: string; restrictedChannelName: string; }, void>

---

list()

list(params?): Promise<{
[key: string]: unknown;
  data: object[];
  page?:   | {
   [key: string]: unknown;
     next?: string | null;
   }
     | null;
}>;

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

활동 제한 목록 조회(단일 페이지) — GET /open/v1/restrict-channels 〔Scope: 활동제한 조회〕 파라미터는 쿼리로 전송 (실측 확인 — api-notes #16)

Parameters

params?

RestrictionListParams = {}

Returns

Promise<{ [key: string]: unknown; data: object[]; page?: | { [key: string]: unknown; next?: string | null; } | null; }>

---

remove()

remove(targetChannelId): Promise<void>;

Defined in: src/resources/restriction.ts:81

활동 제한 삭제 — DELETE /open/v1/restrict-channels 〔Scope: 활동제한 쓰기〕

Parameters

targetChannelId

string

Returns

Promise<void>

---

removeTemporary()

removeTemporary(params): Promise<void>;

Defined in: src/resources/restriction.ts:112

임시제한 해제 — DELETE /open/v1/temporary-restrict-channels 〔Scope: 활동제한 쓰기〕

Parameters

params

TemporaryRestrictionParams

Returns

Promise<void>