概述

修订记录

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

全局说明

  1. 系统使用手册 ，了解功能的使用、配置和某个功能依赖哪些GM接口

  2. GM接口需要接入方按照此文档开发出对应的接口，并在“对接中心->GM接口管理”将接口配置好，便可在“GM系统”使用标准化的GM工具

  3. 接口IP白名单限制：前往“对接中心-GM接口管理”查看来源IP列表，在使用GM接口时，会从这些服务器发起请求到接入方服务器，请把以下IP加入到接入方IP白名单，以确保收到合法请求
    file

  4. 所有的GM接口（星云调用接入方）使用App Key签名规则

    • 所有GM接口请求时会带上ts和sig这2个签名参数，get请求放在url中，post放在body中，需要对sig参数进行校验，ts也可自行进行校验，比如设置有效期为5分钟内等策略。后面请求参数就不再赘述这2个参数。这2个参数也不需要在“对接中心-GM接口管理”的请求参数中进行配置
    • 参数名 类型 长度 说明 是否必传
      ts int 11 时间戳 是
      sig string 32 签名 是
    • 示例
      file

  5. 编辑"未配置"状态的预置接口时，会默认把游戏服、渠道、道具接口的关联预置接口进行填充（下拉框中）。注：仅针对"未配置"状态的接口生效

请求参数说明

基础说明

  1. "per_page"和"page"用于支持查询结果的分页

  2. "ts"和"sig"字段会在请求gm接口时带上，用于签名校验

  3. 如需要增加请求参数，通用命名尽量统一，使用以下参数示例：

    • 请求参数 命名
      当前分页 page
      每页展示数 per_page
      用户账号唯一标识OpenID open_id
      服务器id sid
      玩家id pid
      渠道id channel_id

  4. 由于目前星云 GM 接口 HTTP POST 请求的 Content-Type 都是 application/x-www-form-urlencoded，所以对于对象、数组、对象数组这类复杂参数，我们需要把它通过 json 的方式处理成字符串来传，比如同步星云游戏服变更信息的请求参数应该是这样的：

    {
"list": "[{\"is_del\":0,\"sid\":\"aaaaaa\",\"name\":\"221121\",\"server_char\":\"集群标识\",\"display_time\":\"2025-10-01 10:00:00\",\"open_time\":\"2025-10-01 10:00:00\",\"channel_id_list\":[\"1\",\"2\"],\"tag\":1,\"use_status\":1,\"maintain_status\":1,\"deploy_status\":1,\"create_time\":\"2025-10-01 10:00:00\",\"update_time\":\"2025-10-01 10:00:00\"},{\"is_del\":0,\"sid\":\"bbbb\",\"name\":\"221121\",\"server_char\":\"集群标识\",\"display_time\":\"2025-10-01 10:00:00\",\"open_time\":\"2025-10-01 10:00:00\",\"channel_id_list\":[\"1\",\"2\"],\"tag\":\"新服\",\"use_status\":1,\"maintain_status\":1,\"deploy_status\":1,\"create_time\":\"2025-10-01 10:00:00\",\"update_time\":\"2025-10-01 10:00:00\"}]"
}

下拉框控件说明

file
这里需要选择下拉框的数据来源，选择包括：星云预置数据源、预置接口、自定义接口。

星云预置数据源
  1. 星云GM系统“游戏服管理”列表：使用“GM系统-操作工具-游戏服管理”维护的游戏服信息
  2. 星云对接中心“渠道配置”列表"：使用“对接中心-渠道打包-渠道配置”的配置完成和启用的渠道
  3. 星云中国大陆发行定制礼包价格列表：包含0、1元、6元、12元、18元、30元、68元、98元、128元、198元、328元、648元
  4. 星云定制礼包持续时长列表：包含3小时、6小时、12小时、24小时、3天、7天
预置/自定义接口

对应接口的 HTTP 请求方式为 GET，返回的结果是列表，列表元素的参数必须包含 id 和 name，分别表示id和名称；如不满足要求，将无法成功配置。

请求参数：

请求参数名 类型 长度 说明 是否必传
ts int 11 时间戳 是
sig string 32 签名 是

请求示例：

http://{HOST}:{PORT}/serverList?ts=1535198961&sig=0bebc8ef5313b9f9b73194e138a6ee50

返回参数：

返回参数名 类型 长度 说明 是否必传
id string 32 id 是
name string 50 名称 是

