基础说明
欢迎您敬启御风猫官方文档!御风猫及她的生态系统致力于为用户和服务商提供智造快乐的超能力——活动社交圈。嘿,您绝对不敢相信,御风猫就是这样一款为她的朋友授之于渔和鱼的平台。一方面,御风猫和她的生态圈正方兴未艾地发展壮大,另一方面,您竟然也来了,这真是太好了!嗯哼,我们快来开始吧。
御风猫开放平台是御风猫社群运营者通过飞猫号为御风猫用户提供服务和信息的平台,而开放平台为开发者提供的接口则是提供服务的基础,开发者在御风猫移动端创建或绑定飞猫号后并成功进行认证后,可以通过阅读本接口文档来获得御风猫开放能力。
御风猫开放平台的账户是以御风猫用户申请注册的飞猫号账户形式存在的,许多复杂的业务场景,可以通过御风猫开放平台的能力予以多端支持,开发者需以access_token为接口调用凭据来调用接口,所有接口的调用需要先获取access_token,access_token在2小时内有效,过期需要重新获取,但每天该字段获取次数有限,开发者需自行存储,获取access_token方式详见获取Token文档。
不同的账号类型可能具备不同的开放能力权限,详细如下表:
接口名称 | 未认证飞猫号 | 个体认证飞猫号 | 服务商飞猫号 |
---|---|---|---|
获取access_token | × | √ | √ |
基础开放能力 | × | √ | √ |
增强开放能力 | × | × | √ |
开发者在开发时,还需特别注意模版消息、用户数据等敏感信息的使用规范。
涉及用户数据时:
(1)您的服务需要收集用户任何数据的,必须事先获得用户的明确同意,且仅应当收集为运营及功能实现目的而必要的用户数据, 同时应当告知用户相关数据收集的目的、范围及使用方式等,保障用户知情权;
(2)您收集用户的数据后,必须采取必要的保护措施,防止用户数据被盗、泄漏等;
(3)如果游帆公司认为您收集、使用用户数据的方式,可能损害用户体验,游帆公司有权要求您删除相关数据并不得再以该方式收集、使用用户数据;
(4)一旦您停止使用本服务,或游帆公司基于任何原因终止您使用本服务,您必须立即删除全部因使用本服务而获得的数据(包括各种备份), 且不得再以任何方式进行使用。
并且,您还需遵从如下规范:
(1)请勿为任何用户自动登录到御风猫开放平台提供代理身份验证凭据;
(2)请勿提供跟踪功能,包括但不限于识别其他用户在个人主页上查看、点击等操作行为;
(3)请勿自动将浏览器窗口定向到其他网页,以及设置或发布任何违反相关法规、公序良俗、社会公德等的玩法、内容等;
(4)请勿公开表达或暗示,您与游帆公司之间存在合作关系,包括但不限于相互持股、商业往来或合作关系等,或声称游帆公司对您的认可。
完整的开发者规范和接口限制,请详见御风猫开放平台开发者接口文档,以及御风猫开放平台开发者协议。本文档是一份动态更新的文档,我们会根据新出现的问题、相关法律法规更新或产品运营的需要来对其内容进行修改并更新,制定新的规则,保证御风猫用户的体验。你应能反复查看以便获得最新信息,请定期了解更新情况。
2019-12-18 御风猫开放平台官方文档(Beta1.0)上线!
快速开始
开发者需在后台进行URL、Token参数的配置。其中,URL是开发者用来接收消息和事件的接口URL,Token可由开发者可以任意填写,用作生成签名(该Token会和接口URL中包含的Token进行比对,从而验证安全性)。
开发者提交信息后,御风猫开放平台服务器将发送GET请求到填写的服务器地址URL上,开发者可以验证消息是否是来自此服务器。返回回的GET请求携带参数如下表所示:
参数 | 是否必须 | 说明 |
---|---|---|
signature | 是 | signature结合了开发者填写的token参数和请求中的timestamp参数 |
timestamp | 是 | 时间戳 |
randomstr | 是 | 随机字符串 |
若开发者通过检验signature对请求进行校验,可验证是否成功配置,如果signature符合预期,开发者需原样返回randomstr,之后接入方可正式生效,否则接入失败。其signature校验方法如下:将token、timestamp参数依次拼接好进行md5加密;开发者获得加密后的字符串与signature对比,标识该请求来源于御风猫开放平台。
检验signature的PHP示例代码:
code
- private function checkSignature(){
- $signature = $_GET["signature"];
- $timestamp = $_GET["timestamp"];
- $token = TOKEN;
- $tmpStr = md5($token.$timestamp);
- if( $tmpStr == $signature ){
- return true;
- }else{
- return false;
- }
- }
验证URL有效性成功后即接入生效,开发者填写的服务器配置URL将得到御风猫开放平台服务器推送过来的消息和事件,开发者可以依据自身业务逻辑进行响应。
access_token是御风猫开放平台API的全局唯一接口调用凭据,调用开放平台各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效。
开放平台的API调用所需的access_token的使用及生成方式说明:
1、建议开发者使用中控服务器统一获取和刷新access_token,其他业务逻辑服务器所使用的access_token均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致access_token覆盖而影响业务;
2、目前access_token的有效期通过返回的expire_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access_token。在刷新过程中,中控服务器可对外继续输出的老access_token,此时公众平台后台会保证在5分钟内,新老access_token都可用,这保证了第三方业务的平滑过渡;
3、access_token的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新access_token的接口,这样便于业务服务器在API调用获知access_token已超时的情况下,可以触发access_token的刷新流程;
4、用户在开放平台创建应用后可以使用AppID和AppSecret调用本接口来获取access_token。AppID和AppSecret可在“御风猫开放平台-开发者”页中获得(需要帐号没有异常状态,并且开发者已经完成服务商认证)。
参数 | 是否必须 | 说明 |
---|---|---|
grant_type | 否 | 开发者获取access_token时由系统填写默认值为1 |
appid | 是 | 第三方用户唯一凭证,即AppID |
appsecret | 是 | 第三方用户唯一凭证密钥,即AppSecret |
正常情况下会返回下述JSON数据包给开发者:
code
- {"status":200, "access_token":"ACCESS_TOKEN","expires_in":7200}
错误时会返回错误码等信息,JSON数据包示例如下(示例为AppID无效):
code
- {"status":201,"msg":"Invalid appid!"}
消息管理
当普通用户向御风猫开放平台开发者账号发消息时,开发者填写的URL将收到御风猫开放平台以POST方式回送的JSON数据包。御风猫开放平台服务器在五秒内收不到开发者服务器响应会断掉连接,并且重新发起请求,总共重试三次。假如开发者服务器无法保证在五秒内处理并回复,可以直接回复空串,开放平台服务器不会对此作任何处理,并且不会发起重试。
开发者取得的JSON数据包格式如下:
消息类别号(type) | 消息类别 | 取得JSON数据包格式 |
---|---|---|
1 | 文本消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":1,"content":发送的消息内容,"msgid":消息ID} |
2 | 语音消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":2,"sourceid":语音资源的ID号,"msgid":消息ID} |
*21 | *增强语音消息(带语音识别) | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":2,"sourceid":语音资源的ID号,"abstract":语音资源识别为文本摘要,"msgid":消息ID} |
3 | 图片消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":3,"imgurl":图片链接(由系统生成),"sourceid":图片资源的ID号,"msgid":消息ID} |
4 | 视频消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":4,"imgurl":缩略图图片链接(由系统生成),"imgsid":缩略图图片资源的ID,"sourceid":视频资源的ID号,"msgid":消息ID} |
5 | 定位消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":5,"x":位置纬度,"y":位置经度,"label":"位置信息","msgid":消息ID} |
6 | 圈子消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":6,"circleid":圈子ID号,"cname":圈子的名称信息,"msgid":消息ID} |
9 | 活动消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":9,"activityid":活动资源的ID号,"aname":活动名称,"msgid":消息ID} |
*12 | 链接消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":12,"title":链接标题信息",description":链接描述信息,"url":消息链接,"msgid":消息ID} |
*14 | 事件消息 | {"status":200,"to":开发者openid,"from":发送者openid,"createtime":"2019-12-18 22:00:00","type":14,"event":事件名称,"msgid":消息ID} |
当用户发送消息给开发者时(或某些特定的用户操作引发的事件推送时),会产生一个POST请求,开发者可以在响应包(Get)中返回特定JSON数据包,来对该消息进行响应(支持回复文本、语音、图片、视频、活动)。
假如服务器无法保证在五秒内处理并回复,必须做出下述回复,这样御风猫开放平台服务器才不会对此作任何处理,并且不会发起重试:直接回复success(推荐),或者直接回复空串(指字节长度为0的空字符串,而不是JSON数据包中content字段的内容为空)。
回送JSON数据包格式如下:
消息类别号(type) | 回复消息类别 | 回送JSON数据包格式 |
---|---|---|
1 | 文本消息 | {"to":接收者飞猫号,"from":开发者openid,"createtime":消息创建时间,"type":1,"content":发送的消息内容"} |
2 | 语音消息 | {"to":接收者飞猫号,"from":开发者openid,"createtime":消息创建时间,"type":2,"sourceid":素材中语音资源的ID} |
3 | 图片消息 | {"to":接收者飞猫号,"from":开发者openid,"createtime":消息创建时间,"type":3,"sourceid":素材库中图片资源的ID号} |
4 | 视频消息 | {"to":接收者飞猫号,"from":开发者openid,"createtime":消息创建时间,"type":4,"sourceid":素材库中视频资源的ID号} |
9 | 活动消息 | {"to":接收者飞猫号,"from":开发者openid,"createtime":消息创建时间,"type":9,"activityid":活动管理中的活动ID号} |
御风猫开放平台为开发者提供了每个圈子每天一条的群发权限,超过数量限制后将调用失败。以群发一条图片消息为例,群发此条消息的过程如下:先将图文消息中需要用到的图片,使用上传图文消息内图片接口,上传成功并获得图片的sourceid;其中上传的图片仅支持jpg/png格式,大小必须在1024KB以下(使用上传图片素材的接口文档可见本文档素材管理部分)。使用上一步得到的sourceid对圈子的用户进行图片消息群发。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
totag | 否 | 默认为空,表示对所有用户发送;不为空则填写用户的标签号,以仅对此标签组用户发送 |
type | 是 | 群发消息类型号(1文本 2语音 3图片 4视频 9活动) |
content | 当type为1时必要 | 文本消息的内容 |
sourceid | 当type为2、3、4时必要 | 素材库对应的素材ID号 |
activityid | 当type为9时必要 | 用户圈子下设活动的活动ID号 |
返回数据示例(正确时的JSON返回结果):
code
- {
- "status":200,
- "msg":"send job submission success",
- "taskid":群发任务号
- }
在返回成功时,意味着群发任务提交成功,并不意味着此时群发已经结束,所以,仍有可能在后续的发送过程中出现异常情况。或消息有时会进行审核,以及群发任务需要较长时间发送等原因,导致用户未及时收到消息,耐心等待的同时,建议开发者保持对该群发任务的关注。
素材管理
开发者经常有需要用到一些临时性的多媒体素材的场景,例如在使用接口特别是发送消息时,对多媒体文件、多媒体消息的获取和调用等操作,是通过sourceid来进行的。
语音(type:2):2M,播放长度不超过60s,支持AMR\MP3格式
图片(type:3): 2M,支持PNG\JPEG\JPG\GIF格式
视频(type:4):10MB,支持MP4格式
http请求方式:POST/FORM https://op.yfcat.com/api/material/upload?access_token=ACCESS_TOKEN&type=TYPE
调用示例(使用curl命令以FORM表单方式上传图片):
curl -F file=@material.jpg https://op.yfcat.com/api/material/upload?access_token=ACCESS_TOKEN&type=2
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
type | 是 | 素材类型,取值为:2(语音)、3(图片)、4(视频) |
file | 是 | form-data中媒体文件标识,有filename、filelength、content-type等信息 |
正常情况下会返回下述JSON数据包给开发者:
code
- {"status":200,"type":素材类型,"sourceid":资源ID,"createtime":创建时间}
错误情况下的返回JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或{"status":202,"msg":" Invalid file type."}
开发者可以使用本接口获取素材,其中视频素材采用http协议,语音、图片素材采用https协议获取。
https请求方式: GET https://op.yfcat.com/api/material/get?access_token=ACCESS_TOKEN&sourceid=SOURCEID
请求示例(通过curl命令获取素材文件):
curl -I -G "https://op.yfcat.com/api/material/get?access_token=ACCESS_TOKEN&sourceid=SOURCEID"
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
sourceid | 是 | 素材ID号 |
type | 是 | 素材类型 2语音 3图片 4视频 |
(1)视频类型(素材类型码type为4)返回JSON数据包示例如下:
code
- {"status":200,"type":4,,"imgurl":缩略图图片链接,"imgsid":缩略图图片资源的ID,"sourceid":视频资源的ID号,"url":视频素材的存储路径地址}
(2)语音类型(素材类型码type为2)返回HTTP头如下:
code
- HTTP/1.1 200 OK
- Connection: close
- Content-Type: voice/speex
- Content-disposition: attachment; filename="SOURCE_ID.speex"
- Date: Sun, 28 Jan 2019 12:40:36 GMT
- Cache-Control: no-cache, must-revalidate
- Content-Length: 235598
- curl -G "https://op.yfcat.com/api/material/get/jssdk?access_token=ACCESS_TOKEN&sourceid=SOURCEID"
(3)图片类型(素材类型码type为3)返回HTTP头如下:
code
- HTTP/1.1 200 OK
- Connection: close
- Content-Type: image/jpeg
- Content-disposition: attachment; filename="SOURCE_ID.jpg"
- Date: Sun, 28 Jan 2019 12:40:36 GMT
- Cache-Control: no-cache, must-revalidate
- Content-Length: 795642
- curl -G "https://op.yfcat.com/api/material/get?access_token=ACCESS_TOKEN&sourceid=SOURCE_ID"
错误情况下的返回JSON数据包示例如下:
code
- {"status":201,"msg":"Failed to get."}
开发者可以根据本接口来删除不再需要的素材以节省空间。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
sourceid | 是 | 素材ID号 |
type | 是 | 素材类型 2语音 3图片 4视频 |
正确情况下的返回JSON数据包结果如下:
code
- {"status":200,"msg":"Delete successfully."}
错误情况下的返回JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或{"status":201,"msg":"Failed to delete."}
开发者可以根据本接口来获取素材的列表,需要时也可保存到本地。
正确情况下的返回JSON数据包结果如下:
code
- {
- "status":200,
- "voice_count":语音素材数量,
- "video_count":视频素材数量,
- "image_count":图片素材数量
- }
错误情况下的返回JSON数据包示例如下:
code
- {"status":201,"msg":"System error."}
开发者可以分类型获取素材列表。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
type | 是 | 素材类型,取值为:2(语音)、3(图片)、4(视频) |
offset | 是 | 从全部素材的该偏移位置开始返回,0表示从第一个素材返回,默认值为0 |
count | 是 | 返回素材的数量,取值在1到20之间,默认值为10 |
正确情况下的返回JSON数据包结果如下:
code
- {
- "status":200,
- "total_count": 素材总数,
- "item": [{
- "sourceid": 素材资源ID,
- "name": 素材资源文件名称,
- "createtime": 素材资源创建时间,
- "url":素材资源的URL
- },
- //可能有多个素材
- ]
- }
错误情况下的返回JSON数据包示例如下:
code
- {"status":201,"msg":"System error."}
用户运营
开发者可通过本接口来获取帐号的关注者列表,关注者列表由用户的openid组成。一次拉取调用最多拉取1000个关注者的openid,可以通过多次拉取的方式来满足需求。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
lastid | 否 | 为空则从头提取,否则提取自该用户openid之后的用户列表 |
total | 否 | 默认为1000,开发者希望一次提取的用户数 |
正确情况下的返回JSON数据包结果如下:
code
- {
- "status":200,
- "total":1000,
- "count":18,
- "data":{
- "openid":["OPENID1","OPENID2",...,"OPENID18"]},
- "nextid":"NEXT_OPENID"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
在关注者与开发者产生消息交互后,开发者可获得关注者的OpenID(加密后的飞猫号,每个用户对开发者每个应用的OpenID是唯一的。对于不同应用,同一用户的openid不同)。开发者可通过本接口来根据OpenID获取用户基本信息,包括昵称、头像、性别、所在城市、关注时间等信息。特别需要注意的是,如果开发者拥有多个应用,可通过获取用户基本信息中的unionid来区分用户的唯一性。同一用户,对同一个御风猫开放平台下的开发者账户,unionid是相同的。
https请求方式:POST https://op.yfcat.com/api/user/info?access_token=ACCESS_TOKEN
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {
- "status":200,
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL,
- "followtime":"2019-12-26 22:40:12",
- "unionid": "BOC83D2ELFNGO979COLJKJ6NOD9AO2CL",
- "remark": 粉丝的备注,
- "tags":[128,2],
- "followscene":1
- }
其中:follow字段表示用户是否关注:1关注0未关注(此时拉取不到其他信息);tags字段表示开发者为该用户打上的标签ID列表;followscene字段表示关注渠道来源:1平台内容自然展示、2名片分享、3扫码、4搜索、10其他。
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "data": [{
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL,
- "followtime":"2019-12-26 22:40:12",
- "unionid":"BOC83D2ELFNGO979COLJKJ6NOD9AO2CL",
- "remark":粉丝的备注,
- "tags":[128,2],
- "followscene":1
- },{
- "follow":0,
- "openid": "AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2"
- }]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
开发者可以通过该接口对指定用户设置备注名。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
remark | 是 | 新的备注名,长度必须小于24字符 |
正确时返回JSON数据包(openid为单个时):
code
- {"status":200,"msg":"Set successfully!"}
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "msg":"Set successfully!",
- "total":设置成功总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid openid!"}
开发者可以通过该接口移除关注用户。但应注意本接口每天移除的关注用户有限。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {"status":200,"msg":"Remove successfully!"}
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "msg":"Remove successfully!",
- "total":移除成功总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid openid!"}
开发者可通过本接口来获取帐号的黑名单列表,关注者列表由用户的openid组成。一次拉取调用最多拉取1000个黑名单用户的openid,可以通过多次拉取的方式来满足需求。
https请求方式: GET https://op.yfcat.com/api/user/getblacklist?access_token=ACCESS_TOKEN&lastid=LAST_OPENID
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
lastid | 是 | 为空则从头提取,否则提取自该用户openid之后的用户列表 |
total | 否 | 默认为1000,开发者希望一次提取的黑名单用户数 |
正确情况下的返回JSON数据包结果如下:
code
- {
- "status":200,
- "total":1000,
- "count":18,
- "data":{
- "openid":["OPENID1","OPENID2",...,"OPENID18"]},
- "nextid":"NEXT_OPENID"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
开发者可以通过该接口对除了自身的用户进行拉黑操作。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {"status":200,"msg":"Add to blacklist successfully !"}
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "msg":"Add to blacklist successfully!",
- "total":加入黑名单总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid openid!"}
开发者可以通过该接口对已加入黑名单用户进行取消拉黑(移除黑名单)操作。
https请求方式: POST https://op.yfcat.com/api/user/removeblacklist?access_token=ACCESS_TOKEN&opentid=OPENID
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {"status":200,"msg":"Remove from blacklist successfully !"}
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "msg":"Remove from blacklist successfully !"
- "total":移除黑名单总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid openid!"}
用户在关注与取消关注开发者当前账户时,御风猫开放平台会把这个事件推送到开发者填写的URL,方便开发者给用户下发欢迎消息或者做帐号的解绑。为保护用户数据隐私,开发者收到用户取消关注事件时需要删除该用户的所有信息。
开发者被用户关注时将在其于后台配置的消息接收接口将收到御风猫开放平台如下JSON格式的关注事件消息推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":关注时间,"type":14,"event":"follow","msgid":消息ID}
同样的,开发者在用户取消关注时将收到如下的JSON格式事件推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":取消关注时间,"type":14,"event":"cancelfollow","msgid":消息ID}
开发者收到该事件推送后需要进行相应回复(详见消息管理-消息回复部分),或者直接回复空字符串。
通过用户增减数据接口,开发者可以获取与御风猫开放平台官网后台统计模块类似但更灵活的数据,还可根据需要进行高级处理。应额外注意的是,开始时间、截止时间最大的时间跨度为7天。此时begin_date和end_date的差值若大于6,则会报错。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
begin_date | 是 | 查询开始时间,格式如"2018-06-05" |
end_date | 是 | 查询结束时间,格式如"2018-06-10" |
正确时返回JSON数据包:
code
- {
- "status":200,
- "data":[{
- "data":"2018-06-05",
- "newuser":3,
- "canceluser": 0
- },{
- "data":"2018-06-06",
- "newuser":8,
- "canceluser": 1
- },//更多数据
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Date Error!"}
通过获取累计用户数据接口,开发者可以获取与御风猫开放平台官网后台统计模块类似但更灵活的数据,还可根据需要进行高级处理。应额外注意的是,开始时间、截止时间最大的时间跨度为7天。此时begin_date和end_date的差值若大于6,则会报错。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
begin_date | 是 | 查询开始时间,格式如"2018-06-05" |
end_date | 是 | 查询结束时间,格式如"2018-06-10" |
正确时返回JSON数据包:
code
- {
- "status":200,
- "data":[{
- "data":"2018-06-05",
- "totaluser":306
- },{
- "data":"2018-06-06",
- "totaluser":312
- },//更多数据
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Date Error!"}
用户标签管理
开发者可以使用用户标签管理的相关接口,实现对公众号的标签进行创建、查询、修改、删除等操作,也可以对用户进行打标签、取消标签等操作。
https请求方式: POST https://op.yfcat.com/api/tag/create?access_token=ACCESS_TOKEN
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tag | 是 | 标签名,如“成都” |
正确时返回JSON数据包:
code
- {"status":200,"tagid":12}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Invalid tagname!"}
- 或
- {"status":203,"msg":"The length of tagname should less than 16!"}
- 或
- {"status":204,"msg":"You had created too many tags,and the total number of tags should be less than 128."}
该接口帮助开发者获取当前应用已创建的用户标签列表。
https请求方式: GET https://op.yfcat.com/api/tag/get?access_token=ACCESS_TOKEN
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
正确时返回JSON数据包:
code
- {
- "status":200,
- "data":[{
- "tagid":8,
- "tag":"成都"
- },{
- "tagid":9,
- "tag":"工作组"
- },
- //更多标签
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
该接口帮助开发者对已有用户标签进行编辑。
https请求方式: POST https://op.yfcat.com/api/tag/update?access_token=ACCESS_TOKEN
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tagid | 是 | 需要编辑的用户标签ID |
tag | 是 | 需要编辑的用户标签的新名称 |
正确时返回JSON数据包:
code
- {
- "status":200,
- "tagid":8,
- "tag":"成都市区"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Invalid tagname!"}
- 或
- {"status":203,"msg":"The length of tagname should less than 16!"}
该接口帮助开发者对已有用户标签进行删除。
https请求方式: POST https://op.yfcat.com/api/tag/delete?access_token=ACCESS_TOKEN
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tagid | 是 | 需要删除的用户标签ID |
正确时返回JSON数据包:
code
- {"status":200}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Invalid tagid!"}
该接口帮助开发者获取拥有某个标签的用户列表。其中total参数为一次获取条数,单次拉取默认最大为1000条。
https请求方式: GET https://op.yfcat.com/api/tag/getuserlist?access_token=ACCESS_TOKEN&lastid=LAST_OPENID
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tagid | 是 | 需要查询的用户标签ID |
total | 否 | 默认为1000条,开发者希望单次拉取的用户数 |
正确时返回JSON数据包:
code
- {
- "status":200,
- "total":1000,
- "count":18,
- "data":[{
- "openid":["OPENID1","OPENID2",...,"OPENID18"]},
- "nextid":"NEXT_OPENID"
- }]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Invalid tagid!"}
该接口帮助开发者批量为用户打标签。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tagid | 是 | 需要为这批用户打上的用户标签ID |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包:
code
- {
- "status":200,
- "msg":"Set successfully!",
- "total":设置成功总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
该接口帮助开发者批量为用户取消标签。
https请求方式: POST https://op.yfcat.com/api/tag/cancelusertag?access_token=ACCESS_TOKEN&lastid=LAST_OPENID
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
tagid | 是 | 需要为这批用户打上的用户标签ID |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包:
code
- {
- "status":200,
- "msg":"Cancel successfully!",
- "total":由于本次取消标签而产生影响的用户总数,
- "faillist":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2N2,BOB2JLFNDOA9FS9COJLJKJNGJ9AOY2N3"
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
圈子管理
该接口帮助开发者快速创建圈子。注意创建圈子上限不能超过该开发者的创建数目最大限制。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circlename | 是 | 拟创建的圈子名称 |
description | 是 | 圈子的描述 |
imgid | 是 | 圈子的封面图图片素材ID |
fieldid | 是 | 圈子所属领域ID,取值为7~25,详细参阅后文 |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Create successfully!","circleid":系统生成的该圈子ID}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
- 或
- {"status":203,"msg":"Fail to upload image!"}
该接口帮助开发者更新已经创建圈子的部分信息。其中:description、imgid、fieldid三个参数必须填写至少其中一个,并且保证circleid为开发者自己创建的圈子ID,否则将会更新失败。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
description | 否 | 圈子的描述 |
imgid | 否 | 圈子的封面图素材ID |
fieldid | 否 | 圈子所属领域ID,取值为7~25,详细参阅后文 |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Update successfully!"}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
该接口帮助开发者删除圈子。但此接口需要谨慎使用,且需要满足一定条件。目前御风猫开放平台中进行删除圈子需要拟删除圈子的圈子总人数小于等于1人时,方可执行删除。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Delete successfully!"}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
- 或
- {"status":203,"msg":"Deletion condition not met!"}
用户在申请、取消申请或者退出服务商创建的圈子时,御风猫开放平台会把这个事件推送到开发者填写的URL。
开发者在用户申请加入圈子时将在其于后台配置的消息接收接口将收到御风猫开放平台如下JSON格式的关注事件消息推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":申请时间,"type":14,"event":"applycircle","msgid":消息ID}
开发者在用户取消申请加入时将收到如下的JSON格式事件推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":取消申请时间,"type":14,"event":"cancelapplycircle","msgid":消息ID}
同样的,开发者在用户主动退出圈子时将收到如下的JSON格式事件推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":退出时间,"type":14,"event":"quitcircle","msgid":消息ID}
该接口帮助开发者查询其创建的圈子的状态,涵盖:圈子创建后审核中(type:3)/未查询到圈子或审核未通过(type:4)/圈子解散中(type:5)/圈子已被删除或解散(type:6)/正常免费圈子(type:1)/正常付费圈子(type:2) 状态,其中字段type表示查询到圈子的状态码。
https请求方式: GET https://op.yfcat.com/api/v2/circle/querystate?access_token=ACCESS_TOKEN&circleid=CIRCLE_ID
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Query the status of the circle successfully!",”type”:1}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
该接口帮助开发者查询其关联的圈子列表,若ismine参数设置为true,则仅仅查询开发者所创建或管理的圈子,否则将一并拉取开发者所加入、创建或管理的圈子列表。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
ismine | 否 | 默认为false。为true时则仅仅查询开发者所创建或管理的圈子,否则将一并拉取开发者所加入、创建或管理的圈子列表 |
正确时返回JSON数据包如下,其中,字段type表示查询到圈子的状态码:圈子创建后审核中(type:3) 未查询到圈子或审核未通过(type:4) 圈子解散中(type:5) 圈子已被删除或解散(type:6) 正常免费圈子(type:1) 正常付费圈子(type:2):
code
- {
- "status":200,
- "data":[{
- "circleid":40,
- "type":1,
- "ismine":1
- },{
- "circleid":42,
- "type":2,
- "ismine":1
- },{
- "circleid":45,
- "type":1,
- "ismine":0
- }]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
该接口帮助开发者查询圈子的详细信息:涵盖封面图、圈子名称、描述、参与者总数、参与者openid列表、圈子状态码(type目前于1~6取值,参考见上文)、圈子创建时间。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
正确时返回JSON数据包:
code
- {
- "status":200,
- "imgurl":圈子封面图URL,
- "circlename":圈子名称,
- "description":圈子描述,
- "count":18,
- "openid":["OPENID1","OPENID2",...,"OPENID18"],
- "type":1,
- "createtime":圈子创建时间
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
已知御风猫服务商创建的圈子的ID以及该圈子的参与用户openid可以在用户没有关注开发者的情况下拉取用户信息。本接口在满足以上条件下可以获得圈子用户的公开信息。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {
- "status":200,
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- }
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "data": [
- {
- "status":200,
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- },{
- "status":200,
- "follow":0,
- "openid":"BOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":2,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- },
- //更多数据
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
该接口可以拉取圈子类别信息,用于开发者以此创建或者更新圈子的类别。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
正确时返回JSON数据包:
code
- {
- "status":200,
- "data":[{
- "fieldid":7,
- "fieldtitle":"人像摄影",
- "description":"记录每一个值得记录的瞬间"
- },{
- "fieldid":8,
- "fieldtitle":"骑行",
- "description":"生命在于运动"
- },
- //更多数据
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
本接口可以帮助开发者查询当前圈子下的活动列表。其中count是获取的历史活动总数,activityid是历史活动ID数组。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
circleid | 是 | 开发者创建的圈子ID |
正确时返回JSON数据包:
code
- {
- "status":200,
- "count":18,
- "activityid":["ACTIVITYID1","ACTIVITYID2",...,"ACTIVITYID18"]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
活动管理
通过该接口帮助开发者新增活动。开发者需要提前将活动的说明图上传入素材库(一共最多选择9张图)。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
imgids | 是 | 素材库中的图片ID,多张用英文逗号,拼接隔开 |
title | 是 | 活动标题 |
description | 是 | 活动描述 |
starttime | 是 | 活动开始时间,如“2019-12-30 18:30” |
endtime | 是 | 活动结束时间,如“2019-12-30 20:30” |
circleid | 是 | 由服务商所创建的圈子ID |
address | 是 | 活动定位地址文本 |
position | 是 | 经纬度坐标,如“30.545341101,104.068774158”,与活动定位地址对应 |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Create successfully!","activityid":系统生成的该活动ID}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
通过该接口帮助开发者更新活动的部分信息:涵盖封面图、活动描述、活动开始时间、结束时间、活动定位以及经纬度坐标。需要注意的是imgids、description等选填参数需要至少有一个填写,以便此正确更新需要更新的数据。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 需要更新的活动ID |
imgids | 否 | 素材库中的图片ID,多张用英文逗号,拼接隔开 |
description | 否 | 活动描述 |
starttime | 否 | 活动开始时间,如“2019-12-30 18:30” |
endtime | 否 | 活动结束时间,如“2019-12-30 20:30” |
address | 否 | 活动定位地址文本 |
position | 否 | 经纬度坐标,如“30.545341101,104.068774158”,与活动定位地址对应 |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Update successfully!"}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
该接口帮助开发者关闭活动。但此接口需要谨慎使用,且需要满足一定条件。目前御风猫开放平台中进行关闭活动需要拟删除活动的参与总人数小于等于1人时,方可关闭活动。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 需要删除的活动ID |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Delete successfully!"}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
- 或
- {"status":203,"msg":"Deletion condition not met!"}
用户在申请参与、取消申请参与或者退出活动时,御风猫开放平台会把这个事件推送到开发者填写的URL。
开发者在用户申请加入圈子时将在其于后台配置的消息接收接口将收到御风猫开放平台如下JSON格式的关注事件消息推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":申请时间,"type":14,"event":"applyactivity","msgid":消息ID}
开发者在用户取消申请加入时将收到如下的JSON格式事件推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":取消申请时间,"type":14,"event":"cancelapplyactivity","msgid":消息ID}
同样的,开发者在用户主动退出圈子时将收到如下的JSON格式事件推送:
code
- {"status":200,"to":开发者openid,"from":发送者openid,"createtime":退出时间,"type":14,"event":"quitactivity","msgid":消息ID}
此接口帮助服务商获取活动详细信息及其活动参与用户的列表。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 开发者发起的活动ID |
关于返回值的部分字段说明:type字段为御风猫系统内部定义的活动类型(常见的类型编码有1:普通活动 2:认证用户发起公开活动 3:认证企业发起公开活动);count字段表示活动的参与总人数,openid是一个列出了参与者的openid数组,sources是一个列出了活动内容展示图URL的数组,personlimited是默认限制该次活动的人数,默认最高6人。正确时返回JSON数据包:
code
- {
- "status":200,
- "activityid":活动ID,
- "title":活动名称,
- "content":活动描述,
- "count":18,
- "openid":["OPENID1","OPENID2",...,"OPENID18"],
- "coversource":封面图URL,
- "sources":["SOURCEURL1","SOURCEURL2",...],
- "personlimited":6,
- "address":"四川省成都市武侯区吉泰路",
- "position":"30.545341101197145,104.068774158",
- "type":1,
- "createtime":活动创建时间
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
已知御风猫服务商发起的活动ID以及该活动的参与用户openid可以在用户没有关注开发者的情况下拉取用户信息。本接口在满足以上条件下可以获得活动参与用户的公开信息。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 开发者发起的活动ID |
openid | 是 | 用户openid,若有多个请用英文逗号,进行拼接多个openid为一个长字符串 |
正确时返回JSON数据包(openid为单个时):
code
- {
- "status":200,
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- }
正确时返回JSON数据包(openid为多个时):
code
- {
- "status":200,
- "data": [
- {
- "status":200,
- "follow":1,
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":1,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- },{
- "status":200,
- "follow":0,
- "openid":"BOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "nickname":"John",
- "sex":2,
- "city":"成都市",
- "province":"四川省",
- "country":"中国",
- "headimgurl":用户头像URL
- },
- //更多数据
- ]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
此接口帮助服务商进行活动参与者的管理,实现移除活动参与者功能。此功能需谨慎使用。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 开发者发起的活动ID |
openid | 是 | 拟移除的活动参与者openid |
remark | 是 | 需对参与者进行说明的移除原因等备注信息 |
正确时返回JSON数据包:
code
- {"status":200,"msg":"Remove successfully!"}
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
本接口可以帮助开发者获取到活动的用户讨论信息列表。
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 开发者获取的access_token |
activityid | 是 | 开发者发起的活动ID |
值得说明的是contentid为讨论的唯一标识ID号,而parentid字段一般为空,若不为空表示对讨论的二级讨论,该字段用于存储讨论内容的ID号,便于快速定位、找到该条讨论对应的内容;而count字段表示一共获取到的总讨论数。正确时返回JSON数据包:
code
- {
- "status":200,
- "count":2,
- "data":[{
- "openid":"AOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "contentid":讨论的ID,
- "parentid":讨论的父级内容ID,
- "content":对当前活动的用户讨论内容,
- "createtime":评论创建时间,
- “supportnum”:当前讨论的获赞数量
- },{
- "openid":"BOBRB2JLFNDOA99COJLJKJNJOD9AO2NL",
- "contentid":讨论的ID,
- "parentid":讨论的父级内容ID,
- "content":对当前活动的用户讨论内容,
- "createtime":评论创建时间,
- “supportnum”:当前讨论的获赞数量
- }]
- }
错误时返回错误码等信息,JSON数据包示例如下:
code
- {"status":201,"msg":"Invalid appid!"}
- 或
- {"status":202,"msg":"Param Error!"}
商户中心
即将开放!
即将开放!
即将开放!