v3/spread/set_reminder

特别提示:
应用在接入QQ提醒时需要申请接口权限,申请详情请参见QQ提醒渠道接入流程

目录

1 功能说明

QQ提醒信息上报接口,可一次上报多条数据(详见参数说明中关于X的规定)。
应用获得用户授权后,向用户发送提醒,适用于有冷却时间玩法的应用场景,以拉取回流用户,详见:QQ提醒渠道简介#2. 效果展示
本接口需与接口 fusion2.dialog.authReminderv3/spread/is_reminder_set 配套使用,完成QQ提醒功能。

注:
本接口目前只支持QQ空间平台,朋友和微博平台暂不支持。

2 接口调用说明

2.1 URL

http://[域名]/v3/spread/set_reminder

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

2.2 格式

json,xml

2.3 HTTP请求方式

POST

2.4 IP限制

TRUE

2.5 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数
输入的私有参数为应用需要给出的提醒相关信息。
注意:
--x为提醒信息的序号,从0开始递增,最大为2的整数。即最多可以设置3条提醒信息。
--每次上报的提醒信息会把上一次的替换。例如上一次上报了3条提醒信息(x从0-2),这一次上报了2条提醒信息(x从0-1),则这一次上报成功后,生效的提醒信息只有2条。
--以下四个参数都为必传参数,如果有参数没有传,仍然返回成功,但是在联调时会失败(腾讯开放平台正在优化接口返回值,如果出现必传参数为空,会返回相应的错误码)。



参数名称 是否必须 类型 描述
beginx 必须 string 提醒开始时间(unix时间戳,指从UTC时间1970年1月1日00:00:00到当前时刻的秒数)。
keyx 必须 string 发送提醒时,应用中某个目标的标识,由应用自定义(如QQ农场提醒用户某块地的果实成熟了,这块地的id即为key的值)。
typex 必须 string 发送提醒时,提醒的类型,由应用自定义,必须是20000以上的整数。
titlex 必须 string 提醒的具体内容,长度限制在30个汉字以内,受限于展示的宽度,建议在20个汉字以内。

2.6 请求示例

POST请求包示例(这里仅为示例,不能直接拷贝,请根据应用的实际情况输入相应的参数值):

POST /v3/spread/set_reminder HTTP/1.1
Host: 113.108.20.23
Content-Type: application/x-www-form-urlencoded
Content-Length: 352
Connection: Keep-Alive
Cache-Control: no-cache


openid=08B8273CACFBE0D9F57CAB4E7D8AAAA0&openkey=9999999917C28878F66F28E7F16B7F89E7E752D589B8B261&
appid=12345&sig=9999b41ad0b688530bb1b21c5957391c&pf=qzone&format=json&userip=112.90.139.30&
begin0=1320000000&key0=17C28&type0=20100&title0=%E8%8B%B9%E6%9E%9C%E6%88%90%E7%86%9F%E4%BA%86(“苹果成熟了”的URL编码)
&begin1=1320002020&key1=88998&type1=20101&title1=%E8%8A%B1%E5%84%BF%E8%AF%A5%E6%B5%87%E6%B0%B4%E4%BA%86
(“花儿该浇水了”的URL编码)
&begin2=1320003050&key2=18999&type2=20102&title2=%E8%AF%A5%E5%8E%BB%E5%96%82%E5%B0%8F%E5%AE%A0%E7
%89%A9%E4%BA%86(“该去喂小宠物了”的URL编码)

2.7 返回参数说明

参数名称 描述
ret 返回码。

私有返回码如下:
2000:提醒内容中包含敏感词,或非法字符。
2001:非法应用,通常是未授权应用。
2003:超过上报阈值。每次最多可以上报3条提醒信息。
公共返回码详见:公共返回码说明#OpenAPI V3.0 返回码

msg 如果错误,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

2.8 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
"ret":0,
"is_lost":0,
"msg":""
}

2.9 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret":1002,
"msg":"请先登录"
}

3 联调说明

详见:QQ提醒渠道开发联调说明#2. 测试联调说明

4 效果展示

详见:QQ提醒渠道简介#2. 效果展示

相关文档

上一步:v3/spread/is_reminder_set

相关文档:QQ提醒渠道开发联调说明 | faq/QQ提醒渠道相关常见问题

以上信息是否解决您的问题?

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部