本文にスキップする

グループ通話のイベントコールバック

グループ通話(カンファレンス)のイベントコールバックは、参加者がグループ通話に参加/退出する際に呼び出されます。アプリケーションは、グループ通話のイベントを利用して、以下の作業を行うことができます。

  • 参加者にグループ通話が開始されたことを通知する
  • 通話状態を確認する(例:グループ通話が終了したかどうか)
  • 統計データを収集する

メソッドとURI

  • メソッド:GET
  • URI:{on_gcall_evt_cb_url}

クエリパラメーター

パラメーターデータ型Null許容説明
sidStringNセッションID。これを利用して、通話を識別できます。Nullなしで36バイトの固定サイズです。6364e8b3bdac436e96310bce2498ce0c
svc_idStringNグループ通話のサービスIDroom-service-id
idStringNグループ通話IDroom-id
user_svc_idStringN参加者のサービスIDuser-service-id
user_idStringN参加者のユーザーIDuser-id
host_svc_idStringNホストのサービスIDhost-service-id
host_idStringNホストのユーザーIDhost-user-id
scStringNグループ通話のステータスコード
- S:開始
- C:変更
- E:終了
S
setup_timeLongNグループ通話を作成した時刻(秒)0
start_timeLongNグループ通話を開始した時刻(秒)0
end_timeLongNグループ通話を終了した時刻(秒)0
onlineIntegerNオンラインの参加者(つながっている参加者)数0
media_typeStringNメディアタイプ。
- A:音声グループ通話
- V:ビデオグループ通話
A
mscStringN参加者のステータスコード
- C:接続
- D:接続解除
- T:タイムアウト
- M:メディア変更
C
stidStringYDeprecated.
PlanetKitのjoinConference()を呼び出したときに渡されたアプリケーションデータ
アプリケーションが作成
tsNumericNタイムスタンプ2277272
rel_codeIntegerY詳細な通話解除コード。プラットフォーム内で通話解除の原因を調べるのに使用します。通話解除の理由を参照してください。1
rel_code_strStringY詳細な通話解除メッセージ。プラットフォーム内で通話解除の原因を調べるのに使用します。通話解除の理由を参照してください。NORMAL
ue_typeStringNユーザーデバイスのタイプ
- UE_TYPE_UNDEFINED
- ANDROID
- IOS
- DESKTOPMAC
- DESKTOPWIN
- BROWSER
- SIP_TERMINAL
IOS
display_nameStringYユーザーデバイスの表示名iosApp
client_addressStringYクライアントのIPアドレス1.1.1.1
mtg_dataStringYミーティングの作成時に指定したミーティングデータJP
rc_idcStringYグループ通話サーバーのIDC(インターネットデータセンター)。ISO 3166-1 alpha-2 codeフォーマットを使用します。すべてアルファベット大文字です。JP
disconnect_reasonIntegerY通話切断の理由。詳しくは、通話切断の理由を参照してください。1001
releaser_typeIntegerY切断元のタイプ。詳しくは、切断元を参照してください。1
app_svr_dataStringYPlanetKitのjoinConference()を呼び出したときに渡されるアプリケーションデータ
詳しくは、クライアントプラットフォームごとのアプリサーバーデータガイドを参照してください。
- Android
- iOS/macOS
- Windows
- Web
:このパラメーターはstidと同じデータを提供します。
アプリケーションが作成

サンプル

# Let's suppose on_gcall_evt_cb_url is
# http://sample.server.com:20200/gcall_event
# LINE Planet server will send a request to on_gcall_evt_cb_url as follows.

GET http://sample.server.com:20200/gcall_event?
sid=59db2167e13911ea83a8213945545d1c&
svc_id=room-service-id&
id=1111&
user_svc_id=user-service-id&
user_id=9286&
host_svc_id=host-service-id&
host_id=2809&
sc=C&
setup_time=1597744702514&
start_time=1597744703058&
end_time=0&
online=2&
mediaType=V&
msc=C&
stid=application-data&
ts=1599463610820&
ue_type=IOS&
display_name=iosApp&
client_address=1.1.1.1&
mtg_data=JP&
rc_idc=JP&
app_svr_data=appSvrData