接口路径(新):http://api.okayapi.com/api/App/Market_Online/Heartbeat
接口路径(旧):http://api.okayapi.com/?s=App.Market_Online.Heartbeat
接口描述: 定时上报用户在线的情况。使用前请先安装在线统计插件
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,并推荐在下一次上报时回传给小白接口,以便进行精确的统计。 |
请求:
{OKAYAPI_API_HOST}/?s=App.Market_Online.Heartbeat&return_data=0&online_type=设备开机&online_id=xxxx
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"online_id": "xxxx"
},
"msg": "",
"_t": 1687233666,
"_auth": "a60a5ba4b530dcb36133d0ac2d479c75"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,1表示失败,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
online_id | String | 用户唯一ID,如未提供,小白接口会自动生成并分配,请在下一次请求时回传 |
接口路径(新):http://api.okayapi.com/api/App/Market_Online/GetTotal
接口路径(旧):http://api.okayapi.com/?s=App.Market_Online.GetTotal
接口描述: 获取指定时间内在线人数。使用前请先安装在线统计插件
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
online_type | String | Optaion | 在线类型,通过此类型参数可以区分不同的业务使用场景。例如:好友在线人数、论坛在线人数、社区在线人数。 | ||
time_range | Int | Optaion | 3600 | 时间范围,单位:秒。即需要获取最近时间内(多少秒内)在线的人数,默认一小时内。 |
请求:
{OKAYAPI_API_HOST}/?s=App.Market_Online.GetTotal&return_data=0&online_type=设备开机&time_range=3600
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"online_total": 1
},
"msg": "",
"_t": 1687233693,
"_auth": "cfede9ecffabd80d8b4312aeee530b68"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
online_total | Int | 在线人数 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Apr/19/2024 23:39:41