承载协议 | HTTPS GET |
|---|---|
接口方向 | 应用服务器或App应用 -> 近距离通信服务器 |
接口URL | https://{域名}/WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/{beaconId}?projectId=[projectId] |
数据格式 | Content-type: application/json |
Request Header
参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
timeStamp | 是 | Long | 请求头参数，时间戳。 |
srcTranID | 是 | String | 请求头参数，事务ID，最长为24个字符。 |
Authorization | 是 | String | 请求头参数，用于网关认证，请参见基于Service Account开放鉴权获取JWT。 |
Request Body
无
GET /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/bea001?projectId=id123 HTTP/1.1 Host: 域名 Cache-Control: no-cache Content-Type: application/json srcTranID: 201910181908046224775032 timeStamp: 1579423534 Accept: application/json Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
GET /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/bea001?projectId=id123 HTTP/1.1 Host: 域名 Cache-Control: no-cache Content-Type: application/json srcTranID: 201910181908046224775037 timeStamp: 1579423534 Accept: application/json Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
GET /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/bea001?projectId=id123 HTTP/1.1 Host: 域名 Cache-Control: no-cache Content-Type: application/json srcTranID: 201910181908046224775031 timeStamp: 1579423534 Accept: application/json Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx
Response Header
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 否 | String | 上传文件Content-Type。 |
Content-Length | 是 | Integer | 上传文件Content-Length。 |
Response Body
状态码为200时：
请求成功，响应体如下。
参数 | 类型 | 描述 |
|---|---|---|
attachments | Json Array | 消息附件结构体的列表，具体参见消息附件结构体定义。 |
{
"namespace": "namespace002",
"attachmentId": "202001191739115580278122214157680128",
"type": "4",
"value": "5oiR5piv5Lit5Zu95Lq6qw"
} 参数值 | 类型 | 功能 |
|---|---|---|
attachmentId | String | 消息附件的ID，配置消息附件时系统自动生成。 |
namespace | String | 消息附件对应的命名空间。 |
type | String | 消息类型，用户自定义，最长为16个字符。 |
value | String | 消息附件内容，base64编码字符串。 |
状态码为非200时：
参数 | 类型 | 描述 |
|---|---|---|
error | String | 非业务返回的错误信息。 |
参数 | 类型 | 描述 |
|---|---|---|
serviceError | object | 业务返回的错误信息。请见下文serviceError详细信息。 |
HTTP/1.1 401
Content-type: application/json
content-length: 27
{
error: "session timeout"
} HTTP/1.1 404
Content-type: application/json
content-length: 113
{
"serviceError": {
"code": 404000006,
"message": "The beacon with ID bea001 does not exist.",
"status": "Not Found"
}
} HTTP/1.1 200
content-length: 78
Content-Type: application/json;charset=UTF-8
{
"attachments": [
{
"namespace": "namespace002",
"attachmentId": "202001191739115580278122214157680128",
"type": "4",
"value": "5oiR5piv5Lit5Zu95Lq6qw"
}
]
} 状态码 | 错误码 | 描述 | 建议业务处理方式 |
|---|---|---|---|
400 | 400000001 | 请求头参数不对。 | 检查请求头参数。 |
400 | 400000009 | 当前信标设备未激活。 | 激活当前信标设备。 |
403 | 403000003 | 服务帐号不可用。 | 在华为开发者联盟的管理中心可查看服务帐号状态。 |
403 | 403000004 | 没有权限操作此信标设备。 | 检查服务帐号是否拥有此信标设备。 |
404 | 404000006 | 当前信标设备不存在。 | 检查信标设备是否存在。 |
500 | 500000001 | 内部服务错误。 | 请选择在线提单提交问题，华为支持人员会及时处理。 |