OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
is_return_ext_info | Boolean | Optaion | false | 是否补充返回会员的扩展信息,1返回0不返回 | |
total | Int | Optaion | 100 | MIN: 1;MAX: 5000 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
is_return_ext_info | Option | |
total | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
friends | Array | 新好友列表 |
friends[].friend_uuid | String | 好友UUID |
friends[].friend_status | Int | 好友的状态(以当前最新的状态为准),0新好友,1已同意,2已拉黑 |
friends[].friend_username | String | 好友账号 |
friends[].friend_message | String | 好友留言 |
friends[].add_time | String | 对方添加我为好友的时间 |
friends[].ext_info | Object | 仅当is_return_ext_info=1时才返回此字段 |
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 |