游戏接入指南
AppId和商品档位可以参考渠道配置列表 :https://channels.begind.cn/
接口地址说明:
服务端接口地址区分环境,不同的AppId对应不同的地址,主要是域名不同,下文中使用{address}代替。
国内环境{address}
- AppId(1-15): https://sgw.begindcc.com
- AppId(16/17/20): https://sgw.xiayixing.com
- AppId(18): https://sgw.simiaoyuexin.com
- AppId(21): https://sgw.xinyou7.com
- AppId(22): https://sgw.youpin7.com
- AppId(23): https://sgw.huanyou7.com
- AppId(24): https://sgw.lejiawenhua.com
- AppId(25): https://sgw.cangmaonet.com
海外环境{address}
- 全部AppId: https://sgw.xiuzhenme.com
登录验证
说明
- 客户端登录成功之后会响应userId、token等参数
- 客户端需要将userId、token等参数告诉游戏服务器,游戏服务器拿着这些参数进行一次登录验证
- 可优先使用本地token算法验证减少网络请求,参考 token验证
请求URL验证
{address}/ufo/api/{appId}/user/verify
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| token | String | Token |
| channelId | int | 渠道ID |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID唯一,账号关联标识 |
| channelUserId | String | 渠道用户ID与accountChannelId联合对应userId |
| channelId | int | 渠道号可用于区分服务器显示 |
| accountChannelId | int | 账号渠道号同渠道号,游戏内无须关心 |
| extension | String | 扩展字段 可为空 |
| type | int | 账号类型0为普通用户,1为白名单用户 |
支付回调
说明
- 当平台收到渠道SDK支付回调并处理成功时,会调用游戏服的支付回调地址,通知游戏服给玩家发货
- 该回调地址,客户端在调用支付接口的时候,通过notifyUrl字段传入SDK
- 游戏需通过cpOrderId,将游戏订单上的roleId/productId/money与回调信息进行对比校验
- orderId(平台订单号)具有全局唯一性,游戏可对其唯一性进行校验
请求URL
- 优先使用客户端调用支付接口时传入的notifyUrl
- 当notifyUrl为空时使用游戏默认配置
请求格式
- 请求方式: HTTP POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID补单时为补单渠道号 |
| userId | String | 是 | 用户ID |
| orderId | String | 是 | 平台订单号 |
| cpOrderId | String | 是 | 游戏订单号 |
| productId | String | 是 | 商品ID |
| currency | String | 是 | 货币类型,默认CNY,ISO4217 |
| money | int | 是 | 充值金额,单位分 |
| serverId | String | 是 | 游戏服务器ID |
| roleId | String | 是 | 角色ID |
| extension | String | 是 | 透传字段,游戏自定义参数,原样返回 |
| version | String | 是 | 接口版本号,固定值v2 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
| recharge | String | 否 | 补单标识,如果是补单则固定值为recharge |
| rechargeChannelId | int | 否 | 当订单为补单时,该值赋值为用户真实渠道号 |
| orderType | int | 否 | 0=内购,1=订阅,内购与首次订阅会有cpOrderId,续订cpOrderId会为空。没有传该字段默认为内购类型 |
| subscriptionId | String | 否 | 订阅id,一组订阅订单的关系标识 |
| subscriptionType | int | 否 | 订阅类型,1=首次订阅,2=续订 |
| isTest | int | 否 | 是否为测试订单。0:否,1:是。仅在测试环境下生效:测试订单默认不发货,仅当 userId 加入研发白名单时才会发货。 |
响应格式
- Content-Type: text/plain
- 游戏服务器处理成功,直接返回一个"SUCCESS"字符串即可,失败返回一个"FAIL"字符串
访客ID-数数(可选)
请求URL
{address}/ufo/api/{appId}/thinking/getDistinctId
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| channelId | int | 渠道ID |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID唯一,账号关联标识 |
| distinctId | String | 访客ID 用户在未登录状态下的ID |
发送验证码(可选)
请求URL
{address}/ufo/api/{appId}/channel/sendCode
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| phone | String | 手机号 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
绑定手机号(可选)
请求URL
{address}/ufo/api/{appId}/channel/bindPhone
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| phone | String | 手机号 |
| code | String | 验证码 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID |
| phone | String | 成功绑定的手机号 |
换绑手机号(可选)
请求URL
{address}/ufo/api/{appId}/channel/changeBindPhone
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| phone | String | 手机号 |
| code | String | 验证码 |
| newPhone | String | 新手机号 |
| newCode | String | 新手机号对应验证码 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID |
| phone | String | 成功换绑的手机号 |
校验验证码(可选)
请求URL
{address}/ufo/api/{appId}/channel/verifyCode
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏ID |
| userId | String | 用户ID |
| phone | String | 手机号 |
| code | String | 验证码 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID |
| phone | String | 成功绑定的手机号 |
广告回调(可选)
说明
- 当用户观看完激励视频广告后,平台会通知游戏服给玩家发货
- 游戏服务器收到并验证通过后即应响应平台(不应等发货完成后再响应)
请求URL
- 优先使用客户端在调用加载广告接口时传入的notifyUrl
- 当notifyUrl为空时使用游戏默认配置
请求格式
- 请求方式: HTTP POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID |
| userId | String | 是 | 用户ID |
| orderId | String | 是 | 平台订单号 |
| cpOrderId | String | 否 | 游戏订单号 |
| posId | String | 是 | 广告位ID |
| rewardName | String | 否 | 奖励名称 |
| rewardAmount | int | 否 | 奖励数量 |
| serverId | String | 是 | 游戏服务器ID |
| roleId | String | 是 | 角色ID |
| extension | String | 是 | 透传字段,游戏自定义参数,原样返回 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: text/plain
- 游戏服务器处理成功,直接返回一个"SUCCESS"字符串即可,失败返回一个"FAIL"字符串
创建红包(可选)
请求URL
{address}/ufo/api/{appId}/rebate
请求格式
- 请求方式: HTTP POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID |
| userId | String | 是 | 用户ID |
| orderId | String | 是 | 平台订单号 |
| cpOrderId | String | 否 | 游戏订单号,同一订单号只会返利一次 |
| money | int | 是 | 返利金额,单位分 |
| wishing | String | 是 | 返利祝福语 |
| rebateName | String | 是 | 返利活动名称 |
| serverId | String | 是 | 游戏服务器ID |
| serverName | String | 是 | 游戏服务器名称 |
| roleId | String | 是 | 角色ID |
| roleName | String | 是 | 角色名称 |
| roleLevel | int | 是 | 角色等级 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| channelOrderId | String | 渠道订单号,手Q使用H5页面拆红包需要传入订单号 |
返利回调(可选)
说明
- 如果玩家充值触发渠道返利条件,则会通过该接口通知CP给玩家返利
- 通知参数为触发返利订单的数据
- 具体返利金额由CP决定,建议为5%-10%一级货币
- 同一笔订单只会返利一次,CP必须要有处理
重复通知的逻辑
请求URL
请求格式
- 请求方式: HTTP POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID |
| userId | String | 是 | 用户ID |
| orderId | String | 是 | 平台订单号 |
| cpOrderId | String | 是 | 游戏订单号 |
| productId | String | 是 | 商品ID |
| currency | String | 是 | 货币类型,默认CNY,ISO4217 |
| money | int | 是 | 充值金额,单位分 |
| serverId | String | 是 | 游戏服务器ID |
| roleId | String | 是 | 角色ID |
| extension | String | 是 | 透传字段,游戏自定义参数,原样返回 |
| version | String | 是 | 接口版本号,固定值v2 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: text/plain
- 游戏服务器处理成功,直接返回一个"SUCCESS"字符串即可,失败返回一个"FAIL"字符串
兑换码验证(可选)
流程及说明
- 玩家通过渠道(抖音等)购买兑换码卡券,获取可兑换相应道具礼包的兑换码。
- 兑换码由我方生成并给到用户,游戏只需要在兑换入口处获取到兑换码后,通过该接口调用给我方即可。
- 我方验证通过后消码,并且通过发送邮件功能进行对应礼包道具发放。
- 注:如果是限定角色只能使用一次的兑换码,在同一角色使用过后,后续使用会使用失败,具体失败原因会在响应消息体msg内进行说明
请求URL
{address}/coupon/api/verify
请求格式
- 请求方式: HTTP POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| userId | String | 是 | 用户ID |
| couponId | String | 是 | 兑换码ID |
| serverId | String | 是 | 游戏服务器ID |
| serverName | String | 是 | 游戏服务器名称 |
| roleId | String | 是 | 角色ID |
| roleName | String | 是 | 角色名称 |
| version | String | 是 | 接口版本号,固定值v2 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
小游戏AccessToken(可选)
说明
- 小游戏需要调用小游戏官方API接口时,可以通过此接口获取小游戏
accessToken - 小游戏AccessToken请求, 必传参数
appId、channelId
请求URL
{address}/ufo/api/{appId}/user/accessToken
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| channelId | int | 渠道ID |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| accessToken | String | 小游戏接口调用凭证 |
| expiresIn | int | 凭证有效时间,单位:秒 |
小游戏订阅消息接口(可选)
说明
请求URL
{address}/mp/api/{appId}/send/subscribe
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| channelId | int | 渠道ID |
| userId | long | 用户ID |
| templateId | String | 所需下发的订阅模板 id |
| page | String | 点击模板卡片后的跳转页面,仅限本小程序内的页面。 |
| data | String | 模板内容,请参照各家小游戏的格式要求进行填写。 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
data格式
| 小游戏平台 | 格式 |
|---|
| 微信小游戏 | "{\"key1\":{\"value\":\"any\"},\"key2\":{\"value\":\"any\"}}" |
| 抖音小游戏 | "{\"key1\":\"any\",\"key2\":\"any\"}" |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
小游戏批量订阅消息接口(可选)
说明
请求URL
{address}/mp/api/{appId}/send/subscribe/batch
请求格式
- 请求方式: HTTP POST
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| channelId | int | 渠道ID |
| templateId | String | 所需下发的订阅模板 id |
| page | String | 点击模板卡片后的跳转页面,仅限本小程序内的页面。 |
| data | String | 批量订阅内容,默认处理100个,格式形如 [{ "userId": "", "userData": "{}" }] |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
data格式
| 参数 | 类型 | 描述 |
|---|
| userId | long | 用户ID |
| userData | String | 模板内容,请参照各家小游戏的格式要求进行填写。 |
userData格式
| 小游戏平台 | 格式 |
|---|
| 微信小游戏 | "{\"key1\":{\"value\":\"any\"},\"key2\":{\"value\":\"any\"}}" |
| 抖音小游戏 | "{\"key1\":\"any\",\"key2\":\"any\"}" |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
用户Id(可选)
说明
请求URL
{address}/ufo/api/{appId}/user/info
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| channelUserId | String | 渠道用户id |
| channelId | int | 渠道id |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| userId | String | 用户id |
| channelId | int | 渠道id |
| channelUserId | String | 渠道用户id |
活动信息回传(可选)
说明
请求URL
{address}/transfer/activity/record
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| userId | String | 用户ID |
| channelId | int | 渠道ID |
| activityId | int | 活动ID |
| point | String | 活动节点 |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 空 |
活动参与条件获取(可选)
说明
- 游戏某些活动需要控制参与人数、角色等信息,此接口用来获取活动参与条件
请求URL
{address}/transfer/activity/config
请求格式
- 请求方式: HTTP GET/POST
- Content-Type: application/x-www-form-urlencoded
| 参数 | 类型 | 描述 |
|---|
| appId | int | 游戏id |
| id | int | 活动id |
| ts | long | Unix时间戳秒 |
| sign | String | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | List | 成功时响应数据List |
| 参数 | 类型 | 描述 |
|---|
| condition | String | 条件名称 |
| contrast | int | 对比类型 |
| value | String | 值 |
data数据结构示例- 角色等级>=100 且 角色vip等级>=1
[{"condition":"roleLevel", "contrast":5, "value":"100"}, {"condition":"roleVipLevel", "contrast":5, "value":"1"}]
| 值 | 类型 | 描述 |
|---|
| roleLevel | String | 角色等级 |
| rolePower | String | 角色战力 |
| mainLevel | String | 主线关卡 |
| dateActive | String | 当天活跃度(活跃度是游戏内每日任务的进度) |
| totalActive | String | 累计满活跃次数 |
| drawCount | String | 高招次数(高级招募次数) |
| dateAlive | String | 当天在线时长(分钟) |
| chatCount | String | 聊天发言次数 |
| roleVipLevel | String | vip等级 |
| createDate | String | 创角天数 |
| totalPay | String | 角色累充金额 |
| 值 | 类型 | 描述 |
|---|
| 1 | int | 小于 > |
| 2 | int | 小于等于 >= |
| 3 | int | 等于 = |
| 4 | int | 大于 < |
| 5 | int | 大于等于 <= |
问卷完成回调
说明
- 当用户完成问卷后,会调用游戏服的问卷回调地址,通知游戏服用户问卷已完成。
请求URL
请求格式
- 请求方式: HTTP POST
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 必选 | 描述 |
|---|
| submitId | long | 是 | 同一份问卷中的提交唯一ID |
| formKey | String | 是 | 问卷唯一标识 |
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID |
| serverId | String | 是 | 服务器ID |
| roleId | String | 是 | 角色ID |
| roleName | String | 是 | 角色名称 |
| userId | String | 是 | 用户ID |
| extra | String | 否 | 拓展字段 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
| apiVersion | String | 是 | 接口版本号,固定值v2 |
响应格式
- Content-Type: text/plain
- 游戏服务器处理成功,直接返回一个"SUCCESS"字符串即可,失败返回一个"FAIL"字符串
查询用户是否添加企微(可选)
说明
- 游戏内判断用户是否添加了企微,根据响应给用户发放奖励。
请求URL
{address}/push/api/{appId}/qw/user/exist
请求格式
- 请求方式: HTTP GET
- Content-Type: application/x-www-form-urlencode
| 参数 | 类型 | 必选 | 描述 |
|---|
| userId | String | 是 | 用户Id |
| appId | int | 是 | 游戏id |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
| 参数 | 类型 | 描述 |
|---|
| existUserId | boolean | 是否添加企微 |
{"code":1,"msg":"Success","data":{"existUserId":false}}
添加企微完成回调
说明
- 当用户完成添加企微客服后,会调用游戏服的添加企微完成回调地址,通知游戏服用户已成功添加企微客服。
请求URL
请求格式
- 请求方式: HTTP POST
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| channelId | int | 是 | 渠道ID |
| serverId | String | 是 | 服务器ID |
| roleId | String | 是 | 角色ID |
| userId | String | 是 | 用户ID |
| extra | String | 否 | 拓展字段 |
| ts | long | 是 | Unix时间戳秒 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
| apiVersion | String | 是 | 接口版本号,固定值v2 |
响应格式
- Content-Type: text/plain
- 游戏服务器处理成功,直接返回一个"SUCCESS"字符串即可,失败返回一个"FAIL"字符串
通知栏消息推送-单条
说明
- 通过用户Id给用户发送手机通知栏消息,当前支持的渠道有(oppo,vivo,华为,鸿蒙,荣耀,小米,苹果)
- 异步请求,研发无需关注推送结果,只需要认状态码
请求URL
{address}/push/api/{appId}/send/single/message
请求格式
- 请求方式: HTTP POST
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| userId | string | 是 | 用户ID |
| serverId | string | 是 | 服务器ID |
| roleId | string | 是 | 角色ID |
| title | String | 是 | 标题(长度限制在50个字符串以内) |
| content | String | 是 | 内容(长度限制在100个字符串以内) |
| actionType | int | 否 | 行为类型(0:点击),不填默认点击 |
| actionConfig | String | 否 | 行为内容(包名或url),默认打开游戏 |
| ts | long | 是 | Unix时间戳秒 |
| apiVersion | string | 是 | 接口版本号,固定值v2 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |
通知栏消息推送-批量
说明
- 通过用户Id列表给多个用户发送手机通知栏消息,当前支持的渠道有(oppo,vivo,华为,鸿蒙,荣耀,小米,苹果)。
- 异步请求,研发无需关注推送结果,只需要认状态码
请求URL
{address}/push/api/{appId}/send/batch/message
请求格式
- 请求方式: HTTP POST
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 必选 | 描述 |
|---|
| appId | int | 是 | 游戏ID |
| userList | String | 是 | 用户的JSON数组经过URL编码后的字符串。(条数上限制500) |
| title | String | 是 | 标题(长度限制在50个字符串以内) |
| content | String | 是 | 内容(长度限制在100个字符串以内) |
| actionType | int | 否 | 行为类型(0:点击),不填默认点击 |
| actionConfig | String | 否 | 行为内容(包名或url),默认打开游戏 |
| ts | long | 是 | Unix时间戳秒 |
| apiVersion | string | 是 | 接口版本号,固定值v2 |
| sign | String | 是 | 签名值参考签名算法,密钥使用APP_SECRET |
| 参数 | 类型 | 描述 |
|---|
| userList | JsonArray | 推送用户列表 |
| 参数 | 类型 | 描述 |
|---|
| userId | String | 用户ID |
| serverId | String | 区服ID |
| roleId | String | 角色Id |
[{"userId":"306","serverId":"1060414","roleId":"2258080578840"},{"userId":"310","serverId":"1050913","roleId":"2238216355084"}]
响应格式
- Content-Type: application/json:charset=utf-8
| 参数 | 类型 | 描述 |
|---|
| code | int | 状态码 |
| msg | String | 提示信息 |
| data | JSON | 成功时响应数据JSON |