主要使用场景：第三方应用接入平台后，需要与平台会话保持一致时使用
客户端与服务器之间定时维护用户心跳
获取接口访问凭证：accessToken
| url | https://gateway.tianyuyun.com/user/openapi/user/heartbeat?usession_id=****&accessToken={{accessToken}} |
| 请求方式 | get |
| 是否需要鉴权 | 是 |
| 请求数限制 | 是 |
| 接口方向 | 第三方应用->开放平台 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
usession_id |
必选 |
String |
64 |
用户会话编号 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
code |
必选 |
String |
6 |
结果编码,心跳成功000000，心跳失败100000，心跳失败110000(重复登录限制开启时存在该结果编码，result会返回相关重复日志信息，应用可选择使用) |
2 |
message |
必选 |
String |
结果描述 | |
3 |
result |
可选 |
json |
结果对象 | |
3.1 |
usession_id |
必选 |
string |
用户会话编号 | |
3.2 |
account_id |
必选 |
string |
帐号编号 | |
3.3 |
user_id |
必选 |
string |
用户编号 | |
3.4 |
other |
可选 |
json |
附加信息 | |
3.4.1 |
top_org_id |
可选 |
string |
当前会话用户切换的机构、学校等组织编号 |
请求示例
https://gateway.tianyuyun.com/user/openapi/user/heartbeat?usession_id=****&accessToken={{accessToken}}
返回示例
{
"code": "000000",
"message": "心跳成功",
"result": {
"usession_id": "746afa32-60ad-11e9-9c81-0200f7a5bbcc",
"account_id": "cec2cdba-6013-11e9-9fd4-0200f7764488",
"user_id": "cebe65e0-6013-11e9-9fd4-0200f7764488",
"other": {
"top_org_id": "42675838-5ff8-11e9-b985-0200f7efd26a"
}
}
}
鄂公网安备 42018502000485号