1 统一GMT接入[必读]
2 角色基础功能接入
3 邮件功能接入
4 滚动公告功能接入
- 4.1 滚动公告通知接口
- 4.2 滚动公告取消接口
5 信息审查功能接入
6 游戏服列表功能接入
7 GM指令功能接入
- 7.1 角色指令通知接口
- 7.2 游戏服指令通知接口
8 游戏内开关功能接入
- 8.1 游戏内入口开关通知接口
- 8.2 获取游戏内入口开关接口
9 游戏排行榜功能接入
- 9.1 游戏服-游戏服排行获取榜接口
10调查问卷接口
11 模拟充值
- 11.1 模拟充值-充值礼包编码查询接口
- 11.2 模拟充值-发货扩展参数查询
12 联盟工会接口
13 其他接口
附1 详细返回码定义
附2 地域编码定义 localeId
附3 统一GMT服务域名及IP
附4 多语言国际化标识
附5 大区编码列表
附6 云上曲率返回码详细介绍

1 统一GMT接入[必读]

我要看原文档
新文档主要对接口进行重新分组，方便按功能查询接口

1.1 接入说明

该部分接口需要统一GMT平台和研发同学共同按照接口规范实现，用以满足统一GMT平台的各项GM功能，其中标记游戏服提供和大区中心服提供部分需要研发同学实现，由统一GMT平台调用，标记平台提供部分由统一GMT平台实现，开放给研发同学进行调用。
注意1：平台提供的所有GMT接口，只允许研发服务端进行调用（不得在客户端直接调用GMT范畴内的任何接口）；研发提供的GMT功能接口，也只会在平台GMT服务器端调用，不会再SDK内直接调用；
注意2：游戏服提供的接口会通知到具体游戏服的GM地址上， 大区中心服提供的接口会通知到大区中心服地址上（如推荐服设置）。
注意3：GMT相关接口接入时需要兼容后续新增字段的情况，一般情况新增字段是为了扩充新需求，若需要使用新增的字段需要接入方进行解析新增字段，若不需要使用，则无需解析新增字段，但是要确保新增字段不会导致数据解析失败；若删除或调整字段含义会通知现有已经接入的线上产品，若新增字段则不会进行全部产品通知

1.2 名词解释

gameServerGMTUrl 研发提供的游戏服GM地址，由运营人员配置到平台GSC的游戏服管理中，如：http://gmt.demo.cn:8080/gmt 该地址由研发自定义，确保端口通畅即可；为了便于研发同学根据不同的GMT服务或不同的游戏服进行请求转发，平台在请求改地址时会追加serverId和service两个固定参数，比如:http://gmt.demo.cn:8080/gmt?service=roleInfo.query&serverId=1001
注意：平台为了兼容个别产品不支持问号后参数的问题，请求URL同时支持把参数放到URL前面的路径中，此时GSC上应配置:http://gmt.demo.cn:8080/{service} 平台请求时会直接替换,如： http://gmt.demo.cn:8080/gmt/roleInfo.query?serverId=1001
regionServerGMTUrl 研发提供的大区中心服的GM地址，由运营人员配置到平台GSC的大区管理中，如：http://gmt.demo.cn:8080/region 该地址由研发自定义，确保端口通畅即可；平台在请求改地址时会追加regionId和service两个固定参数，比如:http://gmt.demo.cn:8080/region?service=roleInfo.query&regionId=1001
注意：平台为了兼容个别产品不支持问号后参数的问题，请求URL同时支持把参数放到URL前面的路径中，此时GSC上应配置:http://gmt.demo.cn:8080/region/{service} 平台请求时会直接替换,如： http://gmt.demo.cn:8080/region/roleInfo.query?regionId=1001
平台GMT域名 访问平台提供的接口时的域名，详见附3
serverId 标识游戏服ID，需要提前录入到GSC平台的游戏服管理中
service 标识不同的GMT服务，如：roleInfo.query
regionId 标识平台定义的大区ID

1.3 请求头及编码规则

请求数据以JSON格式通过POST进行提交，请注意Header头中Content-Type的值为application/json。返回数据为标准JSON格式，返回的Header头中Content-Type的值也必须为application/json。字符编码均采用 UTF-8

1.4 校验码规则介绍（V3 版本）

新产品接入直接使用V3版本校验码规则，目前在接入的产品和已经上线的产品，平台将会继续支持原有校验码规则；原有校验码规则详见校验码V1

1.4.1 校验码 V3版主要更新点

在Header头中增加协商秘钥的key，旨在解决在线更换秘钥的问题
校验码计算规则改成body体中所有数据加上秘钥进行MD5Hash，解决接口协议参数变更带来的秘钥验证问题

1.4.2 Header介绍

platform-auth-version:固定写死 v3
platform-auth-timestamp:服务器时间戳，毫秒数
platform-auth-key-id:秘钥keyId，GMT接入时传 gameId 如2000003401，注意：校秘钥keyId和秘钥是一一对应，秘钥keyId在header中传递，秘钥需要配置在游戏服务端，用来进行校验码计算，秘钥keyId和秘钥需要找技术支持人员获取；
platform-auth-checksum:请求数据计算后的校验码

1.4.3 校验码原理及作用

校验码即 checkSum 是为了防止双方通信过程中交换的数据被篡改以及数据合法来源的一种通用校验方式。由交换数据双方按照某种规则组装生成请求明文数据，然后追加上当前时间戳和双方协商好的秘钥[需要线下通过技术支持人员获取] ，生成校验码明文，再通过对明文进行散列值计算获取到数据指纹即校验码，请求方把时间戳、校验码版本号、秘钥ID以及校验码放到Header头中发送给服务方，服务方获取后再次按照相同进行计算数据指纹，通过比较自己生成和请求方传递过来得数据指纹是否一致来确定数据是否合法。

散列值计算
校验码散列值算法：MD5，注意取32位md5，并转小写。

1.4.4 示例

请求body中的json如下

{"yyyymm":"202008","localeId":"01"}

假设秘钥key-id(秘钥ID)为2000003401，当前的毫秒时间戳为:1600422195516, key(秘钥)为:eea2e42511c3294d47b4d2deaf4ea33c
组装后的校验码明文串如下（注意原始数据和时间戳以及密码key之间通过&符号连接）：

{"yyyymm":"202008","localeId":"01"}&1600422195516&eea2e42511c3294d47b4d2deaf4ea33c

生成校验码如下

be6f17515783ae719710fd195461f377

注意：此时该请求的header头的四个校验码相关的header值如下

platform-auth-version:v3
platform-auth-timestamp:1600422195516
platform-auth-key-id:2000003401
platform-auth-checksum:be6f17515783ae719710fd195461f377

2 角色基础功能接入

2.1 角色详细信息查询

基本信息

游戏服提供 新的见2.2.1和2.1.2
Path： /gameServerGMTUrl?service=roleInfo.query&serverId=serverId
Method： POST
接口描述：

该接口主要是满足统一GMT平台提供角色详细信息查询，包括但不限于角色名、等级、钻石、金币，具体可提供哪些属性信息查询展示需要运营同学在接入之初根据 GMT角色道具定义模板该文档进行录入，并导入至GSC平台，后续平台也会提供在线增删部分属性的功能界面。注意：以下属性由GMT平台定义，研发需按照规则定义标识和名称，不可修改；其他可以由研发自定义标识和名称：

属性名称	属性标识
角色ID	role_id
角色名称	role_name
游戏服ID	role_server_id
角色等级	role_level
VIP等级	role_vip_level
平台用户ID	platform_user_id

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询角色信息;固定为:roleInfo.query
serverId	string	必须	平台配置的游戏服Id;如：10001
roleId	string	必须	角色Id；
propertyType	string	必须	平台属性类型 [0 平台统一属性] [1 游戏自定义属性]；该字段研发可以忽略，以category进行分类查询返回即可；
category	string	必须	查询标识；`basic 标识基础属性`，其他默认为道具分类标识，标识查询该分类下角色持有的所有数量非0道具列表或查询指定某几个道具的持有数量；若产品有特殊需求需要按道具存放的位置（背包、交易场、已穿戴等）查询，需要联系技术支持进行添加，添加后该字段将传指定位置的标识，研发同学返回该位置下角色持有的所有数量非0的道具列表。
gets	string	必须	获取指定的角色信息，获取多种信息时用英文逗号隔开;具体支持哪些信息获取，GMT接入时按平台提供的表格进行录入，然后导入到平台上；注意：请支持该字段传`ALL`时，应返回该分类（或该位置）下的所有道具数量不为零的列表功能，主要是解决单个分类下道具数量过多，平台循环调用时游戏服压力比较大的情况；
transactionId	string	必须	请求ID，每次请求都不一样；如：0dbaff98a230282da164b12b122c4cc4；该参数已废弃

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object[]	非必须	属性列表	item类型:object
├─key	string	必须	属性key
├─value	string	必须	属性值
├─name	string	必须	属性名称，平台用来辅助显示
├─supportSubProperty	string	必须	是否支持二级属性；该属性是否根据不同的二级属性区分不同道具；不支持为0；支持为1；

2.2 角色信息修改接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=roleInfo.modify&serverId=serverId

Method： POST

接口描述：

该接口主要提供部分角色属性和道具修改功能，具体哪些属性或道具可以修改，平台按照导入的GMT角色属性和道具时定义的模板进行设置。参数中的type解释如下：

1：改变成；标识由一个值改为另一个值；若不支持返回修改失败

2：增加；标识在原有值上增加指定的数量；若不支持返回修改失败

3：减少标识在原有值上减少指定的数量若不支持返回修改失败

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:roleInfo.modify
serverId	string	必须	平台配置的游戏服Id
roleId	string	必须	角色Id
propertyType	string	必须	1：修改属性；2：修改道具
key	string	必须	修改的属性key
value	string	必须	本次修改值，具体处理参见type定义
type	string	必须	1：改变成； 2：增加； 3：减少

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

2.3 角色封禁踢人接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=roleInfo.ban&serverId=serverId

Method： POST

接口描述：
该接口主要提供GMT对指定角色进行封停、禁言、解封、解禁、以及主动踢人下线等功能；注意：针对封停，如果当前玩家在线，需要实现同时踢下线的功能；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来操作角色的封停、禁言、解封、解禁；固定为:roleInfo.ban
serverId	string	必须	平台配置的游戏服Id
roleId	string	必须	角色Id
action	string	必须	类型：1：封停；-1：解封；2：禁言；-2：解禁；3：踢人下线
time	long	必须	当action为封停或禁言时，标识封停到或禁言到什么时间；精确到毫秒的时间戳；永久封停或永久禁言传递的固定的时间戳(2147454847000 : 2038-01-19)；注意：action是解封、解禁、踢人下线时需要实时生效，无需关心该字段；
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

2.4 用户角色查询接口

基本信息

游戏提供
Path： /gameServerGMTUrl?service=userRoleInfo.query&serverId=serverId&regionId=regionId&serviceId=serviceId

Method： POST

