본문으로 건너뛰기

사용자 금지/해제

사용자 금지

특정 사용자를 해당 그룹 채널에 참가하지 못 하도록 금지 할 수 있습니다.

POST /v1/group/channels/(channel_id)/ban

Parameters

속성설명유형필수여부
channel_id채널 아이디StringO

Request

속성설명유형기본값필수여부
user_id금지할 사용자 IDString없음O
manager_id해당 금지를 수행한 매니저 IDString없음X
seconds금지 기간, 단위 초Number0X
reason금지 이유 (4~200자)String없음X
{
"user_id": "User ID",
"manager_id": "Manager ID",
"seconds": 3600,
"reason": "Reason"
}

Response

201 success
{
"user": {
"user_id": "User ID",
"name": "User Name",
"created_at": 1669358202276,
"updated_at": 1669358203107
},
"start_at": 1670916132911, // 금지 시작 일시
"end_at": 1670916132911, // 금지 종료 일시
"reason": "Reason"
}

금지 해제

사용자 금지를 해제 할 수 있습니다.

DELETE /v1/group/channels/(channel_id)/ban/(user_id)

Parameters

속성설명유형필수여부
channel_id채널 아이디StringO
user_id해제할 사용자 IDStringO

Response

200 success

금지 목록 조회

해당 채널의 사용자 금지 목록을 조회 할 수 있습니다.

조회 정렬 기준은 금지 시작일 내림차순입니다.

GET /v1/group/channels/(channel_id)/banned_list

Parameters

속성설명유형필수여부
channel_id채널 아이디StringO

Response

200 success
[
{
"user": {
"user_id": "User ID",
"name": "User Name",
"created_at": 1669358202276,
"updated_at": 1669358203107
},
"start_at": 1670916132911, // 금지 시작 일시
"end_at": 1670916132911, // 금지 종료 일시
"reason": "Reason"
}
...
]