OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
moment_nickname | String | Optaion | 昵称,精确匹配。注意,如果搜索指定的昵称,将不会显示当前登录用户的朋友圈,并且只会显示该昵称下开放的朋友圈。 | ||
moment_content | String | Optaion | 朋友圈内容,支持模糊匹配 | ||
moment_place | String | Optaion | 位置描述,支持模糊匹配 | ||
min_moment_like | Int | Optaion | 0 | MIN: 0 | 最小点赞数 |
max_moment_like | Int | Optaion | 0 | MIN: 0 | 最大点赞数,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 |
min_moment_lat | Float | Optaion | 0.0 | 最小纬度 | |
max_moment_lat | Float | Optaion | 0.0 | 最小纬度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 | |
min_moment_lng | Float | Optaion | 0.0 | 最小经度 | |
max_moment_lng | Float | Optaion | 0.0 | 最小经度,为0时不过滤。区间判断原则:前等后不等。即小于且不等于最大值。 | |
min_moment_createtime | Date | Optaion | 0 | 开始发布时间,格式时间戳,如:1565518810,为空时不过滤。 | |
max_moment_createtime | Date | Optaion | 0 | 结束发布时间,格式为时间戳,为空时不过滤。区间判断原则:前等后不等。即小于且不等于结束时间。 | |
more_select | ArraySeperated with , | Optaion | 需要返回的更多字段,例如客户端额外添加的自定义字段和小白系统字段。如:more_select=id,uuid | ||
page | Int | Optaion | 1 | MIN: 1 | 第几页 |
perpage | Int | Optaion | 20 | MIN: 1;MAX: 1000 | 分页数量 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
moment_nickname | Option | |
moment_content | Option | |
moment_place | Option | |
min_moment_like | Option | |
max_moment_like | Option | |
min_moment_lat | Option | |
max_moment_lat | Option | |
min_moment_lng | Option | |
max_moment_lng | Option | |
min_moment_createtime | Option | |
max_moment_createtime | Option | |
more_select | Option | |
page | Option | |
perpage | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
total | Int | 朋友圈条数 |
items | Array | 朋友圈列表 |
items[].id | Int | 朋友圈id |
items[].nickname | String | 朋友圈发布者名称 |
items[].moment_content | String | 朋友圈的内容 |
items[].moment_url | String | 朋友圈跳转链接 |
items[].moment_createtime | String | 朋友圈发表时间 |
items[].moment_like | Int | 朋友圈点赞数 |
items[].moment_picture1 | String | 朋友圈图片1 |
items[].moment_picture2 | String | 朋友圈图片2 |
items[].moment_picture3 | String | 朋友圈图片3 |
items[].moment_picture4 | String | 朋友圈图片4 |
items[].moment_picture5 | String | 朋友圈图片5 |
items[].moment_picture6 | String | 朋友圈图片6 |
items[].moment_picture7 | String | 朋友圈图片7 |
items[].moment_picture8 | String | 朋友圈图片8 |
items[].moment_picture9 | String | 朋友圈图片9 |
items[].moment_lat | String | 朋友圈发布纬度 |
items[].moment_lng | String | 朋友圈发布经度 |
items[].moment_place | String | 朋友圈位置描述 |
items[].moreSelect | string/int | 返回的更多的字段 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |