通話開始メッセージ

1対1通話で発信者と受信者は、通話設定のプロセス中に限られたサイズのメッセージを互いに送信できます。このメッセージを通話開始メッセージ（call start message）といいます。

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

Note

通話開始メッセージは、PlanetKit 5.0.x以下のバージョンで提供する「Call Initデータ」と機能的に同じものです。PlanetKit 5.1以上のバージョンから機能の名称だけが変更されました。

通話開始メッセージを送信する

発信者と受信者は、通話設定中に互いに異なるタイミングで通話開始メッセージを送信できます。

Tip

通話設定の流れについてより詳しい内容は、1対1通話フローを参照してください。

発信者側

発信者は通話を作成（make）する際に通話開始メッセージを送信できます。

発信者側から通話開始メッセージを送信するには、PlanetKitCallStartMessageを作成し、PlanetKitCallStartMessageをPlanetKitMakeCallParamに設定し、makeCall()を呼び出す際にPlanetKitMakeCallParamを渡します。

val callStartMessage = PlanetKitCallStartMessage.create("Call start message from a caller")
val param = PlanetKitMakeCallParam.Builder()
    .myId(myUserId)
    .myServiceId(myServiceId)
    .peerId(peerUserId)
    .peerServiceId(peerServiceId)
    .callStartMessage(callStartMessage)
    .build()

val result = PlanetKit.makeCall(param, makeCallListener)

通話開始メッセージは、onVerifiedコールバックを通じて受信者に転送されます。

受信者側

受信者は通話に応答（accept）する際に、通話開始メッセージを送信できます。

受信者側で通話開始メッセージを送信するには、PlanetKitCallStartMessageを作成し、acceptCall()を呼び出す際にPlanetKitCallStartMessageを渡します。

val callStartMessage = PlanetKitCallStartMessage.create("Call start message from a callee")

call = PlanetKit.getCall(instanceId)
call?.acceptCall(acceptCallListener, callStartMessage)

通話開始メッセージは、onConnectedコールバックを通じて発信者に転送されます。

サイズの制限

通話開始メッセージの最大サイズはnull終端文字を含めて200バイトです。

通話開始メッセージとアプリサーバーデータの比較

通話開始メッセージとアプリサーバーデータとでは、次のような違いがあります。

	送信元と送信先	対応する通話タイプ
通話開始メッセージ	発信者のアプリクライアント → 受信者のアプリクライアント 受信者のアプリクライアント → 発信者のアプリクライアント	1対1通話
アプリサーバーデータ	発信者または参加者のアプリクライアント → アプリサーバー	1対1通話、グループ通話（カンファレンス）

関連API

通話開始メッセージ機能に関連するAPIは次のとおりです。

クラス

• PlanetKitCallStartMessage

メソッド／プロパティ

• callStartMessage()
• makeCall()
• acceptCall()

イベント

• onVerified
• onConnected