接口描述：
该接口主要是满足统一GMT平台提供用户的角色列表查询。注意serverId和regionId以及serviceId三个参数同一次请求只会传其中一个，传serverId时标识查询该用户在该游戏服下的角色列表，传regionId时标识查询该用户在该大区下的角色列表，传serviceId标识查询某个平台包下角色列表。注意：以regionId或serviceId查询时，地址取自大区上配置的地址；该接口主要应用于游戏外渠道礼包发放、游戏外社区礼包兑换场景

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询角色信息;固定为:userRoleInfo.query
serverId	string	可选	平台配置的游戏服Id;如：10001
regionId	string	可选	大区ID;如：113标识官方，大区编码定义见`附5`
serviceId	string	可选	产品平台ID；如何获取产品平台ID，参见SDK接入文档中`11.2 获取平台ID`
userId	string	必须	用户Id；
transactionId	string	必须	请求ID，每次请求都不一样；如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃
extendParams	string	可选	透传参数

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object[]	非必须	角色列表	item类型:object
├─roleId	string	必须	角色id
├─roleName	string	必须	角色名称
├─serverId	string	必须	游戏服id
├─serverName	string	必须	游戏服名称
├─roleLevel	string	选填	角色等级
├─roleVipLevel	string	选填	角色vip等级
├─registerTime	long	选填	角色注册时间
├─lastLoginTime	long	选填	角色最后登陆时间

2.5 角色道具属性信息查询

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=roleInfo.prop.query&serverId=serverId

Method： POST

接口描述：
该接口主要是满足统一GMT平台提供角色道具属性信息查询；当属性存在二级属性时会掉用此接口查询属性道具列表以及道具拥有的二级属性信息列表。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询角色道具属性信息;固定为:roleInfo.prop.query
serverId	string	必须	平台配置的游戏服Id;如：10001
roleId	string	必须	角色Id；
propertyKey	string	必须	属性标识
category	string	必须	分类标识
propertyType	string	必须	平台属性类型 [0 平台统一属性] [1 游戏自定义属性]；

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object[]	非必须	道具信息列表	item类型:object
├─propertyItemKey	string	必须	道具标识；属性按照不同的二级属性区分后可能有多个不同的二级属性的道具；该标识为区分后道具的标识；后续对该道具进行其他操作时会使用到该信息；
├─propertyItemName	string	必须	道具名称
├─propertyItemData	object[]	必须	道具拥有的二级属性信息列表
├─subPropertyKey	string	必须	二级属性key
├─subPropertyName	string	必须	二级属性名称
├─subPropertyValue	string	必须	二级属性值

2.6 角色道具属性信息修改

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=roleInfo.prop.modify&serverId=serverId

Method： POST

接口描述：
该接口主要是满足统一GMT平台提供角色道具属性信息修改；当属性存在二级属性时会掉用此接口修改属性道具拥有的二级属性信息。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询角色道具属性信息;固定为:roleInfo.prop.modify
serverId	string	必须	平台配置的游戏服Id;如：10001
roleId	string	必须	角色Id；
propertyKey	string	必须	属性标识
category	string	必须	分类标识
propertyType	string	必须	平台属性类型 [0 平台统一属性] [1 游戏自定义属性]；
subPropertyKey	string	必须	二级属性标识
propertyItemKey	string	必须	道具标识
value	string	必须	本次修改值，具体处理参见type定义
type	string	必须	1：改变成；2：增加；3：减少
timestamp	long	必须	发起修改操作的时间戳；精确到毫秒；1521452724853

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

2.7 角色道具信息删除

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=roleInfo.prop.delete&serverId=serverId

Method： POST

接口描述：
该接口主要是满足统一GMT平台提供角色道具删除；当属性存在二级属性时会掉用此接口删除某个拥有二级属性的道具。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询角色道具属性信息;固定为:roleInfo.prop.delete
serverId	string	必须	平台配置的游戏服Id;如：10001
roleId	string	必须	角色Id；
propertyKey	string	必须	属性标识
category	string	必须	分类标识
propertyType	string	必须	平台属性类型 [0 平台统一属性] [1 游戏自定义属性]；
propertyItemKey	string	必须	道具标识
timestamp	long	必须	发起删除操作的时间戳；精确到毫秒；1521452724853

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

2.8 平台提供角色封禁踢人接口

基本信息

平台提供
Path： https://{平台GMT域名}/api/gmt/outer/role/ban.htm

Method： POST

接口描述：
该接口主要用来游戏向GMT发起封禁踢人操作；以便在GSC中可以查看封禁踢人记录；需求来自魂斗罗（游戏服内主动封停时需要体现在GSC上）

注意：该接口接入前需要预先接入2.3 角色封禁踢人接口，如果未接入2.3 角色封禁踢人接口，该接口将无法进行操作；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
action	string	必须	操作类型：1：封停；-1：解封；2：禁言（聊天）；-2：解禁（聊天）；3：踢人下线；4：朋友圈禁言；-4：朋友圈解禁；
time	string	非必须	限制时间；当action为封停或禁言时，标识封停到或禁言到什么时间；精确到毫秒的时间戳；注意：当action是解封、解禁（聊天）、踢人下线、朋友圈解禁时，该字段为空即可；
reason	string	必须	限制原因
roleDataList	object[]	必须	角色列表	item类型:object
├─userId	string	必须	平台用户id
├─roleId	string	必须	角色id
├─serverId	string	必须	游戏服id

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

3 邮件功能接入

邮件内容标签功能，角色邮件、全服邮件、事件邮件都支持邮件内容标签

邮件内容标签：邮件内容标签的作用是用来在邮件正文中触发自定义事件，比如打开指定的调查问卷；
标签可能出现的位置：邮件正文中的任何位置都可能出现，标题中不支持自定义标签
如何触发标签事件：用户单击标签展示的内容即可触发
标签事件触发后的效果：平台不制定具体触发效果，由运营同学与研发共同商定每种标签触发后的效果
标签格式：<tag><text>显示信息</text><type>标签类型</type><value>标签携带信息</value></tag>
其中 显示信息、标签类型、标签携带信息 是动态填充项，其他的是固定信息，建议通过正则进行提取这三个动态信息
显示信息：整个标签对用户展示的内容
标签类型：区分不同作用的标签
标签携带信息：标签携带的具体信息，结合标签类型完成特定的功能
样例：
<tag><text>点击打开调查问卷</text><type>question</type><value>123456</value></tag>
注意：若邮件正文中出现了不支持的标签类型，需要忽略整个标签，不得对用户进行展示

标签类型定义如下：

标签类型	标签携带信息	描述
question	某个GSC上调查问卷的ID	打开指定的调查问卷；参见SDK接口`问卷调查打开【选接】`
webview	网页链接地址(https)	使用内置webview打开该网页地址
browser	网页链接地址(https)	使用系统浏览器打开该网页地址
activityLink	某个GSC上外链ID	打开指定活动外链；参见SDK接口`打开游戏内外链(活动详情)【选接】`

3.1 角色邮件通知接口-按角色Id

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=mail.notify.roleIds&serverId=serverId

Method： POST

接口描述：
该接口主要实现按角色ID列表进行推送普通邮件的功能。

对于发送超时或因网络原因出现发送失败时，平台提供自动重发机制，自动重发机制为在失败后，延后指定时间进行重发（第一次失败后延后30秒进行第二次重发， 第二次失败后延后10分钟， 第三次失败后延后2小时， 第四次失败后延后12小时），超过四次失败，将不再自动重发；但是可以通过GSC上邮件推送记录进行手动重发；
1， 若非连接超时或网络问题，平台不会进行重发；此时需要研发同学配合定位问题，问题解决后由GSC平台进行手动重发；
2， 为了防止因网络问题导致出现：游戏服正常接收该mailId，但是平台因网络问题未收到返回，当平台再次重发（自动或手动）时游戏服需要根据mailId进行重复性判断，防止邮件重发至用户手中；  mailId可以用来做唯一性判断；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表按角色Id进行推送邮件;固定为:mail.notify.roleIds
serverId	string	必须	平台配置的游戏服Id
source	string	必须	邮件产生的来源，默认是gsc；gsc:由GSC操作人员创建邮件；activity-p_re_deliver:由GSC补单产生的通知邮件；activity-xxxxx活动触发的邮件发送（其中xxxx为具体的活动编码）; inner_test_account_mail：内部福利号邮件；
roleIds	string	必须	角色Id列表，多个roleIds时用英文逗号隔开;如：100,101,102,103
mailId	string	必须	邮件唯一标识；用来区分每一个邮件发送任务；如：20190917145655776；不定长，最长不超过32位；
subject	string	必须	邮件主题信息
author	string	必须	作者
content	string	必须	邮件详细内容
contentType	string	必须	text:文本；html:富文本
startTime	long	必须	邮件开始发送时间；精确到毫秒的时间戳；如：1521452724853；
endTime	long	必须	邮件停止发送时间；精确到毫秒的时间戳；如：1521452724853；
attachmentInvalidType	string	选填	邮件附件失效类型；1：邮件附件失效时间类型（邮件附件失效时间不为空） 2：邮件附件失效周期类型（邮件附件失效周期不为空）
attachmentInvalidPeriod	number	选填	邮件附件失效周期；单位：天；如：7；表示收到邮件7天后失效；长期有效为-1
attachmentInvalidTime	long	选填	邮件附件失效时间；精确到毫秒的时间戳；如：1521452724853；长期有效为-1
attachments	string	选填	道具附件；多个道具由英文逗号隔开，格式：propId=number,propId=number如：1001=2,1002=10标识1001道具发放2个，1002道具发放10个
i18nInfoList	object []	必须	多语言信息列表,解决发行多语言版本的国际化问题	item 类型: object
├─ i18nCode	string	必须	国际化语言标识；如:zh_CN；详见“附录4”
├─ i18nInfo	object	必须
├─ subject	string	必须	主题的国际化信息
├─ author	string	必须	作者的国际化信息
├─ content	string	必须	邮件内容的国际化信息
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

3.2 游戏服邮件通知接口-按游戏服通知

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=mail.notify.server&serverId=serverId

Method： POST

接口描述：
该接口主要实现推送全服邮件，或按照限定的角色等级、VIP等级进行邮件推送。

