服务端 API 小游戏平台 SDK 点赞 - 开发者中心

描述

调用此接口触发弹幕游戏内的点赞事件，会在弹幕游戏客户端产生相应的效果。

说明

游戏平台会尽量保证点赞的有效性。
若用户未加入游戏，则用户的点赞会被丢弃。
请以房间的维度，合并用户的点赞消息，再请求至此接口，建议每 50-200ms 整合一次用户的点赞信息。

接口原型

请求方法：POST
请求地址：https://mini-game-api.zego.im/?Action=SendDanmakuLikes
传输协议：HTTPS
调用频率限制：100 次/秒（以房间为维度）

请求参数

以下请求参数列表仅列出了接口请求参数，公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
RoomId	String	是	房间 ID，由您定义，长度上限为 64 字符。
MiniGameId	String	是	游戏 ID，请联系 ZEGO 技术支持获取。
LikeList	Array of Object	是	整合后的点赞列表。详细请参考 LikeList 参数说明

LikeList 参数说明：

参数	类型	是否必选	描述
UserInfo	Object	是	用户信息对象。详细请参考 UserInfo 参数说明
Amount	Number	否	该用户的点赞数量，默认为 1。

UserInfo 参数说明：

参数	类型	是否必选	描述
UserId	String	是	参与游戏的用户 ID，由您定义，长度上限为 48 字符，只允许数字和英文。注意请保证 UserId 在相同的 appID 下全局唯一。如果您业务的账号系统中的用户 ID 采用了其他规则，请自行实现映射。
Nickname	String	是	用户昵称，由您定义，长度上限为 32 字符。
Avatar	String	是	用户头像的地址，必须是有效的 HTTP/HTTPS 地址，且长度在 1024 字节以内。
Sex	Number	否	用户性别。 1：男。 2：女。

请求示例

请求 URL

Untitled

https://mini-game-api.zego.im/?Action=SendDanmakuLikes
&<公共请求参数>

Copied!

请求消息体

Untitled

{
  "RoomId": "room123",
  "MiniGameId": "TinyLoveWar",
  "LikeList": [
    {
      "UserInfo": {
        "UserId": "user1",
        "Nickname": "test1",
        "Avatar": "http://",
        "Sex": 1
      },
      "Amount": 10
    },
    {
      "UserInfo": {
        "UserId": "user2",
        "Nickname": "test2",
        "Avatar": "http://",
        "Sex": 1
      },
      "Amount": 10
    }
  ]
}

Copied!

响应参数

参数	类型	描述
Code	Number	错误码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。

响应示例

Untitled

{
    "Code": 0,
    "Message": "Succeed",
    "RequestId": "1683811708704948224"
}

Copied!

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	描述说明	处理建议
7202001	游戏未找到，可能造成的原因包含： MiniGameId 输入错误。未开通此游戏的权限。	请检查 MiniGameId 是否正确。请联系 ZEGO 商务人员开通此游戏的权限。
7202002	MiniGameId 格式错误。	请确认格式是否为 String。