Developers
로그인

차단/추방 API

사용자 추방

인증된 사용자의 채널에서 특정 사용자를 추방합니다.

POST /api/openapi/open/v1/restrict-channels

  • 인증: Access Token (Bearer)
  • 필요 Scope: WRITE:USER_BLOCK

요청 본문

파라미터 타입 필수 설명
targetChannelId string O 추방할 사용자의 채널 ID

OpenAPI를 통한 추방은 항상 영구(Permanent) 추방으로 고정됩니다.

검증 에러

HTTP 상태 코드 발생 상황
404 Not Found 대상 채널이 존재하지 않음
400 Bad Request 자기 자신의 채널을 추방하려는 경우
400 Bad Request 대상이 채널 관리자(소유자/채널 매니저/채팅 매니저)인 경우
400 Bad Request 이미 추방된 사용자인 경우

응답

성공 시 content 없이 code만 반환됩니다.

{
  "code": 200
}

추방 사용자 목록 조회

인증된 사용자의 채널에서 추방된 사용자 목록을 조회합니다. 커서 기반 페이지네이션을 사용합니다.

GET /api/openapi/open/v1/restrict-channels

  • 인증: Access Token (Bearer)
  • 필요 Scope: READ:USER_BLOCK

Query 파라미터

파라미터 타입 기본값 설명
size number 20 페이지 크기 (1~50)
next string - 다음 페이지 커서 값

응답 (content.data 배열 항목)

필드 타입 설명
restrictedChannelId string 추방된 사용자의 채널 ID
restrictedChannelName string 추방된 사용자의 채널 이름
restrictedChannelHandle string 추방된 사용자의 채널 핸들 (슬러그)
createdDate string 추방 일시 (ISO 8601)
releaseDate string | null 추방 만료 일시 (ISO 8601). OpenAPI 추방은 항상 영구 추방이므로 항상 null

페이지네이션 (content.page)

필드 타입 설명
next string | null 다음 페이지를 조회하기 위한 커서 값. 더 이상 결과가 없으면 null

커서는 마지막 항목의 추방 일시(createdAt) 기준이며, 반환된 next 값을 다음 요청의 next 쿼리 파라미터로 전달하면 그 이전(더 오래된) 추방 항목들을 이어서 조회할 수 있습니다.

추방 해제

인증된 사용자의 채널에서 특정 사용자의 추방을 해제합니다.

DELETE /api/openapi/open/v1/restrict-channels

  • 인증: Access Token (Bearer)
  • 필요 Scope: WRITE:USER_BLOCK

요청 본문

파라미터 타입 필수 설명
targetChannelId string O 추방 해제할 사용자의 채널 ID

추방 해제 시, 대상 채널의 명의(CI)가 동일한 모든 계정의 추방이 일괄 해제됩니다. 한 사람이 여러 계정으로 추방되어 있어도 한 번의 요청으로 모두 해제됩니다. 이미 해제된 경우에도 정상 처리됩니다. 대상 채널이 존재하지 않으면 404 에러가 반환됩니다.

응답

{
  "code": 200,
  "data": null
}