对于发送超时或因网络原因出现发送失败时，平台提供自动重发机制，自动重发机制为在失败后，延后指定时间进行重发（第一次失败后延后30秒进行第二次重发， 第二次失败后延后10分钟， 第三次失败后延后2小时， 第四次失败后延后12小时），超过四次失败，将不再自动重发；但是可以通过GSC上邮件推送记录进行手动重发；
1， 若非连接超时或网络问题，平台不会进行重发；此时需要研发同学配合定位问题，问题解决后由GSC平台进行手动重发；
2， 为了防止因网络问题导致出现：游戏服正常接收该mailId，但是平台因网络问题未收到返回，当平台再次重发（自动或手动）时游戏服需要根据mailId进行重复性判断，防止邮件重发至用户手中；  mailId可以用来做唯一性判断；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表按游戏服进行推送邮件；固定为:mail.notify.server
serverId	string	必须	平台配置的游戏服Id
serviceIds	string	必须	产品平台ID,支持多个；若无此限制则为空字符串；格式如：产品平台ID1,产品平台ID2,产品平台ID3… 查看如何从SDK中获取
source	string	必须	邮件产生的来源，gsc：GSC后台配置发送的邮件；activity-xxxx:活动触发的邮件发送（其中xxxx为具体活动Id）
roleLevel	string	必须	角色等级范围；符合该等级范围的角色发送该邮件；若无此限制则为空字符串；格式如：0-50标识从0级到50级，包含0级也包含50级
roleVipLevel	string	必须	角色VIP等级范围；符合该VIP等级范围的角色发送该邮件；若无此限制则为空字符串；格式如：10-100标识从10级到100级，包含10级也包含100级
roleRegStartTime	long	必须	角色注册时间开始时间；精确到毫秒的时间戳；如：1521452724853；用来限制只有在角色注册时间开始-角色注册时间结束时间段内注册的角色才可以接收到邮件；
roleRegEndTime	long	必须	角色注册时间结束时间；精确到毫秒的时间戳；如：1521452724853；
mailId	string	必须	邮件唯一标识；用来区分每一个邮件发送任务；；不定长，最长不超过32位；
subject	string	必须	邮件主题信息
author	string	必须	作者
content	string	必须	邮件详细内容
contentType	string	必须	text:文本；html:富文本
startTime	long	必须	邮件开始发送时间；精确到毫秒的时间戳；如：1521452724853；
endTime	long	必须	邮件停止发送时间；精确到毫秒的时间戳；如：1521452724853；
attachmentInvalidType	string	选填	邮件附件失效类型；1：邮件附件失效时间类型（邮件附件失效时间不为空） 2：邮件附件失效周期类型（邮件附件失效周期不为空）
attachmentInvalidPeriod	number	选填	邮件附件失效周期；单位：天；如：7；表示收到邮件7天后失效；长期有效为-1
attachmentInvalidTime	long	选填	邮件附件失效时间；精确到毫秒的时间戳；如：1521452724853；长期有效为-1
attachments	string	选填	道具附件；多个道具由英文逗号隔开，格式：propId=number,propId=number如：1001=2,1002=10标识1001道具发放2个，1002道具发放10个
i18nInfoList	object []	必须	多语言信息列表,解决发行多语言版本的国际化问题	item 类型: object
├─ i18nCode	string	必须	国际化语言标识；如:zh_CN；详见“附录4”
├─ i18nInfo	object	必须
├─ subject	string	必须	主题的国际化信息
├─ author	string	必须	作者的国际化信息
├─ content	string	必须	邮件内容的国际化信息
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

3.3 事件邮件通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=mail.notify.event&serverId=serverId

Method： POST

接口描述：
该接口主要提供创建用户事件邮件，主要满足当角色发生某些事件时由游戏服自动推送提前配置好的邮件给用户；目前仅支持角色注册事件。

对于发送超时或因网络原因出现发送失败时，平台提供自动重发机制，自动重发机制为在失败后，延后指定时间进行重发（第一次失败后延后30秒进行第二次重发， 第二次失败后延后10分钟， 第三次失败后延后2小时， 第四次失败后延后12小时），超过四次失败，将不再自动重发；但是可以通过GSC上邮件推送记录进行手动重发；
1， 若非连接超时或网络问题，平台不会进行重发；此时需要研发同学配合定位问题，问题解决后由GSC平台进行手动重发；
2， 为了防止因网络问题导致出现：游戏服正常接收该mailId，但是平台因网络问题未收到返回，当平台再次重发（自动或手动）时游戏服需要根据mailId进行重复性判断，防止邮件重发至用户手中；  mailId可以用来做唯一性判断；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表按指定事件推送邮件；固定为:mail.notify.event
serverId	string	必须	平台配置的游戏服Id
event	string	必须	事件类型；register：注册事件
mailId	string	必须	邮件唯一标识；用来区分每一个邮件发送任务；；不定长，最长不超过32位；
subject	string	必须	邮件主题信息
author	string	必须	作者
content	string	必须	邮件详细内容
contentType	string	必须	text:文本；html:富文本
startTime	long	必须	邮件开始发送时间；精确到毫秒的时间戳；如：1521452724853；
endTime	long	必须	邮件停止发送时间；精确到毫秒的时间戳；如：1521452724853；
attachmentInvalidType	string	选填	邮件附件失效类型；1：邮件附件失效时间类型（邮件附件失效时间不为空） 2：邮件附件失效周期类型（邮件附件失效周期不为空）
attachmentInvalidPeriod	number	选填	邮件附件失效周期；单位：天；如：7；表示周期为7天；长期有效为-1
attachmentInvalidTime	long	选填	邮件附件失效时间；精确到毫秒的时间戳；如：1521452724853；长期有效为-1
attachments	string	选填	道具附件；多个道具由英文逗号隔开，格式：propId=number,propId=number如：1001=2,1002=10标识1001道具发放2个，1002道具发放10个
i18nInfoList	object []	必须	多语言信息列表,解决发行多语言版本的国际化问题	item 类型: object
├─ i18nCode	string	必须	国际化语言标识；如:zh_CN；详见“附录4”
├─ i18nInfo	object	必须
├─ subject	string	必须	主题的国际化信息
├─ author	string	必须	作者的国际化信息
├─ content	string	必须	邮件内容的国际化信息
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

3.4 邮件取消接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=mail.cancel&serverId=serverId

Method： POST

接口描述：
该接口主要实现取消已创建的邮件，注意：cancelRoleBox为0时，只需要保证不再给未收到的角色继续推送了；cancelRoleBox为1时，保证不再给未收到的角色继续推送时，还需要清理角色已经收到的该邮件；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表取消指定的邮件；固定为:mail.cancel
serverId	string	必须	平台配置的游戏服Id
mailId	string	必须	邮件唯一标识；用来区分每一个邮件发送任务；不定长，最长不超过32位；
mailType	string	必须	common:普通邮件；event：事件邮件
cancelRoleBox	string	必须	是否清除用户已经收到的该邮件；1：是；0：否
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

4 滚动公告功能接入

4.1 滚动公告通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=notice.notify.rolling&serverId=serverId

Method： POST

接口描述：
该接口用来通知游戏服滚动公告的创建；

对于发送超时或因网络原因出现发送失败时，平台提供自动重发机制，自动重发机制为在失败后，延后指定时间进行重发（第一次失败后延后30秒进行第二次重发， 第二次失败后延后10分钟， 第三次失败后延后2小时， 第四次失败后延后12小时），超过四次失败，将不再自动重发；但是可以通过GSC上邮件推送记录进行手动重发；
1， 若非连接超时或网络问题，平台不会进行重发；此时需要研发同学配合定位问题，问题解决后由GSC平台进行手动重发；
2， 为了防止因网络问题导致出现：游戏服正常接收该 noticeId，但是平台因网络问题未收到返回，当平台再次重发（自动或手动）时游戏服需要根据 noticeId 进行重复性判断，防止邮件重发至用户手中；  noticeId 可以用来做唯一性判断；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表滚动公告；固定为:notice.notify.rolling
serverId	string	必须	平台配置的游戏服Id
serviceIds	string	必须	产品平台ID,支持多个；若无此限制则为空字符串；格式如：产品平台ID1,产品平台ID2,产品平台ID3… 查看如何从SDK中获取
noticeId	string	必须	公告唯一标识；用来区分每一个公告的发送任务；
startTime	long	必须	生效开始时间；精确到毫秒时间戳；立即生效为-1
endTime	long	必须	生效结束时间；精确到毫秒时间戳
interval	int	必须	间隔时间；单位：秒；如20标识20秒播放一次
content	string	必须	详细内容；文本类型
i18nInfoList	object []	必须	多语言信息列表,解决发行多语言版本的国际化问题	item 类型: object
├─ i18nCode	string	必须	国际化语言标识；如:zh_CN；详见“附录4”
├─ i18nInfo	object	必须
├─ content	string	必须	内容的国际化信息
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

4.2 滚动公告取消接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=notice.cancel&serverId=serverId

Method： POST

接口描述：
该接口主要实现GMT主动取消已发送的滚动公告，包括已经开始在用户终端展示的滚动公告。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表取消指定的公告；固定为:notice.cancel
serverId	string	必须	平台配置的游戏服Id
noticeId	string	必须	公告唯一标识；用来区分每一个公告；
noticeType	string	必须	rolling:滚动公告；
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

5 信息审查功能接入

5.1 平台内容审查-文本图片语音视频

基本信息

Path： /api/audit/outer/message/audit.htm

Method： POST

接口描述：
平台提供
该接口主要用来对内容（文本、图片、语音、视频）进行审查；若同一条消息中包含多种类型的内容，则需要使用5.2的图文混合内容审查接口；
该接口一般会根据发行地域不同调用不同的第三方内容安全平台实现，若想了解现在使用第三方平台的情况，需要联系技术支持；
审查结果分：实时返回和异步返回两种情况；文本审查会实时返回审核结果，其他类型的内容会通过5.3的结果异步通知接口返回；但是，所有内容都有可能会涉及人工抽查，即文本内容审查，如果开启了人工审查策略，在人工抽查结束后，也会产生结果异步通知的回调，所以callbackUrl是必填项。
如：
文本消息A，会实时返回A-result，若此时结果为不通过，则不可以对外展示，若为通过则可以对外展示，但当人工抽查发现其含有违规内容后，会通过异步通知接口通知游戏服该条不通过，此时需要游戏服对该消息再次进行处理，不得再对外展示；
同一条消息的产生多次异步结果通知，以最后一次为准。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
messageId	string	必须	消息ID 至少在游戏服内唯一（50个字符以内）；异步审查结果以及消息删除会以该ID同步游戏服
type	string	必须	类型，chat:聊天消息； roleName：角色名称； teamName：团队名称；moments：朋友圈动态；other：其他；请务必正确传递该类型，该类型可能会影响第三方平台的审核策略；若目前类型定义不满足，请找平台技术支持人员确认
messageType	string	必须	消息内容类型，text:文本； voice：语音； image：图片；video：视频
messageContext	string	必须	messageType为text时为文本内容； messageType为voice时为语音文件的http访问地址； messageType为image时为图片文件的http访问地址； messageType为video时为视频文件的http访问地址；
userId	string	必须	平台用户ID
serverId	string	必须	游戏服ID
roleId	string	必须	角色ID
roleName	string	必须	角色名称
level	string	非必须	角色等级
vipLevel	string	非必须	角色VIP等级
messageChannel	string	非必须	消息频道；没有可为空
receiveServerId	string	非必须	群发消息传空即可；主要用于两个跨服玩家之间的聊天信息时，标识消息接收角色的游戏服ID
receiveRoleId	string	非必须	群发消息传空即可；主要用于两个玩家之间的聊天信息时，标识消息接收角色ID
receiveRoleName	string	非必须	群发消息传空即可；主要用于两个玩家之间的聊天信息时，标识消息接收角色名称
callbackUrl	string	必须	游戏服提供异步回调接口地址；必填；回调接口规范5.3接口
serviceCode	string	必须	来自龙图SDK的API”11.14 获取Servicecode”

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述
data	object	必须	返回具体信息
├─ resultCode	string	必须	实时审核结果; 0:待审核，审核结果通过5.3 结果异步通知接口返回；此时resultInfo为空，无需关注； 1：审核完成；具体结果参见resultInfo；
├─ resultInfo	object	非必须	实时审查结果
├─ messageStatus	string	必须	本条消息审核结果状态：0:审核不通过； 1:审核通过；
├─ messageUpdate	string	必须	0:未替换；1:已替换；对于审核不通过的消息，若可确定本消息所涉及的敏感词时，该消息中的敏感词信息会被替换，替换后的消息在message中返回；当messageStatus为1时，可忽略该字段；注意：并非所有审核不通过的消息都可以用替换敏感词，使用时一定要判断该字段的状态；
├─ message	string	非必须	被修改后的消息

