全服消息推送
业务场景
- 向全服的安卓、iOS客户端发送一条消息
- 根据不同的语言，向玩家推送不一样的消息
- 未记录语言的玩家，默认发送英语消息
- token已经过期的玩家，会推送失败
注意事项
- 同步发送，需等待结果返回
- 时间戳与北京时间差距为 ± 5分钟
接口地址
https://cpapi.iyagame.com/v1/push/send-to-topic
接口说明
- 协议：HTTPS
- 方式：POST
- ContentType：application/json;charset=utf-8
- 请求报文：
| 字段 | 类型 | 必需 | 参与签名 | 说明 |
|---|---|---|---|---|
| appId | long | 是 | 是 | SDK的appId |
| timestamp | long | 是 | 是 | 毫秒时间戳 |
| messages | array | 是 | 否 | 消息列表 |
| sign | string | 是 | 否 | 签名 |
messages
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| language | string | 是 | 推送指定的语种，语言目录 |
| title | string | 是 | 消息标题 |
| body | string | 是 | 消息内容 |
| image | string | 否 | 消息图片 |
| extendData | object | 否 | 自定义参数，key:value，可透传进游戏内 |
- 响应报文：
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| code | int | 是 | 响应状态码 |
| msg | string | 是 | 响应描述 |
| data | object | 是 | 结果数据 |
data字段
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| pushNo | string | 是 | 推送批次号 |
请求示例
{
"appId": 10070,
"timestamp": 191556658759,
"sign": "b150d9551be444d1cdce0b0dea467da6",
"messages": [
{
"language": "en",
"title": "test",
"body": "test",
"image": "https://osg.iyagames.com/tw/assets/logo.png",
"extendData": {
"k1": "v1"
}
},
{
"language": "zh",
"title": "测试",
"body": "测试",
"image": "https://osg.iyagames.com/tw/assets/logo.png",
"extendData": {
"k1": "v1"
}
}
]
}
响应示例
{
"code": 0,
"msg": "Success",
"data": {
"pushNo": "220816202014011000001101946"
},
"meta": {
"tid": "108a996c"
}
}
签名规则
- 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
- 只有值为 null 和 参数名不参与签名 的键值对，才不参与签名
- 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接，再进行MD5计算
- 将生成的签名与入参 sign 值作校验，验签忽略大小写
调试示例
import cn.hutool.crypto.SecureUtil;
public class PushBatchExample {
public static void main(String[] args) {
Integer appId = 10070;
Long timestamp = 191556658759L;
String appKey = "j1u9pbx2jkoo0zso";
String sign = SecureUtil.md5("appId=" + appId + "×tamp=" + timestamp + "&key=" + appKey);
System.out.printf("批量推送签名:%s", sign);
}
}
状态码
| 状态码 | 说明 |
|---|---|
| 0 | 成功 |
| -1 | 失败，常规性错误 |
| 10101 | 查询基础信息失败 |
| 10102 | 缺少游戏信息 |
| 10103 | 请求参数全部为空 |
| 10104 | 缺少签名sign |
| 10105 | 签名不正确 |
| 10106 | timestamp已过期 |
| 10201 | 消息推送失败，具体信息见msg |
| 10202 | 消息推送服务请求超时，可重试 |
附录
| 语言 | ISO-639-1代码 |
|---|---|
| 英语 | en |
| 简体中文 | zh |
| 繁体中文 | zh-TW |
| 日语 | ja |
| 韩语 | ko |
| 德语 | de |
| 法语 | fr |
| 泰语 | th |
| 越南语 | vi |
| 土耳其语 | tr |
| 西班牙语 | es |
| 俄语 | ru |
| 葡萄牙语 | pt |
| 印尼语 | in |
| 阿拉伯语 | ar |
| 荷兰语 | nl |
| 意大利语 | it |
| 瑞典语 | sv |
| 丹麦语 | da |