v3/spread/is_reminder_set

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

目录

1 功能说明

应用不知道用户是否开启了QQ提醒功能,无法更好地引导用户使用提醒,或借用提醒开展运营活动。
应用调用本接口可判断用户是否安装了“QQ提醒”应用,以及是否在“QQ提醒”中开启了提醒。
关于“QQ提醒”开启提醒功能的相关说明,详见:QQ提醒渠道简介#2. 效果展示
本接口需与后台接口 fusion2.dialog.authReminderv3/spread/set_reminder 配套使用,完成QQ提醒功能。

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

2 接口调用说明

2.1 URL

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

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

2.2 格式

json

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

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

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

(2)私有参数

参数名称 是否必须 类型 描述
cmd 必须 string 需要获取的不同状态。

0:获取用户是否安装了“QQ提醒”应用;
1:获取用户是否在“QQ提醒”应用中开启了提醒;
2:同时获取用户是否安装了“QQ提醒”应用,以及是否在“QQ提醒”中开启了提醒。

2.6 请求示例

http://openapi.tencentyun.com/v3/spread/is_reminder_set?
openid=B624064BA065E01CB73F835017FE96FA&
openkey=5F154D7D2751AEDC8527269006F290F70297B7E54667536C&
appid=2&
pf=qzone&
format=json&
userip=112.90.139.30&
cmd=1&
sig=9999b41ad0b688530bb1b21c5957391c

2.7 返回参数说明

参数名称 描述
ret 返回码。

公共返回码详见:公共返回码说明#OpenAPI V3.0 返回码

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

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

setup 表示用户是否安装了“QQ提醒”应用。

0:用户没有安装“QQ提醒”应用;
1:用户安装了“QQ提醒”应用。

reg 表示用户是否在应用中开启了提醒功能。

-1:用户没有在“QQ提醒”里开通该应用的提醒功能;
0:用户没有开启该应用的提醒功能;
1:用户开启了该应用的提醒功能。

2.8 正确返回示例

JSON示例:
当cmd=0时:

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

当cmd=1时:

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

当cmd=2时:

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

2.9 错误返回示例

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

相关文档

下一步:v3/spread/set_reminder

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

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

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部