微信直播信息
业务场景
- 渠道包的某些运营事件数据，游戏方需要记录起来，用于运营活动
- 运营事件，包括但不限：微信直播
注意事项
- 不同事件类型，推送事件数据的结构体不同，详情请咨询对接人员
| 类型名称 | 类型描述 |
|---|---|
| wechat.minigame.live | 微信小游戏直播 |
- 微信直播数据，入参eventData的结构体
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| feedId | string | 是 | 直播id |
| description | string | 是 | 直播主题 |
| startTime | string | 是 | 开播时间戳(秒) |
| endTime | string | 是 | 关播时间戳(秒) |
| totalCheerCount | string | 是 | 主播收到的喝彩总数 |
| totalAudienceCount | string | 是 | 直播间总观众人数 |
| liveDurationInSeconds | string | 是 | 直播总时长(秒) |
| extension | string | 是 | 拓展参数，用户开播时游戏侧传入 |
流程图
接口地址
地址由CP提供
接口说明
- 协议：HTTPS
- 方式：POST
- ContentType：application/json;charset=utf-8
- 请求报文：
| 字段 | 类型 | 必需 | 参与签名 | 说明 |
|---|---|---|---|---|
| openid | string | 是 | 是 | SDK用户唯一标识 |
| eventType | string | 是 | 是 | 事件类型 |
| eventId | string | 是 | 是 | 事件唯一id(同一id出现多次, 代表重复上报) |
| eventData | string | 是 | 是 | 事件数据, json格式 |
| timestamp | long | 是 | 是 | 毫秒时间戳 |
| sign | string | 是 | 否 | 签名 |
- 响应报文：
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| code | int | 是 | 状态码：0代表成功，非0代表失败 |
| msg | string | 是 | 响应描述 |
请求示例
{
"openid": "1734973598654168207709815",
"eventType": "wechat.minigame.live",
"eventId": "8af5b9411bd44d27bb4e955eb82e9a42",
"eventData": "[{\"description\":\"\",\"endTime\":\"1742528918\",\"extension\":\"{\\\"playerId\\\":\\\"401241500030266\\\",\\\"roleId\\\":\\\"401241500030266\\\",\\\"serverId\\\":4012415}\",\"feedId\":\"export/UzFfAgtgekIEAQAAAAAAuKMJE_o8rwAA......my1sw\",\"liveDurationInSeconds\":\"349\",\"startTime\":\"1742528569\",\"totalAudienceCount\":\"0\",\"totalCheerCount\":\"0\"}]",
"timestamp": 1742528920316,
"sign": "4bbc843f8280972ac19f4c399e215284"
}
响应示例
{
"code": 0,
"msg": "Success"
}
签名规则
- 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
- 只有值为 null 和名为 sign 的键值对，才不参与签名
- 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接
- 将生成的签名与入参 sign 值作校验，验签忽略大小写
String sign = md5(k1=v1&k2=v2&k3=v3...&key=appKey);
调试示例
import cn.hutool.crypto.SecureUtil;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
public class SignExample {
public static String getMd5Sign(Map<String, Object> params, String appKey) {
TreeMap<String, Object> sortedParams = new TreeMap(params);
StringBuilder builder = new StringBuilder(512);
sortedParams.forEach((k, v) -> {
if (v != null) {
builder.append(k).append("=").append(v).append("&");
}
});
builder.append("key=").append(appKey);
return SecureUtil.md5(builder.toString());
}
public static void main(String[] args) {
String appKey = "AaBbCcDdEeFfGgHh";
Map<String, Object> reqMap = new HashMap<>();
reqMap.put("openid", "1734973598654168207709815");
reqMap.put("eventType", "wechat.minigame.live");
reqMap.put("eventId", "8af5b9411bd44d27bb4e955eb82e9a42");
reqMap.put("eventData", "[{\"description\":\"\",\"endTime\":\"1742528918\",\"extension\":\"{\\\"playerId\\\":\\\"401241500030266\\\",\\\"roleId\\\":\\\"401241500030266\\\",\\\"serverId\\\":4012415}\",\"feedId\":\"export/UzFfAgtgekIEAQAAAAAAuKMJE_o8rwAA......my1sw\",\"liveDurationInSeconds\":\"349\",\"startTime\":\"1742528569\",\"totalAudienceCount\":\"0\",\"totalCheerCount\":\"0\"}]");
reqMap.put("timestamp", 1742528920316L);
System.out.println(String.format("推送签名:%s", getMd5Sign(reqMap, appKey)));
}
}