App server data

Applications can share application data between an app client and the app server when making a 1-to-1 call or joining a group call (conference). App server data is name of the application data delivered from an app client to the app server.

Supported call type	Supported SDK version
1-to-1 call, group call	All versions

Note

• App server data is functionally equivalent to "Service ticket ID" available in PlanetKit 5.0.x or lower. Only the name of the feature has been changed since PlanetKit 5.1.
• In server callbacks, the stid parameter previously used for delivering the service ticket ID has been deprecated. Instead, the app_svr_data parameter delivers the app server data in server callbacks.

Sending app server data

The following sections describe how to send app server data based on the call type.

1-to-1 call

In 1-to-1 calls, only the caller can send app server data.

To send app server data in a 1-to-1 call, set the app server data in a MakeCallParams, and pass the MakeCallParams when calling makeCall().

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);

The app server data is delivered in the app_svr_data parameter of Notify and 1-to-1 Call Event server callbacks.

Group call

In group calls, all participants are eligible to send app server data.

To send app server data in a group call, set the app server data in a ConferenceParams, and pass the ConferenceParams when calling joinConference().

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);

The app server data is delivered in the app_svr_data parameter of the Group Call Event server callback.

Size limitation

The maximum size of app server data is 4096 bytes including the null termination character.

Related API

APIs related to the app server data function are as follows.

1-to-1 call

Client API

• appServerData of MakeCallParams
• makeCall()

Server API

• Notify callback
• 1-to-1 Call Event callback

Group call

Client API

• appServerData of ConferenceParams
• joinConference()

Server API

• Group Call Event callback