目录

激活/去激活/停用信标设备

功能介绍

信标设备有激活、去激活、停用三种状态,分别调用这三个接口,可以设置信标设备的相关状态。

场景描述

使用约束

接口原型

承载协议

HTTPS POST

接口方向

应用服务器或App应用 -> 近距离通信服务器

接口URL

https://{域名}/WiseCloudNearbyBeaconService/v1/activeBeacon?projectId=[projectId]

https://{域名}/WiseCloudNearbyBeaconService/v1/deactiveBeacon?projectId=[projectId]

https://{域名}/WiseCloudNearbyBeaconService/v1/abandonBeacon?projectId=[projectId]

数据格式

Content-type: application/json

查询参数

参数

是否必选

参数类型

描述

projectId

否

String

获取方式请参见获取projectId。

请求参数

Request Header

参数

是否必选

类型

描述

timeStamp

是

Long

请求头参数,时间戳。

srcTranID

是

String

请求头参数,事务ID。最长为24个字符。

Authorization

是

String

用于网关认证,请参见用于网关认证,请参见基于Service Account开放鉴权获取JWT。

Request Body

参数

是否必选

参数类型

描述

beaconId

是

String

信标设备的ID。

请求示例

响应参数

Response Header

参数

是否必选

参数类型

描述

Content-Type

否

String

上传文件Content-Type。

Content-Length

是

Integer

上传文件Content-Length。

Response Body

状态码为200时:

请求成功,无响应体。

状态码为非200时:

请求失败,响应体如下。
  • 非业务(网关校验失败、token过期等情况)请求失败时:

    参数

    类型

    描述

    error

    String

    非业务返回的错误信息。

  • 业务请求失败时:

    参数

    类型

    描述

    serviceError

    object

    业务返回的错误信息。请见下文serviceError详细信息。

    serviceError

    参数

    类型

    参数含义

    code

    int

    错误码,错误码描述见错误码。

    status

    String

    错误状态。

    message

    String

    错误描述信息。

响应示例

错误码

状态码

错误码

描述

建议业务处理方式

400

400000001

请求头参数不对。

检查请求头参数。

400

400000002

请求体参数不对。

检查请求体参数。

403

403000003

服务帐号不可用。

在华为开发者联盟的管理中心可查看服务帐号状态。

403

403000004

没有权限操作此信标设备。

检查服务帐号是否拥有此信标设备。

403

403000008

当前信标设备已停用。

处于停用状态的信标设备只能删除,不能进行其他操作。

404

404000006

当前信标设备不存在。

检查信标设备是否存在。

500

500000001

内部服务错误。

请选择在线提单提交问题,华为支持人员会及时处理。