Notify callback
The Notify callback is always called when a caller tries to make a call. An application that receives this callback needs to inform the callee that a call is coming in.
To do so, the app server must deliver the received param to the callee. You can use a push system (such as APNs, FCM) supported by each platform, or other push notification system.
However, the param key name must be changed to cc_param. For more information, refer to the app server requirements.
Method and URI
- Method: GET
- URI:
{notify_cb_url}
Query parameters
| Parameter | Type | Nullable | Description | Example |
|---|---|---|---|---|
sid | String | N | Session ID. You can identify a call using a sid.Fixed size of 36 bytes without NULL. | 6364e8b3-bdac-436e-9631-0bce2498ce0c |
from_service_id | String | N | Caller service ID | caller-service-id |
from_user_id | String | N | Caller user ID | caller-user-id |
to_service_id | String | N | Callee service ID | callee-service-id |
to_user_id | String | N | Callee user ID | callee-user-id |
type | String | N | Call type - A: Audio call- V: Video call | A |
param | String | N | This value must be delivered to the callee. (Refer to the app server requirements.) This is a base64 encoded string. | eyJjYWxsRmxvd1R5cGUiOiJNIiwiY29tbVBhcmFtIjoie1wibXBrZXlcIjpcIkFoTFJVMzBYdVhGZW5UM1o4WmFwVSsyWVBUUHpyWUEyWk9iRHFSenkraHIzXCIsXCJjdG1cIjozMDAwLFwiaWN0XCI6NjAwMH0iLCJjYWxsVHlwZSI6IkEifQ== |
stid | String | Y | Deprecated. Application data delivered from makeCall() in PlanetKit SDK | generated-by-application |
app_svr_data | String | Y | Application data delivered from makeCall() in PlanetKit SDK.For more information, refer to the app server data guide for each client platform: - Android - iOS/macOS - Windows - Web Note: This parameter delivers the same data as stid. | generated-by-application |
Example
# 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