グループ通話のイベントコールバック
グループ通話(カンファレンス)のイベントコールバックは、参加者がグループ通話に参加/退出する際に呼び出されます。アプリケーションは、グループ通話のイベントを利用して、以下の作業を行うことができます。
- 参加者にグループ通話が開始されたことを通知する
- 通話状態を確認する(例:グループ通話が終了したかどうか)
- 統計データを収集する
メソッドとURI
- メソッド:GET
- URI:
{on_gcall_evt_cb_url}
クエリパラメーター
パラメーター | データ型 | Null許容 | 説明 | 例 |
---|---|---|---|---|
sid | String | N | セッションID。これを利用して、通話を識別できます。Nullなしで36バイトの固定サイズです。 | 6364e8b3bdac436e96310bce2498ce0c |
svc_id | String | N | グループ通話のサービスID | room-service-id |
id | String | N | グループ通話ID | room-id |
user_svc_id | String | N | 参加者のサービスID | user-service-id |
user_id | String | N | 参加者のユーザーID | user-id |
host_svc_id | String | N | ホストのサービスID | host-service-id |
host_id | String | N | ホストのユーザーID | host-user-id |
sc | String | N | グループ通話のステータスコード - S :開始- C :変更- E :終了 | S |
setup_time | Long | N | グループ通話を作成した時刻(秒) | 0 |
start_time | Long | N | グループ通話を開始した時刻(秒) | 0 |
end_time | Long | N | グループ通話を終了した時刻(秒) | 0 |
online | Integer | N | オンラインの参加者(つながっている参加者)数 | 0 |
media_type | String | N | メディアタイプ。 - A :音声グループ通話 - V :ビデオグループ通話 | A |
msc | String | N | 参加者のステータスコード - C :接続 - D :接続解除 - T :タイムアウト - M :メディア変更 | C |
stid | String | Y | Deprecated. PlanetKitの joinConference() を呼び出したときに渡されたアプリケーションデータ | アプリケーションが作成 |
ts | Numeric | N | タイムスタンプ | 2277272 |
rel_code | Integer | Y | 詳細な通話解除コード。プラットフォーム内で通話解除の原因を調べるのに使用します。通話解除の理由を参照してください。 | 1 |
rel_code_str | String | Y | 詳細な通話解除メッセージ。プラットフォーム内で通話解除の原因を調べるのに使用します。通話解除の理由を参照してください。 | NORMAL |
ue_type | String | N | ユーザーデバイスのタイプ - UE_TYPE_UNDEFINED - ANDROID - IOS - DESKTOPMAC - DESKTOPWIN - BROWSER - SIP_TERMINAL | IOS |
display_name | String | Y | ユーザーデバイスの表示名 | iosApp |
client_address | String | Y | クライアントのIPアドレス | 1.1.1.1 |
mtg_data | String | Y | ミーティングの作成時に指定したミーティングデータ | JP |
rc_idc | String | Y | グループ通話サーバーのIDC(インターネットデータセンター)。ISO 3166-1 alpha-2 codeフォーマットを使用します。すべてアルファベット大文字です。 | JP |
disconnect_reason | Integer | Y | 通話切断の理由。詳しくは、通話切断の理由を参照してください。 | 1001 |
releaser_type | Integer | Y | 切断元のタイプ。詳しくは、切断元を参照してください。 | 1 |
app_svr_data | String | Y | PlanetKitの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