Skip to main content
Version: 5.3

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 typeSupported SDK version
1-to-1 call, group callAll versions
Note
  • App server data is functionally equivalent to "Service ticket ID" available in WebPlanetKit 5.1.0 or lower. Only the name of the feature has been changed since WebPlanetKit 5.2.0.
  • 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 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.
    });

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 = {
    ...,
    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.
    });

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.

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

1-to-1 call​

Client API​

Server API​

Group call​

Client API​

Server API​