アプリサーバーデータ

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

対応する通話タイプ	SDKの最低バージョン
1対1通話、グループ通話	すべてのバージョン

Note

• アプリサーバーデータは、WebPlanetKit 5.1.0以下のバージョンで提供する「サービスチケットID」と機能的に同じものです。WebPlanetKit 5.2.0以上のバージョンから機能の名称だけが変更されました。
• 以前にサーバーコールバックでサービスチケットIDを転送するために使用されていたstidパラメーターはdeprecatedされました。代わりに、アプリサーバーデータはサーバーコールバックのapp_svr_dataパラメーターとして転送されます。

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

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

1対1通話

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

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

const makeCallParams = {
    ...,
    appServerData: "App server data for a 1-to-1 call"
};

planetKit.makeCall(makeCallParams)
    .then(() => {
        // Successfully made a call
    })
    .catch((makeCallError) => {
        // Failed to make a call
        // makeCallError.reason: START_FAIL_REASON
        // makeCallError.message: A descriptive message about the failure.
    });

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

グループ通話

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

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

const conferenceParams = {
    ...,
    appServerData: "App server data for a group call"
};

planetKit.joinConference(conferenceParams)
    .then(() => {
        // Successfully joined a conference
    })
    .catch((joinConferenceError) => {
        // Failed to join a conference
        // joinConferenceError.reason: START_FAIL_REASON
        // joinConferenceError.message: A descriptive message about the failure.
    });

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

サイズの制限

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

関連API

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

1対1通話

クライアント向けAPI

• MakeCallParamsのappServerData
• makeCall()

サーバーAPI

• Notifyコールバック
• 1対1通話のイベントコールバック

グループ通話

クライアント向けAPI

• ConferenceParamsのappServerData
• joinConference()

サーバーAPI

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