MOGS API 文档

# http post接口

# 获取运营商网关URL列表

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/getgwurls

网关取号文档 km.oa.com/group/11775/attachments/attachment_view/230955

  • 使用示例:
curl -X POST -d '{"clientType":30100,"deviceIdType":1,"deviceId":"abcde"}' 'https://test.mogs.qq.com:10005/mobile/getgwurls?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
clientType int32 是 客户端类型,具体见客户端类型编码
deviceIdType int32 是 设备ID类型,如果无法获取,填默认值
deviceId string 是 设备ID
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功,具体错误码可以查看网关取号文档km.oa.com/group/11775/attachments/attachment_view/230955
status string 状态码,用于系统排查错误
message string 返回码描述
msgId string 每次请求均会返回不同的msgId
urlList Array(Object) 返回的运营商网关列表数据
  • Object参数说明（Json格式）
字段名 类型 描述
channel int32 合作方渠道标识
channelCarrierType int32 合作方所属的运营商类型
URL string 运营商网关URL，需要在蜂窝网络下打开该链接

# 获取掩码手机号

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/getmask
  • 使用示例:
curl -X POST -d '{"msgId":"2012141190478705611513856","deviceIdType":1,"deviceId":"abcde","tokenList":[{"channel":2006,"data":"C34D1CF1D98CC7B794B43A9B62CD99DEABA5E22F4C6EDC560C669C30FA8"},{"channel":2006,"data":"C34D1CF1D98CC7B794B43A9B62CD99DEABA5E22F4C6EDC560C669C30FA8"}]}' 'https://test.mogs.qq.com:10005/mobile/getmask?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
msgId string 是 网关URL接口返回的msgId
deviceIdType int32 是 设备ID类型,如果无法获取,填默认值
deviceId string 是 设备ID
tokenList Array(Object) 是 网关token列表
  • Object参数说明（Json格式）
字段名 类型 描述
channel int32 渠道号
data string 运营商网关返回的数据. 前端Base64编码后的数据
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功,具体错误码可以查看网关取号文档km.oa.com/group/11775/attachments/attachment_view/230955
status string 状态码,用于系统排查错误
message string 返回码描述
msgId string 每次请求均会返回不同的msgId
token string mogs生成的token
tokenValidTime int32 token有效期,单位为秒
maskData Object 掩码手机号数据
  • Object参数说明（Json格式）
字段名 类型 描述
channel int32 合作方渠道标识
channelCarrierType int32 合作方所属的运营商类型
maskMobile string 脱敏手机号，一般是手机号中间4位打星'*',ASCII(10进制)值为42
carrierType int32 用户手机号承载的运营商类型编码

# 获取真实手机号

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/getmobile
  • 使用示例:
curl -X POST -d '{"msgId":"2012141190478705611513856","deviceIdType":1,"deviceId":"abcde","maskMobile":"133****3333","token","aaaaaaaaa","tokenList":[{"channel":2006,"data":"C34D1CF1D98CC7B794B43A9B62CD99DEABA5E22F4C6EDC560C669C30FA8"},{"channel":2006,"data":"C34D1CF1D98CC7B794B43A9B62CD99DEABA5E22F4C6EDC560C669C30FA8"}]}' 'https://test.mogs.qq.com:10005/mobile/getmobile?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
msgId string 是 网关URL接口返回的msgId
deviceIdType int32 是 设备ID类型,如果无法获取,填默认值
deviceId string 是 设备ID
maskMobile string 是 用户掩码手机号
token string 是 mogs服务端在掩码接口中返回的token
tokenList Array(Object) 是 网关token列表
  • Object参数说明（Json格式）
字段名 类型 描述
channel int32 渠道号
data string 运营商网关返回的数据. 前端Base64编码后的数据
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功,具体错误码可以查看网关取号文档km.oa.com/group/11775/attachments/attachment_view/230955
status string 状态码,用于系统排查错误
message string 返回码描述
msgId string 每次请求均会返回不同的msgId
token string mogs生成的token
tokenValidTime int32 token有效期,单位为秒
mobileData Object 真实手机号数据
  • Object参数说明（Json格式）
字段名 类型 描述
mobile string 用户真实手机号
channel int32 合作方渠道标识
channelCarrierType int32 合作方所属的运营商类型
station string 用户手机号归属号段，例如gdgmcc表示广东移动
provCN string 用户手机号地区中文省份，例如 广东 UTF-8编码
carrierType int32 用户手机号承载的运营商类型编码
cityCode int32 用户手机号所属的城市编码
cityName string 用户手机号所属的城市名称

# 登录鉴权

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/auth

包含一键登录鉴权和手机验证码登录鉴权

  • 使用示例:
curl -X POST -d '{"mobile":"133****3333","token","aaaaaaaaa"}' 'https://test.mogs.qq.com:10005/mobile/auth?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
mobile string 是 手机号码.一键登录鉴权时为/mobile/getmobile接口返回的手机号；验证码登录时，采用 e.164 标准，格式为+[国家或地区码][手机号]
token string 是 服务端返回一键登录或者验证码登录的token
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功
message string 返回码描述

# 获取验证码

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/sendvcode
  • 使用示例:
curl -X POST -d '{"mobile":"+8613311113333"}' 'https://test.mogs.qq.com:10005/mobile/sendvcode?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
mobile string 是 手机号码，采用 e.164 标准，格式为+[国家或地区码][手机号]
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功
message string 返回码描述
resendTime int32 有效重发时间,单位为秒

# 验证码登录校验

# 接口名

测试环境 https://test.mogs.qq.com:10005/mobile/vcodeauth
  • 使用示例:
curl -X POST -d '{"mobile":"+8613311113333", "vcode": "123456"}' 'https://test.mogs.qq.com:10005/mobile/vcodeauth?appid=10000&openid=opvxI4-mx2SlVhpOYdwOJ_GEA5Oc'
1
  • URL请求参数说明
参数 类型 是否必填 描述
appid uint64_t 是 MOGS给游戏侧分配的游戏ID，是游戏的唯一标识
openid string 是 玩家的唯一标识,不做强制校验
  • Body请求参数说明（Json格式）
参数 类型 是否必填 描述
mobile string 是 下发手机号码，采用 e.164 标准，格式为+[国家或地区码][手机号]
vcode string 是 验证码
  • 响应参数说明（Json格式）
字段名 类型 描述
code int32 返回码,0表示成功
message string 返回码描述
token string 验证码登录的token

# 附录

  • 客户端类型编码
客户端类型 编码
默认值 0
PC WEB页面 10010
PC 客户端 10020
wap或者h5页面 20010
安卓TV客户端 30040
安卓客户端 30100
安卓平板 30200
IOS手机客户端 30300
IOS平板 30400
Windows Phone 客户端 30500
Windows Phone 平板 30600
  • 设备ID类型编码
设备ID类型 编码
默认值 0
国际移动设备识别码 1
IOS广告标识符 2
腾讯内部设备标识 3
  • 运营商类型编码
运营商类型 编码
默认值 0
移动 1
联通 2
电信 3

← 帧同步适配层接口 →