5.2 平台内容审查-图文混合内容审核接口

基本信息

Path： /api/audit/outer/multimessage/audit.htm

Method： POST

接口描述：
平台提供

该接口主要用来对图文混合内容进行审查（图文混合表示一条消息内包含文本、图片、视频、语音四种内容类型中的多种组合）；
审查结果会通过5.3的结果异步通知接口返回，内容中只要有一条内容（不管是文本还是其他类型的内容）不通过，则整条消息会返回不通过。
内容审查一般会根据发行地域调用第三方内容安全平台实现，若想了解现在使用第三方平台的情况，需要联系技术支持；
同一条消息产生的多次异步结果通知（涉及人工抽查时可能会出现多次回调结果），以最后一次为准。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
messageId	string	必须	消息ID 至少在游戏服内唯一（50个字符以内）；异步审查结果以及消息删除会以该ID同步游戏服；
type	string	必须	类型，moments：朋友圈动态；other：其他；请务必正确传递该类型，该类型可能会影响第三方平台的审核策略；若目前类型定义不满足，请找平台技术支持人员确认
messageContextList	object []	必须	内容列表，该列表中的所有内容类型同属于一条消息	item 类型:object
├─ messageType	string	必须	消息内容类型，text:文本； voice：语音； image：图片；video：视频
├─ messageContext	string	必须	messageType为text时为文本内容； messageType为voice时为语音文件的http访问地址； messageType为image时为图片文件的http访问地址； messageType为video时为视频文件的http访问地址
userId	string	必须	平台用户ID
serverId	string	必须	游戏服ID
roleId	string	必须	角色ID
roleName	string	必须	角色名称
level	string	非必须	角色等级
vipLevel	string	非必须	角色VIP等级
messageChannel	string	非必须	消息频道；没有可传空
receiveServerId	string	非必须	群发消息传空即可；主要用于两个跨服玩家之间的聊天信息时，标识消息接收角色的游戏服ID
receiveRoleId	string	非必须	群发消息传空即可；主要用于两个玩家之间的聊天信息时，标识消息接收角色ID
receiveRoleName	string	非必须	群发消息传空即可；主要用于两个玩家之间的聊天信息时，标识消息接收角色名称
callbackUrl	string	必须	游戏服提供异步回调接口地址；必填；回调接口规范5.3接口
serviceCode	string	必须	来自龙图SDK的API”11.14 获取Servicecode”

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述

5.3 平台内容审查-结果异步通知接口

基本信息

Path： /gameServerGMTUrl/?service=message.audit.result&serverId=serverId

Method： POST

接口描述：
游戏服提供

注意：该接口的受理地址callbackUrl 需要在5.1和5.2中提交审查时传递过来,若未传递将以后台配置GM地址进行回调；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表图片审核结果异步通知；固定为:message.audit.result
serverId	string	必须	平台配置的游戏服Id
messageId	string	必须	消息ID，对应5.1和5.2中的messageId
auditType	string	必须	类型：[1：消息审查回调] [2：人工审查回调]
messageStatus	string	必须	本条消息状态：0:审核不通过； 1:审核通过；
messageUpdate	string	必须	0:未替换；1:已替换；对于审核不通过的消息，若可确定本消息所涉及的敏感词时，该消息中的敏感词信息会被替换，替换后的消息在message中返回；当messageStatus为1时，可忽略该字段；注意：并非所有审核不通过的消息都可以用替换敏感词，使用时一定要判断该字段的状态；非纯文本消息，该值固定返回0
message	string	必须	被修改后的消息；

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

5.4 消息删除接口

基本信息

游戏服提供
Path： /callbackUrl?service=message.del&serverId=serverId

Method： POST

接口描述：
注意：该接口的受理地址callbackUrl 需要在[文本信息审查接口]中提交审核时传递过来,若未传递将以后台配置GM地址进行回调；

具体哪些消息可以删除，需要每个产品的研发、运营沟通后，把可以消息的频道ID通知平台技术支持人员即可；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表图片审核结果异步通知；固定为:message.del
serverId	string	必须	平台配置的游戏服Id
messageIds	string []	必须	消息ID数组	item 类型:string
├─		非必须	消息ID;取自聊天数据接收或平台消息审查接口中的chatId和messageId

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

6 游戏服列表功能接入

6.1 获取游戏服当前信息

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=server.information.query&serverId=serverId

Method： POST

接口描述：
该接口主要用来获取游戏服当前的部分配置信息，包括：注册总人数、在线人数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询区服当前注册和在线人数；固定为:server.information.query
serverId	string	必须	区服Id
transactionId	string	必须	请求ID，每次请求都不一样如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object	必须	属性列表
├─serverId	string	必须	区服Id
├─enrolment	string	必须	区服当前注册总人数；不支持返回(-)中杠
├─onlineNumber	string	必须	区服当前在线人数；不支持返回(-)中杠
├─rechargeRoleNumber	string	必须	该区服内充值角色数；若合服后返回合服后总充值角色数；不支持返回(-)中杠

6.2 游戏服信息修改通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=server.information.update&serverId=serverId

Method： POST

接口描述：
该接口主要用来修改游戏服当前的部分配置信息，包括：是否推荐服、用户可见状态、白名单可见、是否关闭注册；
whiteListStatus ：该服对普通用户是否可见； 0：可见； 1：不可见；当为1（不可见时）白名单用户对该服是可见的；白名单数据的用户定义参见接口【获取游戏服白名单数据信息接口】若不支持请返回 110516
userStatus ：标志用户所见该游戏服的显示状态；若不支持请返回 110516
维护：普通用户无法进入，白名单除外；
正常：可以进入；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询区服当前注册和在线人数；固定为:server.information.update
serverId	string	必须	区服Id
serverName	string	选填	区服名称
recommend	string	选填	1:是推荐服；0：不是推荐服；空表示本次不修改该字段；
userStatus	string	选填	该游戏服用户可见状态；0：维护；1：正常；空表示本次不修改该字段；
whiteListStatus	string	选填	该服对普通用户是否可见； 0：可见； 1：不可见；当为1（不可见时）白名单用户对该服是可见的；
closeRegister	string	选填	是否关闭注册；0：未关闭；1：已关闭；空表示本次不修改该字段；
isNewServer	string	选填	是否新服；0：否；1：是；空表示本次不修改该字段；
serverLoadStatus	string	选填	游戏服负载状态；1：畅通；2：拥挤；3：火爆；空表示本次不修改该字段；
ip	string	选填	游戏服公网ip
port	string	选填	游戏服端口
type	string	选填	游戏服类型；1：正式服；2:测试服；3:提审服；
areaCode	string	选填	大区编码
defendDomain	string	选填	高防域名
innerIp	string	选填	游戏服内网ip
gmPort	string	选填	GM端口
openServiceTime	string	选填	开服时间；例如:2021-09-16 18:56:19
transactionId	string	选填	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4；该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

6.3 平台提供游戏服状态信息接口[苍骑专用]

基本信息

平台提供
Path： https://{平台GMT域名}/api/gmt/outer/config/pull.htm

Method： POST

接口描述

功能介绍：获取游戏服状态以及是否白名单可见状态配置，支持同时获取多个游戏服的数据；

提供方：平台统一GMT

调用方：游戏服务端

使用场景：开新服时或游戏服重启；

注意：该接口对单个IP有访问频率控制，默认访问控制策略：单IP每分钟最多2次访问、单IP每小时最多60次；两者达到任一访问上限都会返回失败

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	固定传:server.information.query
serverIds	string []	必须	游戏服ID数组，可一次获取多个游戏服ID	item 类型:string
├─		非必须	游戏服ID

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；
desc	string	必须	状态描述
data	object []	必须	配置数据数组；不管获取单个还是多个游戏服，均以数组返回，数组中每一项标识一个游戏服的配置	item 类型:object
├─serverId	string	必须	游戏服ID
├─recommend	string	必须	1:是推荐服；0：不是推荐服；默认为0
├─userStatus	string	必须	该游戏服显示状态；0：维护；1：正常；默认为1
├─whiteListStatus	string	必须	该服对普通用户是否可见； 0：可见； 1：不可见；当为1（不可见时）白名单用户对该服是可见的；
├─closeRegister	string	必须	是否关闭注册；0：未关闭；1：已关闭；
├─serverNoticeId	string	必须	维护公告唯一标识；
├─content	string	必须	维护公告内容；

6.4 维护公告通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=server.notice.notify&serverId=serverId

Method： POST

接口描述：
注意：该接口主要实现推送游戏维护公告内容的功能。同一个游戏服，以最后一次通知为准；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表游戏内入口开关配置; 固定为:server.notice.notify
serverId	string	必须	平台配置的游戏服Id
serverNoticeId	string	必须	维护公告唯一标识；用来区分每一个维护公告的发送任务
content	string	必须	维护公告内容，若未配置国际化或未配置某种国际化语言时使用该内容展示
i18nContentList	object []	选填	多语言内容列表,解决发行多语言版本的国际化问题	item 类型: object
├─ i18nCode	string	选填	国际化语言标识；如:zh_CN；详见“附录4”
├─ i18nContent	string	选填	指定国际化语言的内容
endTime	long	选填	维护预计结束时间；精确到毫秒的时间戳；如：1521452724853；该值为null表示没有预计结束时间
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

6.5 平台提供游戏服白名单列表数据接口

基本信息

平台提供
Path： https://{平台GMT域名}/api/gmt/outer/server/whiteList.htm
Method： POST

接口描述：
该接口主要用来获取已配置的白名单数据列表，如：IP、平台用户ID、游戏版本号、设备MAC、设备IDFA，只要当前玩家的任何一项信息匹配上，就算作白名单用户；
白名单用户具备以下两个特殊权限：
1：白名单用户可以看见在平台设置为不可见的游戏服
2：白名单用户可以进入维护状态的游戏服

注意：该接口的数据要求游戏服做本地缓存，每隔1分钟通过该接口更新一次，若获取白名单数据失败，则沿用上一次的缓存的白名单数据；若首次获取数据失败，则按白名单数据为空处理；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述
data	object[]	必须	属性列表	item类型:object
├─type	string	必须	1:IP;2:平台用户ID；3：游戏版本；4：MAC（主要用于安卓系统）；5：IDFA（主要用于IOS系统）
├─data	string	必须	具体数据；当type为1时表示具体IP，当type为2时表示具体用户ID，当type为3时表示具体游戏版本号

6.6 平台提供目录服列表数据接口

基本信息

平台提供
Path： https://{平台GMT域名}/api/gmt/outer/server/list.htm
Method： POST

接口描述：
该接口主要用来根据版本、渠道、平台信息获取对应已配置的区服数据列表。
注意：该接口对单个IP有访问频率控制，默认访问控制策略：单IP每分钟最多120次访问、单IP每小时最多7200次；两者达到任一访问上限都会返回失败
注意：目前平台的大区设置规则是一个渠道平台只能归属一个大区。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

