调用该接口为钥匙设置昵称或别名。

路径 /living/lock/key/nickname/set
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 是
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
lockUserId String 是 钥匙ID，由设备产生，对应锁端的锁用户ID。
lockUserType Int 是 钥匙类型。1（表示指纹）；2（表示密码）；3（表示卡）；4（表示钥匙）。
iotId String 是 设备ID，生活物联网平台为设备颁发的ID，设备的唯一标识符。
nickName String 是 钥匙昵称或别名。
userId String 否 淘宝账号ID信息。
userType String 否 账号类型，淘宝：TAOBAO。
origin String 否 标示来源，目前只支持填写：TmallGenie。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误消息。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{
		"lockUserId": "value0",
		"lockUserType": "value1",
		"iotId": "value2",
		"nickName": "value3",
		"userId": "value4",
		"userType": "value5",
		"origin": "value6"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": null
}

异常返回示例

JSON 格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}