Report live comment-based game information

Description

This callback allows you to receive specific event notifications when the live comment-based game starts and when the live comment-based game is finished.

Callback description

Request methods: POST.
Callback address: Contact the ZEGOCLOUD technical support team to configure the callback address.
Transmission protocol: HTTPS.

Callback parameters

Common parameter	Type	Description
AppId	Int64	The unique ID of the application.
SignatureNonce	String	A random number.
Timestamp	Int64	Unix The UNIX timestamp. Unit: seconds.
Signature	String	Signature.
Business parameter	Type	Description
GameSource	String	The game source, fixed as `zego`.
ReportId	String	Generated by ZEGOCLOUD, unique callback ID under the same MiniGameId.
ReportType	Int	Report information types: 1： Game starts. 2： Game settlement.
MiniGameId	String	The game ID.
RoomId	String	The game room ID.
AnchorId	String	The ID of the game room owner.
RoundId	String	The game session identifier is generated by the ZEGOCLOUD server and is unique within the same MiniGameId.
ReportTime	Int64	The time when the event occurs. The time is a UNIX timestamp. Unit: milliseconds.
DanmakuResult	Object	Game settlement information. Only reported at game settlement.
WinTeam	Int	Winning team of the live comment-based game.
ResultType	Int	Settlement types: 0：Normal ending. 1：Ended by the anchor. 2：Ended due to timeout. 3：Escape. 4：Game forcefully closed. 5： Game ended due to an exception.
UserSize	Int	Number of participating users.
ExtraData	String	Additional JSON data.

Callback example

Untitled

{
    "AppId":1234567890,
    "SignatureNonce":"15215528852396",
    "Timestamp":1234567890,
    "Signature":"Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D",
    "GameSource":"zego",
    "ReportId":"jjjjjj",
    "MiniGameId":"aaaaaa",    
    "ReportType":2,
    "RoomId":"abcd",
    "AnchorId":"user111",
    "RoundId":"xxx",
    "ReportTime":1662365592,
    "DanmakuResult":{
        "WinTeam":"1",
        "ResultType":1,
        "UserSize":10,
        "ExtraData":""
    }    
}

Copied!

Response parameters

Please respond after receiving this callback, the parameters are shown in the following table:

Parameter	Type	Is it required	Description
Code	Int64	Yes	The HTTP status code. Valid values: 200：The callback succeeds. 401、404、500：The callback fails.
Message	String	No	The response message.

Response Example

Untitled

{
    "Code": 200,
    "Message": "succeed"
}

Copied!