Path: /api/gmt/chat/message.htm
Method: POST
接口描述:
该接口用来接收游戏聊天信息,通过接收到的聊天信息在GSC平台可提供聊天实时监控和聊天历史查询功能, 同时GSC平台还具备可配置的自动禁言功能,通过在GSC平台配置自动禁言关键词,可实现自动针对聊天信息中包含禁言关键字的玩家进行禁言2小时,该功能依赖【角色-封禁踢人】接口;
建议:该接口建议游戏服每隔2-5分钟上报一次聊天信息;
建议:body的消息体如果超过于512k,则建议调用多次该接口进行分批次推送;
checkSum计算:和其他接口校验码计算不同之处是:先根据key的字典顺序组装data集合中的每条信息的明文串,然后按照集合顺序把每条明文串通过&符号连接起来作为data的明文数据,再和productId、localeId一起按照字典顺序组装最终的明文串,参考【详见校验码规则介绍】;
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
productId | string | 必须 | 平台8位产品ID;示例:20000034; 此数据可以通过SDK获取,也可固定在游戏服务端;相同游戏产品不会变化; | ||
localeId | string | 必须 | 平台定义地域ID;示例;01 标识国内;此数据可以通过SDK获取,也可固定在游戏服务端;相同地域不会变化; | ||
data | object [] | 必须 | 聊天数据列表 | item 类型:object | |
├─ chatId | string | 必须 | 消息ID 至少在游戏服内唯一(50个字符以内) | ||
├─ userId | string | 必须 | 平台用户ID | ||
├─ serverId | string | 必须 | 游戏服ID | ||
├─ roleId | string | 必须 | 角色ID | ||
├─ roleName | string | 必须 | 角色名称 | ||
├─ level | number | 必须 | 角色等级 | ||
├─ vipLevel | string | 必须 | 角色VIP等级 | ||
├─ chatChannel | string | 必须 | 聊天频道 | ||
├─ chatTime | number | 必须 | 聊天时间;精确到毫秒时间戳;示例:1521452724853 | ||
├─ chatInfo | string | 必须 | 聊天内容;当内容为语音时传语音翻译后的文本,若未翻译则传空 | ||
├─ chatType | string | 必须 | 消息类型,1:文本;2:语音;暂时不支持语音类型 | ||
├─ chatVoiceInfo | string | 必须 | 语音聊天时,语音文件http地址;暂不支持,固定传空即可 | ||
├─ mac | string | 必须 | 聊天产生设备MAC | ||
├─ idfa | string | 必须 | 聊天产生设备IDFA | ||
├─ uuid | string | 必须 | 聊天产生设备UUID | ||
├─ deviceUniqueId | string | 必须 | 聊天产生设备deviceUniqueId | ||
├─ receiveRoleId | string | 必须 | 聊天消息接收者角色ID,群发消息传空即可;主要用于两个玩家之间的聊天信息时,标识消息接收角色ID | ||
├─ receiveRoleName | string | 必须 | 聊天消息接收者角色名称,群发消息传空即可;主要用于两个玩家之间的聊天信息时,标识消息接收角色名称 | ||
├─ serviceId | string | 必须 | 该游戏包对应的联运产品ID,参见SDK接入文档获取ServiceId | ||
checkSum | string | 必须 | 请结合接口描述和校验码规则进行计算 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
status | string | 必须 | 状态码;0:成功;1:失败 | ||
reset | string | 必须 | 详细返回码;具体参见附件 | ||
desc | string | 必须 | 状态描述 |
上海中清龙图软件有限公司