QQ游戏 开放平台

欢迎来到QQ游戏开放平台 管理中心 | 注册 | 开发者论坛
蓝钻接入API列表

5.6 /v3/message/send_notification

向玩家发送发游戏通知,其表现形式是QQ游戏大厅tips,测试时需请确认目标号码登录QQGame大厅,点击弹出的tips效果如下:

5.6.1 URL

//[域名/IP]/v3/message/send_notification

5.6.2 格式

JSON

5.6.3 HTTP请求方式

GET

5.6.4 IP限制

TRUE

5.6.5 输入参数说明

参数 类型 含义 可选/必选
appid int 详见公共参数说明部分 必选
openid string 详见公共参数说明部分 必选
openkey string 详见公共参数说明部分 必选
sig string 详见公共参数说明部分 必选
charset string 指定请求及响应的字符集, 可选取值为gbk和utf-8, 默认值为gbk, 其他非法取值也认为是gbk 可选
pf string 详见公共参数说明部分 必选
seq int 回传字段 可选
title string 通知标题,最大长度为32字节 必选
text string 通知正文,最大256字节 必选
imgurl string 图像地址,最大512字节,图片大小要求32px*32px 必选
ctxcmd string 点击正文的链接,最大128字节,需配置为QQGame大厅内部链接(本链接需要授权后才能使用,请通过企业QQ联系"商务&产品支持"提供申请) 必选
viewtxt string “查看”按钮的文字,最大32字节 可选
viewcmd string ”查看”按钮的链接,最大128字节,需配置为QQGame大厅内部链接(本链接需要授权后才能使用,请通过企业QQ联系"商务&产品支持"提供申请) 必选
displaytime int 消息停留时间, 默认为5, 最大30 可选

5.6.6 请求事例

//113.108.20.23/message/send_notification?
openid=000000000000000000000000032373DF&
openkey=39DBE00A043F8DB011391759A3A8A250A453B88C079C516CB4AAC0F4691C931F3679B97D0A61560569095307220E4D2210DE35F24BF630F25DE6A290994A8735&
appid=28240&
pf=qqgame&
title=notice_title&
text=this is notice&
Imgurl=//minigameimg.qq.com/hello.gif&
Ctxcmd=//qq.com&
Viewcmd=//qq.com&
sig=e3evlGSde+JQ0AodlAn5RoX6InA=

返回参数说明

参数 类型 含义
ret int 详见公共返回码
msg string 错误描述
seq int 回传字段

5.6.7 正确返回示例

{"ret":0,
"msg":"操作成功!",
"seq":0}

5.6.8 错误返回示例

参见公共错误返回示例

Notice:

该api限定为特定应用场景,具体场景请参见“window.external.WebCallSetNoticeValid”。调试时,可以按照以下步骤配置大厅:
1 进入大厅安装路径$HALL_HOME, 进入$HALL_HOME\config\Users\$UIN路径,$UIN为调试号码,如使用188322071进行调试,则进入以下路径:“D:\hall_idc\QQGAME\config\Users\188322071”
2. 修改Config.ini,加入以下两行内容,保存后重启大厅。
[SNSNotice]
SNSGame$APPID=1
$APPID为应用id,例如appid=10007,需要加入以下两行:
[SNSNotice]
SNSGame10007=1
其次,send_notice的表现形式是QQ游戏大厅tips,请确认自己的号码登录了大厅,且登录的大厅环境要和调用openapi的环境一致。比如调用的openapi是内网环境,那也必须登录内网环境的大厅。

注意:该tips并不是强制最前显示,所以,请调整大厅至可视区域

点击弹出的tips效果如下: