本文にスキップする

参加者の強制退出

アプリケーションサーバーは、グループ通話（カンファレンス）の参加者を強制退出（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