本文にスキップする
Version: 5.4

アプリサーバーデータ

アプリケーションは、1対1通話を作成したり、グループ通話（カンファレンス）に参加したりする際にアプリクライアントとアプリサーバーとの間でアプリケーションデータを共有できます。このため、アプリクライアントからアプリサーバーに送信するアプリケーションデータをアプリサーバーデータ（app server data）といいます。

対応する通話タイプSDKの最低バージョン
1対1通話、グループ通話すべてのバージョン
Note
  • アプリサーバーデータは、PlanetKit 5.0.x以下のバージョンで提供する「サービスチケットID」と機能的に同じものです。PlanetKit 5.1以上のバージョンから機能の名称だけが変更されました。
  • 以前にサーバーコールバックでサービスチケットIDを転送するために使用されていたstidパラメーターはdeprecatedされました。代わりに、アプリサーバーデータはサーバーコールバックのapp_svr_dataパラメーターとして転送されます。

アプリサーバーデータを送信する​

通話のタイプによってアプリサーバーデータを送信する方法について説明します。

1対1通話​

1対1通話では、発信者だけがアプリサーバーデータを送信できます。

1対1通話でアプリサーバーデータを送信するには、MakeCallParamsにアプリサーバーデータを設定し、makeCall()を呼び出す際にMakeCallParamsを渡します。

const callMakeParams = {
    myId: 'MY_ID',
    myServiceId: 'MY_SERVICE_ID',
    peerId: 'PEER_ID',
    peerServiceId: 'PEER_SERVICE_ID',
    accessToken: 'ACCESS_TOKEN',
    appServerData: "App server data for a 1-to-1 call",
    ...
};

planetKit.makeCall(callMakeParams);

アプリサーバーデータは、サーバーコールバックの Notifyコールバックおよび1対1通話のイベントコールバックのapp_svr_dataパラメーターで渡されます。

グループ通話​

グループ通話では、参加者全員がアプリサーバーデータを送信できます。

グループ通話でアプリサーバーデータを送信するには、ConferenceParamsにアプリサーバーデータを設定し、joinConference()を呼び出す際にConferenceParamsを渡します。

const conferenceParams = {
    myId: 'MY_ID',
    myServiceId: 'MY_SERVICE_ID',
    roomId: 'ROOM_ID',
    roomServiceId: 'ROOM_SERVICE_ID',
    accessToken: 'ACCESS_TOKEN',
    appServerData: "App server data for a group call",
    ...
};

planetKit.joinConference(conferenceParams);

アプリサーバーデータは、グループ通話イベントのサーバーコールバックのapp_svr_dataパラメーターで渡されます。

サイズの制限​

アプリサーバーデータの最大サイズはnull終端文字を含めて4096バイトです。

関連API​

アプリサーバーデータ機能に関連するAPIは、以下のとおりです。

1対1通話​

クライアント向けAPI​

サーバーAPI​

グループ通話​

クライアント向けAPI​

サーバーAPI​