SDK 开放 API

渠道用户信息接口查询

此接口是通过 SDK channelUid 查询渠道用户信息

Host

• platform.hoolai.com

协议

• Http
• https

方法

• POST

路径

• /open/public/queryUser/{channel}
  channel：路径参数，当前的渠道名，例如:uc

请求头

• Content-Type: application/json

请求参数

参数名	类型	描述
productId	Integer/int	游戏产品 ID
channelId	Integer/int	渠道 ID
channelUid	String	查询渠道 uid

请求响应

• 正确响应

{
    "code": "SUCCESS",
    "requestId": "96501_174_1688093800",
    "value": {
        "openId": 199347787,
        "channelUid": "95715592e17eb7a21a64cc24e680b16e",
        "channel": "uc"
    },
    "group": "SUCCESS",
    "desc": "SUCCESS"
}

注意

code 为 SUCCESS 为查询成功，其他均为失败

• 错误响应

{
    "code": "QUERY_INFO_NOT_EXIST",
    "requestId": "3_1010167180_1697598882304",
    "desc": "查询信息不存在",
    "group": "open"
}

TIP

注意：上面只是查询信息不存在的示例，错误响应只是其中一种

公众号根据手机号查询用户信息接口查询

Host

• platform.hoolai.com

协议

• Http
• https

方法

• POST

路径

• /open/public/queryUser/officialAccount

请求头

• Content-Type: application/json

签名密钥

• 联系 SDK 获取

请求参数

参数名	类型	描述
phone	String	手机号
timestamp	Long/long	时间戳 毫秒
sign	String	签名 MD5(phone+productId+timestamp+秘钥)的32位小写
productId	Int	产品Id

请求响应

参数名	类型	描述
code	String	SUCCESS 为成功
value	JSON

• value 属性

参数名	类型	描述
realNameStatus	Boolean	true:实名 false:未实名
userInfo	JSONArray

• userInfo 属性

参数名	类型	备注
productId	Integer
openId	Long

• 正确响应

{
    "code": "SUCCESS",
    "group": "SUCCESS",
    "value": {
        "realNameStatus": true,
        "userInfo": [
            {
                "openId": 201000641,
                "productId": 1
            },
            {
                "openId": 199347706,
                "productId": 73
            }
        ]
    },
    "desc": "SUCCESS",
    "requestId": "3_1010167180_1697598882304"
}

注意

code 为 SUCCESS 为查询成功，其他均为失败

• 错误响应

{
    "code": "SIGN_NOT_MATCH",
    "group": "open-api",
    "desc": "签名不匹配",
    "requestId": ""
}

注意

上面只是一种错误的示例

发送验证码

Host

• platform.hoolai.com

协议

• Http
• https

方法

• POST

路径

• /open/public/sms/sendSms

请求头

• Content-Type: application/json

签名密钥

• 联系 SDK 获取

请求参数

参数名	类型	描述
productId	Integer	产品 Id
mobile	String	手机号码,多个号码用英文逗号(,)隔开
templateId	Integer	模板短信 ID， 用于指定需要的短信模板。
params	String	短信参数，用于填充模板短信中的变量， 多个参数之间使用英文逗号(,)隔开。如果是个性群发，每个号码对应参数需要用英文分号(;)隔开。
accessToken	String	使用 MD5 加密 productId+"."+requestTime+"."+productKey 返回十六进制 32 位小写字符串
requestTime	Long	发出请求时的当前时间，单位毫秒。
separator(可选)	String	自定义分割符.如果不加这个参数,则默认使用英文逗号对参数 params 进行分割;如果加上这个,则使用它进行分割。目前允许的自定义分割符为"

请求响应

参数名	类型	描述
code	String	SUCCESS 为成功
value	String	值
desc	String	描述
requestId	String	请求 ID
group	String	组

• 正确响应

{
    "code": "SUCCESS",
    "requestId": "92982_124_1698634202",
    "value": "SUCCESS",
    "desc": "SUCCESS",
    "group": "SUCCESS"
}

注意

code 为 SUCCESS 为查询成功，其他均为失败

• 错误响应

{
    "code": "SIGN_NOT_MATCH",
    "group": "open-api",
    "desc": "签名不匹配"
}

注意

上面只是一种错误的示例

屏蔽字库/图片

此接口是通过 SDK API服务支持敏感信息/图片检验

Host

• platform.hoolai.com

协议

• Http
• https

方法

• POST

路径

• /open/public/sensitive/moderation

请求头

• Content-Type: application/json

请求参数

参数名	类型	描述	必选	可选值
productId	Integer	产品ID	是
type	String	数据类型（图片/文本）	是	image/text
scene	String	使用场景(聊天、取名等)	否	可自定义场景名称和规则 需在腾讯云后台配置生效后使用
uid	Long	SDK用户ID	是	30000xxxxx
roleId	String	角色ID	是	游戏角色Id
content	String	内容	是	聊天文本/base64(图片)，image只支持小于10MB的
sign	String	签名	是	md5(productId+type+uid+roleId+content+timestamp+key).timestamp

• 注意：key为SDK提供的签名key，timestamp为uninx时间戳，有效时间为5分钟

请求响应

• 响应

{
    "code": "SUCCESS",
    "group": "open-api",
    "requestId": "12244_323523_4322452",
    "value": {
        "suggestions": "pass",
        "showLabel": "你个****，开团跑了",
        "reason": "具体原因，可选"
    }
}

注意

code 为 SUCCESS 为查询成功，其他均为失败

• suggestions: 可选值pass/block（当值为block时，建议游戏直接提示用户“含有敏感字符”）
• showLabel: 只有文本内容会有建议展示的过滤文本
• reason: 具体原因，可选(可能会不存在，不建议使用此文本作为游戏内相关展示)