본문으로 건너뛰기

참여자 추방

애플리케이션 서버는 그룹 통화(컨퍼런스)의 참여자를 추방(kick out)할 수 있습니다.

지원 통화 유형최소 SDK 버전대응 SDK 이벤트
(Disconnected 이벤트)
그룹 통화
  • Android: PlanetKit 3.8.9
  • iOS/macOS: PlanetKit 3.8.10
  • Windows: PlanetKit 3.8.9
  • Web: WebPlanetKit 미지원
  • Android: onDisconnected
  • iOS/macOS: didDisconnect
  • Windows: OnDisconnected

앱 서버는 특정한 이유를 대고 참여자를 쫓아낼 수 있습니다. 대상 앱 클라이언트는 Disconnected 이벤트를 받고 방을 떠납니다.

Disconnected 이벤트가 전달하는 통화 종료 이유(disconnect reason)와 사용자 정의 통화 해제 코드(user release code)는 다음과 같습니다.

  • 통화 종료 이유: USER_ERROR
  • 사용자 정의 통화 해제 코드: 앱 서버에서 전달된 구체적인 이유 설명
Tip

최소 SDK 버전보다 예전 버전 기반으로 구현된 앱 클라이언트는 방에서 추방될 때 사용자 정의 통화 해제 코드는 받지 않습니다.

메서드와 엔드포인트​

  • 메서드: DELETE
  • 엔드포인트
/tas/v1/gcall/{serviceId}/{roomId}/member

헤더​

패스 파라미터​

파라미터설명
serviceId서비스 ID
roomId방 ID

쿼리 파라미터​

파라미터데이터 유형형식비고
user_idString사용자 ID를 쉼표(,)로 연결한 문자열. user-id-01,user-id-02,...,user-id-N최대 100개
reasonString애플리케이션이 정의한 추방 이유. 사용자 정의 통화 해제 코드로 앱 클라이언트에 전달됩니다.
reason은 아래 형식이어야 합니다.
  • 영문자(a-z, A-Z)와 숫자(0-9)만 허용
  • 최소 길이 1 바이트
앱 서버가 형식이 맞지 않은 reason 값을 생성하면 400 BAD REQUEST를 반환합니다.

아래는 쿼리 파라미터의 예시입니다.

{API URI}?user_id=user-01,user02,user-03

요청 본문​

없음

응답​

없음

예제​

앱 서버가 'tasDefinedReason'라는 이유로 usr_id1과 usr_id2를 추방하는 예제입니다. 필요한 값은 다음과 같다고 가정합시다.

  • service-id: ex-service
  • room-id: ex-room
curl --location --request \
DELETE 'https://vpnx-stn-api.line-apps.com/tas/v1/gcall/ex-service/ex-room/member?reason=tasDefinedReason&user_id=usr_id1,usr_id2' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ=='

발생할 수 있는 HTTP 상태 코드​

발생 가능한 HTTP 상태 코드는 다음과 같습니다. 자세한 내용은 오류 처리를 참조하세요.

  • 400, 401, 403, 404, 429, 500, 503