API 列表
请求方式 |
API |
描述 |
GET |
/v1.0/osaas/sdk/room/{room_id}/token |
获取房屋令牌凭证 |
DELETE |
/v1.0/osaas/sdk/room/token/{access_token} |
根据访问令牌失效房屋令牌凭证 |
DELETE |
/v1.0/osaas/sdk/room/{room_id}/token |
根据房屋唯一标识失效房屋令牌凭证 |
获取房屋令牌凭证
接口描述
调用该接口获取房屋令牌凭证
接口地址
GET /v1.0/osaas/sdk/room/{room_id}/token
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
room_id |
String |
URI |
房屋唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Object |
返回结果 |
result参数说明
参数名 |
类型 |
说明 |
access_token |
String |
访问令牌 |
expire_time |
Integer |
过期时间,单位:秒 |
refresh_token |
String |
刷新令牌,用于刷新令牌 |
请求示例
GET {url}/v1.0/osaas/sdk/room/12223333******/token
响应成功示例
{
"success": true,
"t": 1566053034624,
"result": {
"access_token": "********************************",
"expire_time": 7200,
"refresh_token": "********************************"
}
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
根据访问令牌失效房屋令牌凭证
接口描述
调用该接口根据访问令牌失效房屋令牌凭证
接口地址
DELETE /v1.0/osaas/sdk/room/token/{access_token}
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
access_token |
String |
URI |
访问令牌 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Boolean |
返回结果 |
请求示例
DELETE {url}/v1.0/osaas/sdk/room/token/********************
响应成功示例
{
"success": true,
"result": true,
"t": 1566053034624
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
根据房屋唯一标识失效房屋令牌凭证
接口描述
根据房屋唯一标识失效房屋令牌凭证
接口地址
DELETE /v1.0/osaas/sdk/room/{room_id}/token
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
room_id |
String |
URI |
房屋唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Boolean |
操作结果 |
请求示例
DELETE {url}/v1.0/osaas/sdk/room/1222333******/token
响应成功示例
{
"success": true,
"result": true,
"t": 1566053034624
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
错误码
以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。