返回示例：

{
    "status":1,
    "msg":"success",
    "data":[
        {
            "id":"1",
            "name":"区服1"
        },
        {
            "id":"2",
            "name":"区服2"
        }
    ]
}

富文本说明

统一json格式，insert插入内容，attributes对插入内容配置加粗、链接、颜色等。发送富文本公告、发送全服邮件和发送角色邮件会使用到富文本。（注：换行符都是单独一行，不会在文本中）

{
  "version": "v1",
  "ops": [
    { "insert": "普通文本"},
    { "insert": "文本加粗", "attributes": { "bold": true } },
    { "insert": "文本颜色", "attributes": { "color": "#e60000" } },
    { "insert": "超链接", "attributes": { "link": "url地址" } },
    { 
        "insert": "超链接文本加粗和颜色设置组合使用",
        "attributes": { "bold": true, "color": "#e60000","copy":true, "link": "https://nebula.737.com/home3" } 
    },
    { "insert": "n" },
    { "insert": {"image": "https://nebula.737.com/home3/favicon.ico" } }]
}

富文本效果示例：
file

固定参数说明

如果需要增加固定的请求参数，可以在“对接中心-GM接口”的请求参数中配置固定参数。目前不支持在接口的请求参数地址URL?后进行配置。

GET请求

合并固定请求参数（ts、sig）和配置请求参数作为整合请求参数，对整合请求参数进行签名处理，整合请求参数作为最后请求参数（如果是以前有在url配置过固定参数的，也会统一合并）
file
发起的请求是：curl 'https://baidu.com/v1/gm/channelList?type=1&sid=s1&ts=1535198961&sig=0bebc8ef5313b9f9b73194e138a6ee50'

POST请求

合并固定请求参数（ts、sig）和配置请求参数作为整合Body请求参数，然后对整合Body请求参数进行签名处理，整合Body请求参数作为最后Body请求参数，去除请求地址URL?后的固定参数作为最后请求地址（如果是以前有在url配置过固定参数的，也会统一合并）
file
发起的请求是：curl -X POST -d 'type=1&sid=s1&pid=p1&day=1&ts=1535198961&sig=0bebc8ef5313b9f9b73194e138a6ee50' https://baidu.com/v1/gm/forbiddenWords

返回结果说明

  • 所有接口都以json格式返回，包含以下字段：
参数名 说明 是否必传
status 状态，成功填1 ， 失败填其他数字 是
msg 信息，成功填ok，失败填写具体原因 是
data 数据 否
  • 响应示例：
{
    "status":1,
    "msg":"success",
    "data":[
        {
            "id":"1",
            "name":"区服1"
        },
        {
            "id":"2",
            "name":"区服2"
        }
    ]
}

GM接口列表

星云调用接入方

  • 基础信息：获取游戏当前可用的游戏服列表、获取角色信息、同步星云游戏服变更信息、获取游戏当前可用的渠道列表、同步星云游戏服准入白名单
  • 客服相关：同步星云客服工单处理进度
  • 道具相关：获取道具变更明细、获取道具名称列表、道具删除、获取道具变更原因列表
  • 公告相关：发送富文本公告、发送跑马灯公告、删除公告
  • 邮件相关：发送角色邮件、发送全服邮件、撤回邮件
  • 违规封禁：获取玩家聊天内容、获取游戏聊天频道列表、角色禁言、解除角色禁言、角色封停、角色解封、IP封停、IP解封、设备封停、设备解封
  • 充值相关：网页直充创建订单、推送全服礼包、推送角色礼包、撤回礼包、获取礼包背景列表
  • 小游戏专属：获取抖音用户已就绪场景列表

接入方回调星云

  • 回调接口：游戏服变更回调、发送全服邮件回调、发送角色邮件回调、获取渠道列表

App Key签名规则

1 说明

所有星云方请求接入方的GM接口都使用该签名规则

2 获取基础接入参数

在【对接中心->SDK对接->SDK列表】，App ID（请求参数app_id）和App Key（签名密钥）
file

3 签名文档

签名文档

App Secret签名规则

1 说明

所有接入方请求星云的接口都使用该签名规则

2 获取基础接入参数

在【对接中心->SDK对接->SDK列表】，App ID（请求参数app_id）和App Secret（签名密钥）
file

3 签名文档

签名文档

文章目录