名称	类型	是否必须	备注	其他信息
platform	string	必须	平台；安卓：0000；IOS：0002；同ServiceId一同判断获取指定渠道配置的大区下的游戏服列表	`该参数已取消，下次文档更新会删除`
version	string	必须	版本号;根据版本当前的状态（提审、已上线、测试）来判断返回提审服还是正式服或测试服	`该参数已取消，下次文档更新会删除`
serviceId	string	必须	产品平台ID，查看如何从SDK中获取，获取该渠道配置的大区下的游戏服列表	`该参数已取消，下次文档更新会删除`

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述
data	object[]	必须	游戏服列表	item类型:object
├─serverId	string	必须	游戏服id
├─serverName	string	必须	游戏服名称
├─type	string	必须	游戏服类型；1：正式服；2:测试服；3:提审服；
├─areaCode	string	必须	大区编码；参见`附5 大区编码列表`
├─recommend	string	必须	是否为推荐服；1:是推荐服；0：不是推荐服；
├─userStatus	string	必须	该游戏服显示状态；0：维护；1：正常；
├─whiteListStatus	string	必须	该服对普通用户是否可见； 0：可见； 1：不可见；当为1（不可见时）白名单用户对该服是可见的；
├─closeRegister	string	必须	是否关闭注册；0：未关闭；1：已关闭；
├─isNewServer	string	必须	是否新服；0：否；1：是；
├─serverLoadStatus	string	必须	1：畅通；2：拥挤；3：火爆；
├─ip	string	必须	游戏服公网ip
├─port	string	必须	游戏服端口
├─defendDomain	string	必须	高防域名
├─innerIp	string	必须	游戏服内网ip
├─gmPort	string	必须	GM端口
├─openServiceTime	string	选填	开服时间；例如：2021-09-16 18:56:19

6.7 白名单列表数据通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=server.whitelist.notify&serverId=serverId

Method： POST

接口描述：
该接口主要用来GMT向游戏服推送白名单列表数据；如：IP、平台用户ID、游戏版本号、设备MAC、设备IDFA，只要当前玩家的任何一项信息匹配上，就算作白名单用户；
白名单用户具备以下两个特殊权限：
1：白名单用户可以看见在平台设置为不可见的游戏服
2：白名单用户可以进入维护状态的游戏服

注意：该接口为GMT主动向游戏服推送白名单数据；需要与6.5 平台提供游戏服白名单列表数据接口配合使用，6.5 平台提供游戏服白名单列表数据接口为游戏服主动向GMT拉取白名单数据；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表查询区服当前注册和在线人数；固定为:server.whitelist.notify
serverId	string	必须	区服Id
whiteListId	string	必须	白名单通知唯一标识；用来区分每一次白名单数据的发送任务；
whiteListDataList	object[]	必须	白名单数据列表	item类型:object
├─type	string	必须	1:IP;2:平台用户ID；3：游戏版本；4：MAC（主要用于安卓系统）；5：IDFA（主要用于IOS系统）
├─data	string	必须	具体数据；当type为1时表示具体IP，当type为2时表示具体用户ID，当type为3时表示具体游戏版本号
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

6.8 新版推荐游戏服设置通知接口

基本信息

Path： /regionServerGMTUrl?service=server.recommend.notify&regionId=regionId

Method： POST

接口描述：

大区中心服提供

该接口为新版的推荐服设置接口，支持分大区进行设置，除了默认推荐服外，还支持按用户IP归属国家设置推荐服，设置后会通知到指定大区的GM地址上去。注意：同一个大区多次设置通知，以最后一次通知为准；比如：第一次通知server1、server2为推荐服，第二次设置server2、server3为推荐服，第二次通知后该大区的推荐服只有server2、server3, 此时server1不在是推荐服。
注意1：新发行产品必须接入该推荐服设置API，同时6.2和6.6中的游戏服推是否为推荐服状态将废弃；目前已经OB的线上产品6.2和6.6中的是否为推荐服状态将保留，可以继续使用，但是建议尽快切换至新的推荐服设置API。
注意2:国家或地区表参见:http://sdk.longtubas.com/t3/241/4774/1500009172.html#%E7%94%A8%E6%88%B7%E5%BD%92%E5%B1%9E%E5%9B%BD%E5%AE%B6%E6%88%96%E5%9C%B0%E5%8C%BA%E4%BB%A3%E7%A0%81

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，固定为:server.recommend.notify
regionId	string	必须	大区ID，来自平台统一分配；目前支持的大区编码见`附5 大区编码列表`
defaultRecommendServers	object []	必须	默认推荐服配置	item 类型:object
├─ serverId	string	必须	游戏服ID
├─ sortNum	number	必须	排序数值，数字越大标识该服优先级越高
otherRecommendServerStrategys	object []	必须	其他推荐服策略	item 类型:object
├─ strategyName	string	必须	推荐策略名称
├─ strategyCode	string	必须	推荐策略编码，可以由研发定义，配置到GSC上的策略中
├─ strategyType	string	必须	策略类型，1:按用户IP归属国家
├─ strategyValue	string	必须	策略内容；当strategyType=1时，该值为国家编码，支持多个国家编码用英文逗号分隔，如:156,344,840
├─ recommendServers	object []	必须	该策略的推荐服列表	item 类型:object
├─ serverId	string	必须	游戏服ID
├─ sortNum	number	必须	排序数值，数字越大标识该服优先级越高

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

6.9 游戏服列表查询SDK实现选服功能

基本信息

Path： /regionServerGMTUrl?service=server.list.query&regionId=regionId

Method： POST

接口描述：
大区中心服提供

该接口主要用于获取游戏某个大区上的游戏服列表，用于SDK展示选服界面，目前使用产品为国内热江和怀旧版合一的版本，因为游戏服的状态信息没有使用GSC维护，所以需要研发提供接口返回当前游戏服的列表，regionServerGMTUrl地址来源于GSC区服管理中大区上配置的地址。另外，经沟通确认白名单机制目前配置在游戏侧，所以SDK不处理维护状态的拦截，用户选服进入时需要研发侧自行控制。
请求示例

{
"service": "server.list.query",
"regionId": "101",
"serviceId": "2000003431014300000",
"customVersion": "r.510.314",
"gameId": "520050",
"snid": "2193"
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
serivce	string	必须	GMT服务标识，用来代表去研发侧查询游戏服列表; 固定为:server.list.query
regionId	string	必须	大区编码
serviceId	string	必须	产品平台ID
customVersion	string	必须	自定义版本号；调用SDK选服接口时传递的参数
gameId	string	非必须	旧版gameId
snid	string	非必须	旧版渠道号

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object []	非必须	游戏服列表	item 类型: object
├─ code	string	必须	游戏服ID
├─ name	string	必须	游戏服名称
├─ userStatus	string	非必须	是否维护；0:维护；1:正常；有些产品是否维护和游戏负载状态用一个字段表示，如果这样的话，需要拆成userStatus和serverLoadStatus两个字段返回，如维护时userStatus返回0，而serverLoadStatus返回空；不维护时userStatus返回1，serverLoadStatus返回负载状态；
├─ serverLoadStatus	string	非必须	游戏服负载状态；1：畅通；2：拥挤；3：火爆；
├─ recommend	string	非必须	是否推荐服，1:是推荐服；0：不是推荐服；若有多个推荐服，会取第一个作为新用户首次选服时的默认选中服。
├─ isNewServer	string	非必须	是否新服 0:否； 1:是

7 GM指令功能接入

7.1 角色指令通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=command.notify.roleIds&serverId=serverId

Method： POST

接口描述：
注意：该接口主要实现按在指定角色ID上执行GM指令。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表按角色Id进行推送邮件; 固定为:command.notify.roleIds
serverId	string	必须	平台配置的游戏服Id
roleId	string	必须	角色Id
commandId	string	必须	指令唯一标识；用来区分每一个指令发送任务；
command	string	必须	指令；如：.fixsignintimes 5；
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

7.2 游戏服指令通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=command.notify.server&serverId=serverId

Method： POST

接口描述：
注意：该接口主要实现按在指定游戏服上执行GM指令。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表按游戏服进行推送邮件; 固定为:command.notify.server
serverId	string	必须	平台配置的游戏服Id
commandId	string	必须	指令唯一标识；用来区分每一个指令发送任务；
command	string	必须	指令；如：.fixsignintimes 5；
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

8 游戏内开关功能接入

8.1 游戏内入口开关通知接口

基本信息

游戏服提供
Path： /gameServerGMTUrl?service=server.function.notify&serverId=serverId

Method： POST

接口描述：
注意：该接口主要实现推送游戏内入口开关配置的功能。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表游戏内入口开关配置; 固定为:server.function.notify
serviceIds	string	必须	产品平台ID,支持多个；若无此限制则为-1；格式如：产品平台ID1,产品平台ID2,产品平台ID3… 查看如何从SDK中获取
versions	string	必须	版本号,支持多个；若无此限制则为-1；格式如：版本号1,版本号2,版本号3…
serverId	string	必须	平台配置的游戏服Id
name	string	必须	功能名称
code	string	必须	功能code
status	string	必须	功能状态；0：未开启；1：已开启
info	string	必须	自定义配置
transactionId	string	必须	请求ID，每次请求都不一样，如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述

8.2 获取游戏内入口开关接口

基本信息

平台提供
Path： /api/gmt/outer/config/pull.htm

Method： POST

接口描述

功能介绍：获取游戏内功能开关接口，支持同时获取多个游戏服的数据；

提供方：平台统一GMT

调用方：游戏服务端

使用场景：开新服时或游戏服重启；

注意：该接口对单个IP有访问频率控制，默认访问控制策略：单IP每分钟最多2次访问、单IP每小时最多60次；两者达到任一访问上限都会返回失败

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	固定传:server.function.query
serverIds	string []	必须	游戏服ID数组，可一次获取多个游戏服ID	item 类型:string
├─		非必须	游戏服ID

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；
desc	string	必须	状态描述
data	object []	必须	平台配置数据数组；不管获取单个配置服务的配置还是多个配置服务的配置，均以数组返回，数组中每一项标识一种服务的配置数据	item 类型:object
├─ serverId	string	必须	游戏服ID
├─ functions	object []	必须	功能数组，数组中每一项标识一个功能	item 类型:object
├─serviceIds	string	必须	产品平台ID,支持多个；若无此限制则为-1；格式如：产品平台ID1,产品平台ID2,产品平台ID3… 查看如何从SDK中获取
├─versions	string	必须	版本号,支持多个；若无此限制则为-1；格式如：版本号1，版本号2，版本号3…
├─ name	string	必须	功能名称
├─ code	string	必须	功能code
├─ status	string	必须	功能状态；0：未开启；1：已开启
├─ info	string	必须	自定义配置

返回示例

{
"status": "0",
"reset": "1000",
"desc": "",
"data": [
{
"serverId": "1001",
"functions": [
{
"code": "rebate",
"name": "返利活动",
"status": "1",
"info": ""
},
{
"code": "rebate1",
"name": "返利活动1",
"status": "0",
"info": ""
}
]
},
{
"serverId": "1002",
"functions": [
{
"code": "rebate",
"name": "返利活动",
"status": "1",
"info": ""
}
]
}
]
}

9 游戏排行榜功能接入

9.1 游戏服-游戏服排行获取榜接口

基本信息

Path： /gameServerGMTUrl?service=server.rank.list

Method： POST

接口描述：

该接口需要返回指定排行榜的榜单数据，其中rankCode接入前需要运营人员提前和研发沟通，每一个rankCode对应一个榜单，rankCode可以在平台GSC平台进行添加，添加时需要为每个榜单指定榜单最大数量，不要超过500，如果有必要的话可以为排行榜指定多个附加值，指定附加值时需要提前录入附加值的key和名称；附加值主要是为了排行主要指标相同时该榜单以另外哪些值作为参考条件；

该接口返回的榜单中的行数由参数count决定，如果目前总数少于count值，可以返回所有的数据；不可返回比count还多的数据，如果返回也会被忽略；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，用来代表查询指定游戏服的指定排行榜；固定为:server.rank.list
serverId	string	必须	区服Id
rankCode	string	必须	排行榜标识，由运营人员提前在GSC上设定，不同的榜单对应不同的rankCode；若不支持该rankCode则返回110517错误码即可
count	int	必须	获取指定rankCode排行榜的前多少名；
transactionId	string	必须	请求ID，每次请求都不一样；如：0dbaff98a230282da164b12b122c4cc4 该参数已废弃

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见详细返回码定义
desc	string	必须	状态描述
data	object[]	必须	排行榜数据	item类型:object
├─dataId	string	必须	排行数据ID，若是基于角色的排行榜，则是角色ID，若是基于联盟或工会的排行榜则是联盟ID或工会ID；
├─dataName	string	必须	排行数据名称；若是基于角色的排行榜，则是角色名称，若是基于联盟或工会的排行榜则是联盟名称或工会名称；
├─rankIndex	string	必须	榜单名次，从1开始
├─rankValue	number	必须	值；比如：等级排行榜中的等级
├─additionalDataList	object[]	非必须	排行其他数据；其中key需要在GMT平台配置后，才可以在GMT平台上的排行榜中回显该部分数据	item类型:object
├─key	string	必须	数据key；比如等级排行榜中的经验值，需要显示此值是因为进行排行榜计算时若等级相同则经验值高的靠前；该key需要在GMT的排行榜配置中提前配置，否则排行榜内无法显示
├─value	string	必须	值；

10调查问卷接口

10.1 新增/修改问卷通知接口

基本信息

Path： /gameServerGMTUrl?service=server.question.notify&serverId=serverId

Method： POST

接口描述：

游戏服提供

GSC平台修改或添加问卷后实时通过此接口通知游戏服务器；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
questionId	number	必须	问卷ID
source	number	必须	来源0倍市得1其他
name	string	必须	问卷name
desc	string	非必须	问卷描述
status	number	必须	1商用0暂停；暂停时标识问卷不可用，不应对外展示
serviceIds	string	非必须	产品平台ID以英文逗号’,’分隔；-1标识不限制产品平台；仅当putType为0时有效，其他类型时为空；如：2000003431014300000,2000003431000800000,2000003431099300000 查看如何从SDK中获取
serverId	string	必须	区服;固定为当前通知的游戏服ID
startTime	string	必须	开始时间；精确到毫秒的时间戳；如：1521452724853；
endTime	string	必须	结束时间；精确到毫秒的时间戳；如：1521452724853；
putType	string	必须	投放类型0：全服问卷；（可通过角色等级来进行角色筛选）1：角色列表问卷；2:邮件推送问卷（邮件推送问卷时请忽略serviceIds、roleLevel、roleVipLevel、roleList这四个属性，具体以收到邮件的角色为准）
roleLevel	string	非必须	角色等级范围；符合该等级范围的角色才能展示该问卷；空字符串标识无此限制；格式如：0-50标识从0级到50级，包含0级也包含50级；仅限于putType为0（全服问卷）可用；
roleVipLevel	string	非必须	角色VIP等级范围；符合该等级范围的角色才能展示该问卷；空字符串标识无此限制；格式如：0-50标识从0级到50级，包含0级也包含50级；仅限于putType为0（全服问卷）可用；
rewardType	string	必须	奖励发放类型；0：无奖励；1：礼包ID；2：道具ID及数量组合
rewardIds	string	非必须	问卷奖励信息；无奖励为空；rewardType为1时，为配置的奖励礼包ID；rewardType为2时，为配置的道具数量组合，多个道具由英文逗号隔开，格式：propId=number,propId=number如：1001=2,1002=10标识1001道具发放2个，1002道具发放10个；
roleIds	string	非必须	角色Id列表，多个roleIds时用英文逗号隔开;如：100,101,102,103;仅当putType为1时可用，默认为空字符串；平台默认限制最大角色数为50000，但是会根据运营后续需求进行调整，若游戏服对此有限制，需要提前通知运营同学。

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

10.2 获取当前生效的问卷列表

基本信息

Path： /api/gmt/outer/question/List.htm

Method： POST

接口描述：

平台提供

该接口主要适用于新开服时主动从平台获取当前生效的问卷列表，注意：该接口不支持高并发访问，因此不得直接在游戏客户端请求，必须由游戏服服务端进行调用，用来解决开新服或重启游戏服时重新获取调查问卷列表的需求。

访问域名详见各节点GMT域名

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
productId	string	非必须		产品ID
localeId	string	非必须		地域ID

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须
reset	string	必须
desc	string	非必须
data	object[]	必须	问卷列表	item类型:object
├─questionId	number	必须	问卷ID
├─name	string	必须	问卷名称
├─desc	string	非必须	问卷描述
├─status	number	必须	1商用0暂停；暂停的问卷此接口不返回，所以该字段固定为1
├─source	number	必须	来源；0:倍市得；1：其他；
├─serviceIds	string	非必须	产品平台ID以英文逗号’,’分隔；-1标识不限制产品平台；仅当putType为0时有效，其他类型时固定为空；如：2000003431014300000,2000003431000800000,2000003431099300000 查看如何从SDK中获取
├─serverIds	string	必须	问卷投放游戏服列表，以英文逗号”,”分割，-1标识全部游戏服；如：10001,10002,10003;当putType为1时，标识本次生效的角色列表涉及哪些游戏服ID；
├─startTime	string	必须	开始时间；精确到毫秒的时间戳；如：1521452724853；
├─endTime	string	必须	结束时间；精确到毫秒的时间戳；如：1521452724853；
├─putType	string	必须	投放类型0：全服问卷；1：角色列表问卷
├─roleLevel	string	非必须	角色等级范围；符合该等级范围的角色才能展示该问卷；空字符串标识无此限制；格式如：0-50标识从0级到50级，包含0级也包含50级；仅限于putType为0（全服问卷）可用；
├─roleVipLevel	string	非必须	角色VIP等级范围；符合该等级范围的角色才能展示该问卷；空字符串标识无此限制；格式如：0-50标识从0级到50级，包含0级也包含50级；仅限于putType为0（全服问卷）可用；
├─rewardType	string	必须	奖励发放类型；0：无奖励；1：礼包ID；2：道具ID及数量组合
├─rewardIds	string	非必须	问卷奖励信息；无奖励为空；rewardType为1时，为配置的奖励礼包ID；rewardType为2时，为配置的道具数量组合，多个道具由英文逗号隔开，格式：propId=number,propId=number如：1001=2,1002=10标识1001道具发放2个，1002道具发放10个；
├─roleList	object[]	必须	角色Id列表；平台默认限制最大角色数为50000，但是会根据运营后续需求进行调整，若游戏服对此有限制，需要提前通知运营同学。注意此处和10.1的区别	item类型:object
├─roleId	string	必须	角色ID
├─serverId	string	必须	游戏服ID

10.3 问卷完成回调研发接口

基本信息

Path： /gameServerGMTUrl?service=question.callback.notify&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要实现推送游戏内问卷完成回调的功能; 注意：需要游戏服增加同一个问卷同一个角色只能发放一次奖励的限制；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，用来代表通知区服问卷信息；固定为:question.callback.notify
serverId	string	必须	区服Id
questionId	number	必须	问卷ID
status	number	必须	1：完成0：未完成（目前未完成不会通知）
userId	string	必须	用户id
roleId	string	必须	角色id
customParams	object[]	必须	自定义参数列表；取自SDK接入时的透传参数，详见SDK的接入当中的	item类型:object
├─key	string	必须	自定义参数的key
├─value	string	必须	自定义参数的value

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

11 模拟充值

模拟充值流程简单介绍

注意1：如果游戏服需要区分正常充值和模拟充值订单，可以联系技术支持人员获取区分规则。
注意2: 模拟充值的金额不进BI统计。
注意3：模拟充值不建议用来做常规的普通用户侧购买测试，因为模拟充值不涉及客户端商品选择、下单，以及部分游戏会对模拟充值进行特殊处理，测试会不充分。
注意4：模拟充值依赖普通充值发货接口进行发货，所以必须先计入SDK服务端接入的充值发货接口

11.1 模拟充值-充值礼包编码查询接口

基本信息

Path： /gameServerGMTUrl?service=pay.simulate.query.propgroupcode&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于模拟充值过程中根据礼包类型获取该礼包类型下现在可用的充值礼包编码列表及商品信息。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:pay.simulate.query.propgroupcode
serverId	string	必须	区服Id
userId	string	必须	用户Id
serviceId	string	必须	产品的平台Id；
roleId	string	必须	角色Id
propGroupType	string	必须	礼包类型，可在gsc上提前配置礼包类型

返回数据

名称	类型	是否必须	备注	其他信息
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object []	必须		item 类型:object
├─ goodsId	string	必须	gsc平台配置的商品Id；必须返回，切必须在gsc上配置，不然会导致无法下单
├─ isPay	string	必须	本次是否可购买；0:不可购买, 1:可购买
├─ propGroupCode	string	必须	礼包编码，用来表示本次发放道具或道具组合的唯一标识
├─ propGroupName	string	必须	礼包名称
├─purchaseNumber	number	可选	该用户针对该礼包还能购买次数；若没有限制可以返回-1

11.2 模拟充值-发货扩展参数查询

基本信息

Path： /gameServerGMTUrl?service=pay.simulate.query.extendparams&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于模拟充值过程中根据指定的礼包编码和商品ID以及用户角色信息，获取该礼包编码充值发货的自定义扩展参数；自定义扩展参数将用于通用的充值发货接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:pay.simulate.query.extendparams
serverId	string	必须	区服Id
userId	string	必须	用户Id
serviceId	string	必须	产品的平台Id；
roleId	string	必须	角色Id
propGroupType	string	必须	礼包类型，可在gsc上提前配置礼包类型
goodsId	string	必须	商品Id，取值为gsc上配置的商品ID
propGroupCode	string	必须	礼包编码，来源于“充值礼包查询接口”的返回值中

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object	必须
├─ extendparams	string	必须	发货自定义扩展参数，长度应小于500个字符（该参数会在充值发货接口extendParams中回传游戏服）

12 联盟工会接口

12.1 联盟/公会-查询联盟/公会列表

基本信息

Path： /gameServerGMTUrl?service=league.list.query&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于查询联盟/公会的列表，若游戏服内公会较多，超过1000条时，可以通过请求中的queryStart和返回中的count以及needContinue来进行分页查询。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:league.list.query
serverId	string	必须	区服Id
queryStart	string	必须	开始查询的起始位置，默认为”0”，若返回数据中needContinue为1，则下次请求时该值为前面总共返回的数量总和。
orderBy	string	必须	排序字段标识；默认需要支持createTime排序；是否需要支持其他字段排序由运营决定。
orderType	string	必须	排序类型；ASC:升序；DESC:降序

返回数据

名称	类型	是否必须	备注	其他信息
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object	必须
├─ count	number	必须	该条件查询下总共需要返回的条数
├─ needContinue	string	必须	分页功能属性；该查询条件下是否还有未返回的工会；0:没有; 1:还有；返回1时，会继续通过该条件查询加载
├─ leagueList	object []	必须	联盟/公会列表	item 类型:object
├─ leagueCode	string	必须	联盟/公会唯一编码
├─ leagueName	string	必须	联盟/公会名称
├─ iconUrl	string	必须	联盟/公会icon的http地址，需要外网可访问
├─ leagueLevel	string	必须	联盟/公会的等级
├─ ce	number	必须	联盟/公会的战力
├─ presidentRoleId	string	必须	联盟/公会的会长的角色ID
├─ presidentRoleName	string	必须	联盟/公会的会长的角色名称
├─ description	string	必须	联盟/公会的介绍
├─ memberCount	number	必须	联盟/公会的成员数量
├─ onlineMemberCount	number	必须	联盟/公会的在线成员数量
├─ createTime	number	必须	联盟/公会的创建时间，毫秒数时间戳
├─ lastActiveTime	number	必须	联盟/公会的最后活跃时间，毫秒数时间戳；默认是工会内最后角色登录的时间，若运营有特殊计算方法，需要运营通知研发实现。
├─ customParas	object []	必须	联盟/公会的产品自定义属性，通用属性无法满足时，可在GSC上添加自定义属性来扩展	item 类型:object
├─ customParaKey	string	必须	自定义参数Key，只有在GSC上配置了的customParaKey才会展示，未配置的展示时将忽略
├─ customParaValue	string	必须	自定义参数Key的值

12.2 联盟/公会-联盟/公会成员列表查询

基本信息

Path： /gameServerGMTUrl?service=league.member.query&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于查询指定游戏服内的指定联盟/工会的成员列表（全部成员列表）

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:league.member.query
serverId	string	必须	区服Id
leagueCode	string	必须	联盟/公会唯一编码

返回数据

名称	类型	是否必须	备注	其他信息
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object	必须
├─ memberList	object []	必须	成员列表	item 类型:object
├─ roleId	string	必须	角色ID
├─ roleName	string	必须	角色名称
├─ level	string	必须	角色等级
├─ profession	string	必须	角色职业
├─ ce	number	必须	角色战力
├─ job	string	必须	该角色在联盟/工会内职务的编码
├─ onlineStatus	string	必须	在线状态；0：不在线；1：在线
├─ lastLoginTime	string	必须	最后登录时间戳
├─ customParas	object []	必须	联盟/工会的产品自定义属性，通用属性无法满足时，可在GSC上添加自定义属性来扩展	item 类型:object
├─ customParaKey	string	必须	自定义参数Key，只有在GSC上配置了的customParaKey才会展示，未配置的展示时将忽略
├─ customParaValue	string	必须	自定义参数Key的值

12.3 联盟/公会-联盟/公会信息修改

基本信息

Path： /gameServerGMTUrl?service=league.property.modify&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于修改联盟/工会的指定属性值，目前支持名称、描述、会长的修改。除此之外，如需其他自定义属性支持修改，请运营先和研发沟通后，再在gsc上进行配置为可修改即可。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:league.property.modify
serverId	string	必须	区服Id
leagueCode	string	必须	联盟/公会唯一编码
propertyKey	string	必须	要求改的联盟/工会属性；leagueName:联盟/工会的名称； description:联盟/工会的描述；presidentRoleId:联盟/工会的会长的角色ID；除此之外，如需其他自定义属性支持修改，请运营先和研发沟通后，再在gsc上进行配置为可修改即可。
propertyValue	string	必须	指定propertyKey修改值，具体是增加、减少还是修改为，参见modifyType
modifyType	string	必须	修改类型；1：改变成； 2：增加； 3：减少

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

12.4 联盟/公会-联盟/公会成员信息修改

基本信息

Path： /gameServerGMTUrl?service=league.member.property.modify&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于修改联盟/工会中成员的指定属性值，目前支持职务的修改。除此之外，如需其他自定义属性支持修改，请运营先和研发沟通后，再在gsc上进行配置为可修改即可。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:league.member.property.modify
serverId	string	必须	区服Id
leagueCode	string	必须	联盟/公会唯一编码
roleId	string	必须	本次修改的角色Id
propertyKey	string	必须	要求改的联盟/工会属性；job:角色联盟/工会的职务编码；
propertyValue	string	必须	指定propertyKey修改值，具体是增加、减少还是修改为，参见modifyType
modifyType	string	必须	修改类型；1：改变成； 2：增加； 3：减少

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

12.5 联盟/公会-联盟/公会其他列表资源-选接

基本信息

Path： /gameServerGMTUrl?service=league.other.query&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于查询指定游戏服内的指定联盟/工会的其他列表资源；比如：联盟建筑列表；如无该需求，可以不接；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:league.other.query
serverId	string	必须	区服Id
leagueCode	string	必须	联盟/公会唯一编码
resourceType	string	必须	联盟/工会其他列表资源类型；需要提前在GSC平台定义

返回数据

名称	类型	是否必须	备注	其他信息
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object	必须
├─ resourceList	object []	必须	成员列表	item 类型:object
├─ resourceId	string	必须	资源ID
├─ resourceName	string	必须	资源名称
├─ customParas	object []	必须	联盟/工会其他资源的产品自定义属性，通用属性无法满足时，可在GSC上添加自定义属性来扩展	item 类型:object
├─ customParaKey	string	必须	自定义参数Key，只有在GSC上配置了的customParaKey才会展示，未配置的展示时将忽略
├─ customParaValue	string	必须	自定义参数Key的值

13 其他接口

13.1 举报信息受理接口

基本信息

Path： /api/gmt/outer/message/report.htm

Method： POST

接口描述：

该接口用来接收游戏内角色发起的举报信息，该接口支持上报文本信息和截图，截图建议最多上报两张；在标准字段不够用时，该接口支持增加自定义信息的上报（customContentList），自定义信息，支持在GSC上回显（但是不支持按照自定义信息进行检索）；注意：上报信息类型（type）需要提前在GSC上进行添加

校验码规则参考【详见校验码 V3规则介绍】；

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
messageId	string	必须	上报消息ID 至少在游戏服内唯一；长度不可超过50个字符
type	string	必须	类型，消息类型，可在GSC平台上创建；支持传多个消息类型，以英文逗号分隔，最多支持传10个类型
messageContent	string	必须	消息内容；举报的消息文本内容
images	object []	非必须	图片列表，可以传截图;没有可以为空；建议图片不要超过2张	item 类型:object
├─ imageBase64	string	必须	图片的Base64编码，没有可以为空
├─ imageFileName	string	必须	图片文件名，需要确保后缀的正确性
├─ imageDesc	string	必须	图片描述
customContentList	object []	非必须	自定义附带的内容列表	item 类型:object
├─ customContentTitle	string	必须	单个自定义内容的标题
├─ customContent	string	必须	单个自定义内容正文
serverId	string	必须	游戏服ID
sourceRoleId	string	必须	举报者角色ID
sourceRoleName	string	必须	举报者角色名称
sourceUserId	string	必须	举报者用户ID；
destRoleId	string	非必须	被举报者角色ID；没有则不用填
destRoleName	string	非必须	被举报者角色名称；没有则不用填
destUserId	string	非必须	被举报者用户ID；没有则不用填

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述

13.2 文本实时翻译接口

基本信息

Path： /api/audit/outer/message/translate.htm

Method： POST

接口描述：

平台提供
该接口主要用来文本内容进行实时翻译；
注意1:message长度需小于512个UTF8字符；即其中1个中文汉字为1个字符，1个英文字母也为1个字符；若超过该长度需请求方根据场景自行截断分多次调用；
注意2:内容场景请如实按定义传递，如若目前定义的场景不满足请联系平台技术支持添加；不同的应用场景可能会使用第三方翻译平台的不同翻译策略，另外聊天翻译、用户发帖翻译、朋友圈动态翻译这三种会对翻译后的结果进行敏感词星号(*)替换（仅限云上曲率平台）;
注意3：要求研发侧对近一天的翻译结果进行缓存，避免重复的翻译请求带来成本和并发性能问题;

目前支持的语言编码

语言	编码
中文（繁体）	zh-TW
中文（简体）	zh-CN
越南语	vi
土耳其语	tr
塔加路语（菲律宾语）	tl
泰语	th
马来语	ms
瑞典语	sv
俄语	ru
葡萄牙语	pt
波兰语	pl
挪威语	no
荷兰语	nl
韩语	ko
日语	ja
意大利语	it
印度尼西亚语	id
法语	fr
西班牙语	es
英语	en
希腊语	el
德语	de
阿拉伯语	ar
印地语	hi
马拉地语	mr
马拉雅拉姆语	ml
泰卢固语	te
卡纳达语	kn
旁遮普语	pa
泰米尔语	ta
希伯来语	he

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
message	string	必须	待翻译的文本内容；长度小于512个UTF8字符
sourceLanguage	string	必须	内容源语言，若无法识别，可以传产品发行区域的默认语言即可；实时翻译功能将优先自动识别源语言，只有识别失败时才会使用到该源语言.
targetLanguage	string	必须	翻译的目标语言
scene	string	必须	内容场景；1:聊天翻译; 2:用户发帖翻译; 3:管理员发帖翻译; 4:朋友圈动态翻译; 5:固定文本素材翻译;
contentType	string	可选	text:文本；html:富文本
userId	string	可选	用户ID;游戏内翻译时需要传递
serviceCode	string	可选	来自龙图SDK的API”11.14 获取Servicecode”;游戏内翻译时需要传递,便于后续提提取分析不同人群翻译情况

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	必须	详细返回码；具体参见附件
desc	string	必须	状态描述
data	object	必须	翻译结果
├─ sourceLanguage	string	必须	内容源语言
├─ targetLanguage	string	必须	翻译的目标语言
├─ targetMessage	string	必须	翻译后的文本内容

13.3 关键道具/装备找回-查询接口

基本信息

Path： /gameServerGMTUrl?service=role.precious.props.deleted.list&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于查询删除或销毁的道具/装备列表，若单个角色返回较多，超过1000条时，支持通过请求中的queryStart和返回中的count以及needContinue来进行分页查询。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:role.precious.props.deleted.list
serverId	string	必须	区服Id
roleId	string	必须	角色Id
queryStart	number	必须	开始查询的起始位置，默认为0，若返回数据中needContinue为1，则下次请求时该值为前面总共返回的数量总和。

返回数据

名称	类型	是否必须	备注	其他信息
status	string	必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述
data	object	必须
├─count	number	必须	该条件查询下总共需要返回的条数
├─needContinue	string	必须	分页功能属性；该查询条件下是否还有未返回的数据；0:没有;1:还有；返回1时，会继续通过该条件查询加载
├─roleName	string	必须	角色名称，主要用来进行可视化展示
├─propsList	object[]	非必须	已删除的关键道具/装备列表	item类型:object
├─actionId	string	必须	删除或销毁的动作唯一ID，用户每次操作需要唯一，用来唯一标识用户的某次操作。恢复时会回传该属性
├─actionType	string	必须	删除或销毁的动作类型编码，各产品自己定义即可；恢复时会回传该属性
├─actionName	string	必须	删除或销毁的动作类型名称，各产品自己定义即可，需要与actionType进行对应；
├─actionTime	number	必须	操作时间，精确到毫秒的时间戳；如：1521452724853；
├─propsId	string	必须	删除或销毁的道具或装备ID；恢复时会回传该属性
├─propsName	string	必须	删除或销毁的道具或装备的名称；
├─subAttributes	object[]	非必须	删除或销毁时该道具或装备的子属性列表；若无可不传，若不为空则会在GSC上的详情页中进行展示	item类型:object
├─key	string	必须	子属性key
├─value	string	必须	子属性值
├─desc	string	非必须	子属性描述；可为空
├─customInfo	string	非必须	自定义数据，不需要可传空；恢复时会回传该属性

13.4 关键道具/装备找回-找回接口

基本信息

Path： /gameServerGMTUrl?service=role.precious.props.deleted.recover&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于找回已删除或销毁的道具/装备。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	GMT服务标识，固定为:role.precious.props.deleted.recover
serverId	string	必须	区服Id
roleId	string	必须	角色Id
actionId	string	必须	删除或销毁的动作唯一ID；查询时需返回，若返回为空，则该接口也会传空
actionType	string	必须	删除或销毁的动作类型编码；查询时需返回，若返回为空，则该接口也会传空
propsId	string	必须	删除或销毁的道具或装备ID
customInfo	string	必须	自定义数据;查询时返回的数据

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

13.5 游戏服用户托管接口

基本信息

Path： /gameServerGMTUrl?service=role.trusteeship&serverId=serverId

Method： POST

接口描述：

游戏服提供

该接口主要用于对游戏服上的指定用户进行托管，托管后的用户将不能登录该游戏服。

请求示例

{
"service": "role.trusteeship",
"serverId": "1001",
"userIds": [
"0100010000000000000000000000000165582627"
],
"type": "0"
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
service	string	必须	GMT服务标识，固定为:role.trusteeship
serverId	string	必须	区服Id
userIds	string []	必须	用户ID列表	item 类型: string
├─		非必须	用户ID
type	string	必须	0:托管； 1：取消托管

返回数据

名称	类型	是否必须	备注
status	string	必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

13.6 龙图社区事件回调

基本信息

Path： /gameServerSNSCallbackUrl?service=sns.subscribe.event

Method： POST

接口描述：
游戏服提供

该接口主要用于龙图社区上产生了某种事件进行通知游戏侧；注意接口交互需要遵循校验码规则(V3版本)

gameServerSNSCallbackUrl：注意该地址不区分游戏服和大区，需要单独提供给技术支持人员，由平台侧进行配置。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
service	string	必须	服务标识，固定为:sns.subscribe.event
type	string	必须	事件类型；settop：帖子置顶；setbest：帖子加精；reply：帖子被回复
userId	string	非必须	发帖人对应的龙图SDK平台用户ID；注意：若帖子是后台管理员发的，则该参数为空
topicId	string	非必须	帖子ID

返回数据

名称	类型	是否必须	备注
status	string	非必须	状态码；0：成功；1：失败
reset	string	非必须	详细返回码；具体参见详细返回码定义
desc	string	非必须	状态描述

附1 详细返回码定义

附1.1 基础返回码

reset	描述
000000	成功
000001	该游戏服已经合入其他服，忽略该操作；注意：该返回码在GSC页面上显示为通知成功
110001	非授权IP
110002	游戏服在平台未启用
110003	Ip访问受限
110400	service非法，暂不支持该服务
110401	游戏服不存在
110402	角色ID格式错误
110404	checkSum校验失败
110433	校验版本号非法
110434	校验时间戳非法
110435	校验码非法
110436	校验KeyId非法
110437	平台信息非法
110438	版本信息非法
110516	不支持当前操作
110999	其他错误

附1.2 角色基础功能相关返回码

reset	描述
110403	存在不支持的角色属性获取
110406	不支持封停
110407	不支持解封
110408	不支持禁言
110409	不支持解禁
110410	不支持踢人
110501	角色信息查询失败
110502	修改角色属性失败
110503	封停失败
110504	解封失败
110505	禁言失败
110506	解禁失败
110507	踢人失败
110508	封停成功踢人失败，需要返回失败roleId列表
110518	角色不在线
110519	拒绝修改角色属性

附1.3 信息审查及实时翻译功能相关返回码

reset	描述
110405	频道不存在
110439	ServiceId信息非法
110902	产品内容审核配置异常
110903	实时翻译调用第三方异常
110904	产品实时翻译配置异常

附1.4 邮件功能相关返回码

reset	描述
110412	时间解析失败
110413	邮件产生来源不支持
110414	mailId重复
110415	邮件主题非法
110416	邮件内容非法
110417	邮件内容格式不支持
110418	不支持邮件发送时间
110419	不支持邮件附件失效时间
110420	不支持邮件结束时间
110421	不支持附件
110422	不支持等级区间邮件发送
110423	不支持VIP等级区间邮件发送
110424	不支持全服邮件
110425	不支持该事件邮件
110426	邮件mailId不存在
110427	不支持删除用户邮箱内邮件
110509	邮件发送失败
110510	邮件取消失败

附1.5 滚动公告功能相关返回码

reset	描述
110428	公告Id重复
110429	公告Id不存在
110430	公告内容不支持
110431	公告开始结束事件非法
110432	公告间隔时间不支持
110511	滚动公告发送失败
110512	公告取消失败

附1.6 排行榜功能相关返回码

reset	描述
110517	排行榜不存在

附1.7 审核及翻译功能相关返回码

reset	描述
126999	未知异常错误
126400	参数不合法
126401	频道不存在
126402	checkSum校验失败
126403	请求参数不正确
126404	不支持该消息类型
111405	产品数据非法
111406	地域数据非法
126500	操作失败
126501	审查失败
126502	审查结果通知失败
126503	请求失败
126504	游戏服格式不正确
126505	消息删除失败
126506	平台内部错误
126507	消息查询失败
110401	校验码版本号非法
110402	验码时间戳非法
110403	校验码非法
110405	校验码KeyId非法
110600	messageId重复
110880	音频视频审核任务提交失败
110901	调用云上曲率实时翻译失败
110902	产品内容审核配置异常
110904	产品实时翻译配置异常
110903	实时翻译调用异常

附2 地域编码定义 localeId

地域编码说明文档

附3 统一GMT服务域名及IP

国内

域名：gmt.longtugame.cn
118.31.122.65
118.31.121.222
121.43.155.234 
121.43.226.135 
118.31.35.40
47.96.128.190

港澳台

域名：gmt-tw.t-time.com.tw
47.75.169.144
47.75.252.15

日本

域名：gmt-jp.longtugame.net
124.156.227.235
150.109.205.117

韩国

域名：gmt-kr.longtugame.net
150.109.251.138
150.109.251.85

全球

域名：gmt-usa.longtugame.net
35.185.215.4
34.83.139.53

附4 多语言国际化标识

标识	国家或地区
zh-CN	简体中文
zh-HK	繁体中文-香港地区
zh-TW	繁体中文-台湾地区
ja	日文
ko	韩文
en	英文
fr	法语
de	德语
it	意大利语
es	西班牙语
ru	俄语
pt	葡萄牙语
th	泰语
id	印尼语

附5 大区编码列表

大区编码	名称
100	全服
101	渠道
105	IOS
106	硬核
108	安卓官网
113	官方
114	测试
127	亚洲
128	欧洲
129	北美
130	南美
131	依游
132	万紫
133	不二
134	三九
135	应用宝
136	小七
137	六一八
138	BTGO
139	狮子游戏

附6 云上曲率返回码详细介绍

分类	详细介绍
涉政类	100001:中国政治，100002:非中国政治, 100003:反党反政府，100004:敏感事件, 100005:敏感人物或代号, 100006:英雄烈士, 100007:纳粹, 100008:军国主义，100010:涉政，100900:涉政其他
暴恐类	110001:暴力恐怖，110900:其他暴恐
违禁类	120001:宗教/迷信，120002:网站，120003:非法器械，120004:非法代理，120005:毒品迷药，120006:游戏相关，120007:谋杀相关，120008：赌博，120009:自杀自残，120013:饮酒，120014:吸烟，120900:其他违禁
色情类	130001:性器官和行为，130002:色情三级，130003:隐晦色情，130004:索要裸照，130007:交友低俗，130008:色情交易，130900:其他色情
辱骂类	160001:谩骂人身攻击，160002：不文明用语；160900:其他辱骂
仇恨言论类	170001:种族族群相关，170002:性取向相关，170003:性别相关，170006:宗教相关，170007:国家地区相关，170008:残障相关，170900:其他歧视
未成年保护类	180001:索要信息，180002:未成年识别，180003:未成年色情；180900:未成年其他
敏感热点类	190001:疫情相关，190900:其他热点
违规表情类	410900:违规表情
昵称类	420900:昵称
广告类	150001:买家，150002:工作室广告，150003:售卖其他违禁品，150004:外挂，150005:其他游戏拉人，150006:交换联系方式，150007:引导查看其他信息，150008:无明确联系方式，150009:网址邮箱类，150010:商业广告，150017:加好友，150018:其他社交拉人，150900:其他广告，150999:用户自定义广告
私人交易类	220001:交易信息，220002:支付工具，220900:私人交易其他
自定义类	999001:用户自定义敏感词，150999:用户自定义广告词
其他类	900001:其他

Table of Contents

1 统一GMT接入[必读]

1.1 接入说明

1.2 名词解释

1.3 请求头及编码规则

1.4 校验码规则介绍（V3 版本）

1.4.1 校验码 V3版主要更新点

1.4.2 Header介绍

1.4.3 校验码原理及作用

1.4.4 示例

2 角色基础功能接入

2.1 角色详细信息查询

基本信息

请求参数

返回数据

2.2 角色信息修改接口

基本信息

请求参数

返回数据

2.3 角色封禁踢人接口

基本信息

请求参数

返回数据

2.4 用户角色查询接口

基本信息

请求参数

返回数据

2.5 角色道具属性信息查询

基本信息

请求参数

返回数据

2.6 角色道具属性信息修改

基本信息

请求参数

返回数据

2.7 角色道具信息删除

基本信息

请求参数

返回数据

2.8 平台提供角色封禁踢人接口

基本信息

请求参数

返回数据

3 邮件功能接入

3.1 角色邮件通知接口-按角色Id

基本信息

请求参数

返回数据

3.2 游戏服邮件通知接口-按游戏服通知

基本信息

请求参数

返回数据

3.3 事件邮件通知接口

基本信息

请求参数

返回数据

3.4 邮件取消接口

基本信息

请求参数

返回数据

4 滚动公告功能接入

4.1 滚动公告通知接口

基本信息

请求参数

返回数据

4.2 滚动公告取消接口

基本信息

请求参数

返回数据

5 信息审查功能接入

5.1 平台内容审查-文本图片语音视频

基本信息

请求参数

返回数据

5.2 平台内容审查-图文混合内容审核接口

基本信息

请求参数

返回数据

5.3 平台内容审查-结果异步通知接口

基本信息