Skip to main content
Version: 5.3

Cloud call recording

LINE Planet provides the cloud call recording function, which performs recording of specific 1-to-1 calls on the cloud upon request. This page describes how to use the cloud call recording function through PlanetKit.

Supported call typeMinimum SDK version
1-to-1 call5.2
Warning

To use the cloud call recording function, you must consult with the LINE Planet team in advance. If you want to use this function, please contact us.

Enable cloud call recording​

Either caller or callee can enable cloud call recording during the call setup process.

Tip

To learn more about the 1-to-1 call setup flow, see 1-to-1 call flow.

Caller side​

A caller can enable cloud call recording while making a call.

To enable cloud call recording on the caller side, set recordOnCloud to true while creating a MakeCallParams object and call makeCall() with the MakeCallParams object.

const makeCallParams = {
    ...,
    recordOnCloud: true
};

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

Callee side​

A callee can enable cloud call recording while accepting a call.

To enable cloud call recording on the callee side, pass true to recordOnCloud when calling acceptCall().

planetKit.acceptCall(true)
    .then(() => {
        // Successfully accepted a call
    })
    .catch((error) => {
        // Failed to accept a call
    });

You can receive events related to cloud call recording, which deliver information such as the status of activation and the reason for deactivation.

When there is an update in the status of cloud call recording, the evtRecordOnCloudUpdated callback is invoked. The evtRecordOnCloudUpdated callback delivers the following information:

ParameterTypeDescription
activatedbooleanIndicates whether cloud call recording is activated or not.
deactivateReasonRECORD_ON_CLOUD_DEACTIVATE_REASONExpresses why cloud call recording is deactivated, which can be one of the following:
  • INTERNAL: An internal error occurred.
  • ACTIVATION_FAILED: Recording failed on the cloud.
Note: If activated is true, this parameter is not valid.

APIs related to cloud call recording are as follows.