查询礼物发送结果

描述

发送礼物后，您可以调用此接口传入 MsgId 列表，批量查询对应礼物请求是否被正常送出。

接口原型

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

请求参数

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

参数	类型	是否必选	描述
RoomId	String	是	房间 ID，由您定义，长度上限为 64 字符。
MiniGameId	String	是	游戏 ID，请与送礼时的游戏 ID 保持一致。
MsgIdList	Array of String	是	送礼消息 ID 列表。
Duration	Number	否	需要查询的天数，默认查询 30 天内的记录，最多支持查询 90 天。

请求示例

请求 URL

Untitled

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

Copied!

请求消息体

Untitled

{
  "RoomId": "room123",
  "MiniGameId": "TinyLoveWar",
  "MsgIdList": [
    "10000000001",
    "10000000002"
  ],
  "Duration":30
}

Copied!

响应参数

参数	类型	描述
Code	Number	错误码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Data	Object	返回的具体信息。详细请参考 Data 参数说明

Data 参数说明：

参数	类型	描述
Results	Array of Object	成功消费的礼物弹幕处理结果列表，未被消费的礼物消息则不会返回结果。详细请参考 Results 参数说明

Results 参数说明：

参数	类型	描述
Results	Array of Object	成功消费的礼物弹幕处理结果列表，未被消费的礼物消息则不会返回结果。
Result	Number	处理结果。 0：成功。其他：失败。
Msg	String	失败原因。
MsgId	String	处理结果对应的礼物唯一 MsgId。
Timestamp	Number	发送礼物时传入的字段，用于区分同一 MsgId 不同时间送出的礼物请求。

响应示例

Untitled

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123",
    "Data": {
        "Results": [
          {
            "Result": 0,
            "Msg": "success",
            "MsgId": "10000000001",
            "Timestamp": 1701244029266
          },
          {
            "Result": 0,
            "Msg": "success",
            "MsgId": "10000000002",
            "Timestamp": 1701244029280
          }
        ]
    }
}

Copied!

返回码

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

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

返回码

描述说明

处理建议

7202001

游戏未找到，可能造成的原因包含：

MiniGameId 输入错误。
未开通此游戏的权限。

请检查 MiniGameId 是否正确。
请联系 ZEGO 商务人员开通此游戏的权限。

7202002

MiniGameId 格式错误。

请确认格式是否为 String。

Result处理结果码

返回码	描述说明	处理建议
10003	送礼失败，可能造成的原因包含：用户未加入游戏。房间不存在或已结束。未知错误。	请联系 ZEGO 技术人员排查问题。
10004	未配置对应礼物。	请确认礼物是否已配置。

返回码

描述说明

处理建议

10003

送礼失败，可能造成的原因包含：

用户未加入游戏。
房间不存在或已结束。
未知错误。

请联系 ZEGO 技术人员排查问题。

10004

未配置对应礼物。

请确认礼物是否已配置。