OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
online_type | String | Optaion | 在线类型,通过此类型参数可以区分不同的业务使用场景。例如:好友在线人数、论坛在线人数、社区在线人数。 | ||
online_id | String | Optaion | 用户的唯一ID,用于区分每一个用户的唯一ID。推荐使用小白会员的UUID,也可以使用第三方的会员唯一ID,例如微信公众号的ID、微博ID等。对于游客。如果未提供,小白接口将自动根据客户端的特征(例如IP地址)生成一个对应的唯一ID,并推荐在下一次上报时回传给小白接口,以便进行精确的统计。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
online_type | Option | |
online_id | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,1表示失败,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
online_id | String | 用户唯一ID,如未提供,小白接口会自动生成并分配,请在下一次请求时回传 |
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 |