回调接口

修订记录

文档版本 更新日期 更新内容
1.0.0 2025.03.13 初始化

回调接口列表

说明

  • 1 下列接口是接入方调用星云的接口，非必接

  • 2 签名使用App Secret签名规则

  • 3 入参的公共参数有

参数名 类型 注释 是否必填
app_id string 星云AppID 是
timestamp int 时间戳 是
sign string 签名 是
sign_type string 签名类型(默认：md5) 是
sign_nonce string 签名随机数(随机数字+字符串共8位) 是
sign_version string 签名版本,默认1.0 是
  • 4 以json格式返回，包含以下字段
参数名 说明 是否必传
status 状态，成功未0 ， 失败为非0 是
message 信息 是
trace_id 追踪id，排查问题用 否
data 数据 否
  • 响应示例：
{
    "trace_id": "d77f7de9bb5dd754b726d2a99c9f4375",
    "status": 0,
    "message": "OK",
    "data": {}
}

1. 游戏服变更回调

1.1 描述
  • 当游戏服务端有服务器变更时，将服务器变更信息通知到星云
  • 根据server_id来识别，如果存在，会更新记录，不存在则插入记录
  • 如果记录is_del为0，便会删掉对应server_id的记录
  • 单次调用接口最多限制1000条服务器信息
1.2 接口地址
1.3 请求方式
  • POST
1.4 请求参数
{
    "list":[
        {
            "is_del":0,
            "sid":"aaaaaa",
            "name":"221121",
            "server_char":"集群标识",
            "display_time":"2023-10-01 10:00:00",
            "open_time":"2023-10-01 10:00:00",
            "channel_id_list":[
                "1",
                "2"
            ],
            "tag":1,
            "use_status":1,
            "maintain_status":1,
            "deploy_status":1,
            "create_time":"2023-10-01 10:00:00",
            "update_time":"2023-10-01 10:00:00"
                 },
        {
            "is_del":0,
            "sid":"bbbb",
            "name":"221121",
            "server_char":"集群标识",
            "display_time":"2023-10-01 10:00:00",
            "open_time":"2023-10-01 10:00:00",
            "channel_id_list":[
                "1",
                "2"
            ],
            "tag":1,
            "use_status":1,
            "maintain_status":1,
            "deploy_status":1,
            "create_time":"2023-10-01 10:00:00",
            "update_time":"2023-10-01 10:00:00"
             }
    ],
    "app_id":"30035",
    "timestamp": 1535198961,
    "sign": "0bebc8ef5313b9f9b73194e138a6ee50",
    "sign_type": "md5",
    "sign_nonce": "0bebc8qq",
    "sign_version": "1.0"
}
参数名 类型 注释 是否必填
app_id string 星云AppID 是
list string 服务器列表，单次最多限制1000条数据 是
list.is_del int 默认0，1表示删除 否
list.sid string 游戏服id 是
list.name string 服务器名称 是
list.server_char string 集群标识 是
list.display_time string 对外展示时间，格式YYYY-MM-DD hh:mm:ss 是
list.open_time string 开服时间，格式YYYY-MM-DD hh:mm:ss 是
list.auto_add_channel int 新增官方渠道时自动追加，0否 1是 是
list.channel_id_list array 渠道id列表 是
list.tag int 标签，1正常 2新服 3爆满 4推荐 是
list.use_status int 使用状态，1启用 2停新 3停用 是
list.maintain_status int 维护状态，1正常 2维护 是
list.deploy_status int 部署状态，1未部署 2变更中 3已部署 是
list.create_time string 创建时间，格式YYYY-MM-DD hh:mm:ss 是
list.update_time string 更新时间，格式YYYY-MM-DD hh:mm:ss 是
timestamp int 时间戳 是
sign string 签名 是
sign_type string 签名类型(默认：md5) 是
sign_nonce string 签名随机数(随机数字+字符串共8位) 是
sign_version string 签名版本,默认1.0 是
1.5 请求成功返回：
{
    "trace_id": "d77f7de9bb5dd754b726d2a99c9f4375",
    "status": 0,
    "message": "OK",
    "data": {}
}

2. 发送全服邮件回调

2.1 描述
  • 当发送全服邮件后，将具体发送结果变更信息回调
2.2 接口地址
2.3 请求方式
  • POST
2.4 请求参数
{
    "app_id": "30035",
    "email_id": "100",
    "email_type": 1,
    "timestamp": 1535198961,
    "list":[
        {"item_id":"aaaa","result":1,"note":""},
        {"item_id":"aaaa","result":2,"note":"服务器ID不存在"}
    ],
    "sign": "0bebc8ef5313b9f9b73194e138a6ee50",
    "sign_type": "md5",
    "sign_nonce": "0bebc8qq",
    "sign_version": "1.0"
}
参数名 类型 注释 是否必填
app_id string 星云AppID 是
email_id string 邮件id 是
email_type int 邮件类型，固定为1，表示全服邮件 是
timestamp int 时间戳 是
list string 发送结果列表 是
list.item_id string 游戏服ID或者渠道ID 是
list.result int 角色发送情况，1成功 2失败 是
list.note string 备注 是
sign string 签名 是
sign_type string 签名类型(默认：md5) 是
sign_nonce string 签名随机数(随机数字+字符串共8位) 是
sign_version string 签名版本,默认1.0 是
2.5 请求成功返回：
{
    "trace_id": "d77f7de9bb5dd754b726d2a99c9f4375",
    "status": 0,
    "message": "OK",
    "data": {}
}

3. 发送角色邮件回调

3.1 描述
  • 当发送角色邮件后，将具体发送结果变更信息回调
3.2 接口地址
3.3 请求方式
  • POST
3.4 请求参数
{
    "app_id": "30035",
    "email_id": "100",
    "email_type": 2,
    "timestamp": 1535198961,
    "list":[
        {"pid":"aaaa","result":1,"note":""},
        {"pid":"aaaa","result":2,"note":"角色ID不存在"}
    ],
    "sign": "0bebc8ef5313b9f9b73194e138a6ee50",
    "sign_type": "md5",
    "sign_nonce": "0bebc8qq",
    "sign_version": "1.0"
}
参数名 类型 注释 是否必填
app_id string 星云AppID 是
email_id string 邮件id 是
email_type int 邮件类型，固定为2，表示角色邮件 是
timestamp int 时间戳 是
list string 发送结果列表 是
list.pid string 角色id 是
list.result int 角色发送情况，1成功 2失败 是
list.note string 备注 是
sign string 签名 是
sign_type string 签名类型(默认：md5) 是
sign_nonce string 签名随机数(随机数字+字符串共8位) 是
sign_version string 签名版本,默认1.0 是
3.5 请求成功返回：
{
    "trace_id": "d77f7de9bb5dd754b726d2a99c9f4375",
    "status": 0,
    "message": "OK",
    "data": {}
}

4. 获取渠道列表

4.1 描述
  • 获取对接中心-渠道配置的渠道列表
4.2 接口地址
4.3 请求方式
  • POST
4.4 请求参数
{
    "app_id": "30035",
    "timestamp": 1535198961,
    "sign": "0bebc8ef5313b9f9b73194e138a6ee50",
    "sign_type": "md5",
    "sign_nonce": "0bebc8qq",
    "sign_version": "1.0"
}
参数名 类型 注释 是否必填
app_id string 星云AppID 是
timestamp int 时间戳 是
sign string 签名 是
sign_type string 签名类型(默认：md5) 是
sign_nonce string 签名随机数(随机数字+字符串共8位) 是
sign_version string 签名版本,默认1.0 是
4.5 请求成功返回：
{
    "trace_id": "d77f7de9bb5dd754b726d2a99c9f4375",
    "status": 0,
    "message": "OK",
    "data": [
        {"channel_id":1,"channel_name":"xxxx","is_official":1},
        {"channel_id":2,"channel_name":"xxxx","is_official":0}
    ]
}
参数名 类型 注释 是否必填
status int 状态码 是
message string 消息 是
data array 数据 是
data.channel_id int 渠道id 是
data.channel_name string 渠道名称 是
data.is_official int 是否官方，1官方 0三方 是
文章目录