文章目录
1. 推送全服礼包(分批)
1.1 说明
- 运用于 GM系统-操作工具-定制礼包管理-添加&修改全服礼包
- 该接口是分批请求接口,当渠道或游戏服数量大于1000,会以每批1000条进行发送
- 有渠道或游戏服追加时,会增量请求
- 注:在到达设定时间时才会调用此接口
1.2 请求方式
- POST
- Content-Type:application/x-www-form-urlencoded
1.3 请求参数
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
gift_id | int | 11 | 礼包ID | 是 |
gift_title | string | 18 | 礼包标题 | 是 |
gift_amount | int | 11 | 礼包价格(单位:分) | 是 |
gift_banner | string | 255 | 礼包背景 | 是 |
start_time | string | 32 | 开始时间,格式YYYY-MM-DD hh:mm:ss | 是 |
end_time | string | 32 | 结束时间,格式YYYY-MM-DD hh:mm:ss | 是 |
duration | int | 11 | 持续时长(单位:秒) | 是 |
sid_list | string,json格式 | - | 多个服务器ID,和渠道ID二选一 | 否 |
channel_id_list | string,json格式 | - | 多个渠道ID,和服务器ID二选一 | 否 |
prop_list | string,json格式 | - | 发送道具 | 是 |
sid_list请求示例:
["a111","a222"]
channel_id_list请求示例:
["1","2"]
prop_list参数说明:
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
id | string | 50 | 道具id | 是 |
num | int | 11 | 道具数量 | 是 |
prop_list请求示例:
[
{
"id": "xx",
"num": 10
},
{
"id": "yy",
"num": 1
}
]
1.4 返回参数
- 响应示例:
{
"status":1,
"msg":"success",
"data":{
}
}
2. 推送角色礼包(分批)
2.1 说明
- 运用于 GM系统-操作工具-定制礼包管理-添加&修改角色礼包
- 该接口是分批请求接口,当角色数量大于1000,会以每批1000条进行发送
- 注:在到达设定时间时才会调用此接口
2.2 请求方式
- POST
- Content-Type:application/x-www-form-urlencoded
2.3 请求参数
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
gift_id | int | 11 | 礼包ID | 是 |
gift_title | string | 18 | 礼包标题 | 是 |
gift_amount | int | 11 | 礼包价格(单位:分) | 是 |
gift_banner | string | 255 | 礼物背景 | 是 |
start_time | string | 32 | 开始时间,格式YYYY-MM-DD hh:mm:ss | 是 |
end_time | string | 32 | 结束时间,格式YYYY-MM-DD hh:mm:ss | 是 |
duration | int | 11 | 持续时长(单位:秒) | 是 |
pid_list | string,json格式 | - | 多个角色ID | 是 |
prop_list | string,json格式 | - | 发送道具 | 是 |
pid_list请求示例:
["aa","bb","cc"]
prop_list参数说明:
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
id | string | 50 | 道具id | 是 |
num | int | 11 | 道具数量 | 是 |
prop_list请求示例:
[
{
"id": "xx",
"num": 10
},
{
"id": "yy",
"num": 1
}
]
2.4 返回参数
- 响应示例:
{
"status":1,
"msg":"success",
"data":{
}
}
3. 撤回礼包
3.1 说明
- 运用于 GM系统-操作工具-定制礼包管理-撤回全服礼包&角色礼包
- 注:在-撤回全服礼包&角色礼包调用此接口,礼包是否撤回由接入方自行处理
3.2 请求方式
- POST
- Content-Type:application/x-www-form-urlencoded
3.3 请求参数
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
gift_id | int | 11 | 礼包ID | 是 |
gift_type | int | 1 | 礼包类型,1全服定制礼包 2角色定制礼包 | 是 |
3.4 返回参数
- 响应示例:
{
"status":1,
"msg":"success",
"data":{
}
}
4. 获取礼包背景列表
4.1 说明
- 运用于 GM系统-操作工具-定制礼包管理-添加或修改全服礼包&角色礼包-礼包背景
4.2 请求方式
- GET
4.3 请求参数
- 仅需基础请求参数即可
4.4 返回参数
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
id | string | 11 | 礼包背景id | 是 |
name | string | 50 | 礼包背景名称 | 是 |
- 响应示例:
{
"status":1,
"msg":"success",
"data":[
{
"id":"1",
"name":"banner1"
},
{
"id":"2",
"name":"banner2"
}
]
}
5. 网页直充创建订单
5.1 说明
- 玩家网页直充时,中台通过此接口直接向游戏服务端创建订单
- 需对传入参数需要做基本校验,例如:商品ID和金额是否一致、是否停服
- 注意:针对网页直充支付回调扩展参数额外新增两个参数goods_ext(商品扩展参数)、callback_ext(创建游戏订单扩展参数)
{"pay_sign_type":"md5","os":"windows","callback_ext":"","goods_ext":""}
5.2 请求方式
- POST
- Content-Type:application/x-www-form-urlencoded
5.3 请求参数
参数名 | 类型 | 长度 | 说明 | 是否必传 |
---|---|---|---|---|
server_id | string | 32 | 区服ID | 是 |
channel_id | string | 32 | 渠道ID | 是 |
goods_id | string | 50 | 商品ID | 是 |
pay_amount | int | 11 | 支付金额(单位:分) | 是 |
open_id | string | 32 | 用户OpenID | 是 |
pid | string | 32 | 角色ID | 是 |
level | int | 11 | 角色等级 | 是 |
vip_level | int | 11 | vip等级 | 是 |
5.4 返回参数
字段名 | 类型 | 说明 |
---|---|---|
game_order_id | string | 游戏订单ID |
callback_ext | string | 游戏透传参数,支付回调游戏服务端会合并到notify_ext参数里回传,例如:{"notify_ext":{"callback_ext":""}} |
- 响应示例:
{
"status":1,
"msg":"success",
"data":{
"game_order_id":"2023111011124011111",
"callback_ext":""
}
}