Help Center> Cloud Phone Host> API Reference> Cloud Mobile Gaming Instance Event API> Heartbeat Reporting
View PDF

Heartbeat Reporting

Request Parameters

Parameter

Mandatory

Type

Description

event_type

Yes

String

Specifies the event type. The enumerated value is app.

event

Yes

Object

Specifies the event information. For details, see Table 1.
Table 1 event field description

Parameter

Mandatory

Type

Description

phone_id

Yes

String

Specifies the unique ID of a server. This parameter is required for server tasks.

time

Yes

String

Specifies the heartbeat report time.

The value is a UTC time.

app_id

Yes

String

Specifies the unique ID of an application.

session_id

Yes

String

Specifies the unique ID of a session.

Example Request

{
    "event_type": "heartbeat",
    "event": {
        "phone_id": "a7f3a1c5258347d6b6f1def79e11f2bc",
        "app_id": "282fdfd613e04651a48225f1b2034de7", //When the cloud game is running, app_id indicates the application ID. After you exit a cloud game, the value of app_id is left blank.
        "session_id": "36728337b89f22122af4a6e08bb1e7c0", //When the cloud game is running, session_id indicates the session ID. After you exit a cloud game, the value of session_id is left blank.
        "time": "2019-11-14T19:38:49Z"
    }
}

Response Parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

Example Response

{
    "request_id": "6837531fd3f54550927b930180a706bf"
}