Notifyコールバック
Notifyコールバックは、発信者が電話をかけようとしたときに常に呼び出されます。このコールバックを受けたアプリケーションは、受信者に着信があることを知らせる必要があります。
そのとき、アプリサーバーは、必ず受信者に受信したparam値を渡さなければなりません。このような用途で各プラットフォームのプッシュシステム(APNs、FCM)や他のプッシュ通知システムを利用できます。
ただし、パラメーター名をcc_paramに変更する必要があります。詳しくは、アプリサーバーの役割を参照してください。
メソッドとURI
- メソッド:GET
- URI:
{notify_cb_url}
クエリパラメーター
| パラメーター | データ型 | Null許容 | 説明 | 例 |
|---|---|---|---|---|
sid | String | N | セッションID。この値を利用して通話を識別できます。Nullのない36バイトの固定長です。 | 6364e8b3-bdac-436e-9631-0bce2498ce0c |
from_service_id | String | N | 発信者のサービスID | caller-service-id |
from_user_id | String | N | 発信者のユーザーID | caller-user-id |
to_service_id | String | N | 受信者のサービスID | callee-service-id |
to_user_id | String | N | 受信者のユーザーID | callee-user-id |
type | String | N | メディアタイプ。A:音声通話、V:ビデオ通話 | A |
param | String | N | 受信者に渡す必須パラメーター。BASE64でエンコードした文字列です。アプリサーバーの役割を参照してください。 | rapeyJjYWxsRmxvd1R5cGUiOiJNIiwiY29tbVBhcmFtIjoie1wibXBrZXlcIjpcIkFoTFJVMzBYdVhGZW5UM1o4WmFwVSsyWVBUUHpyWUEyWk9iRHFSenkraHIzXCIsXCJjdG1cIjozMDAwLFwiaWN0XCI6NjAwMH0iLCJjYWxsVHlwZSI6IkEifQ== |
stid | String | Y | Deprecated. PlanetKitの makeCall()を呼び出したときに渡されるアプリケーションデータ | アプリケーションが作成 |
app_svr_data | String | Y | PlanetKitのmakeCall()を呼び出したときに渡されるアプリケーションデータ詳しくは、クライアントプラットフォームごとのアプリサーバーデータガイドを参照してください。 - Android - iOS - macOS - Windows - Web 注:このパラメーターは stidと同じデータを提供します。 | アプリケーションが作成 |
コード例
# Let's suppose notify_cb_url is
# http://sample.server.com:20200/notify_cb
# LINE Planet server will send a request to notify_cb_url as follows.
GET http://sample.server.com:20200/notify_cb?
from_user_id=9286&
from_service_id=caller-service-id&
to_user_id=2809&
to_service_id=callee-service-id&
sid=151ad995-749c-4a28-893f-636700469db1&
type=A&
stid=stid&
param=eyJjYWxsRmxvd1R5cGUiOiJNIiwiY29tbVBhcmFtIjoie1wibXBrZXlcIjpcIkFoTFJVMzBYdVhGZW5UM1o4WmFwVSsyWVBUUHpyWUEyWk9iRHFSenkraHIzXCIsXCJjdG1cIjozMDAwLFwiaWN0XCI6NjAwMH0iLCJjYWxsVHlwZSI6IkEifQ%3D%3D&
app_svr_data=appSvrData
Notifyコールバック応答
LINE Planet サーバーは、Notify コールバックに対するレスポンスコードが200 OKの場合、成功として処理します。アプリサーバーは、少なくとも 1 件以上のプッシュをプッシュシステムへ正常に送信できた場合、LINE Planet サーバーへ200 OKを返す必要があります。
Notify コールバックの呼び出しにはタイムアウトが設定されています。タイムアウトが発生した場合、またはアプリサーバーが失敗レスポンス(4xxまたは5xx)を返した場合、LINE Planet サーバーは当該呼び出しを失敗として終了します。この場合、発信者側ではPUSH_ERRORの通話終了理由とともに発信処理が終了します。