描述

接口名:ModifyDeviceInfo

更新设备相关信息,比如设备授权有效期延长、更新业务方自定义的业务标识和设备ID等。适用于设备有效期续期等场景。

请求方法:支持以HTTPS POST和GET方法发送请求。

请求参数

名称 类型 参数位置 是否必需 描述
DeviceId String Query 实人认证服务端为接入方设备生成的唯一ID,只有在设备成功激活后才会生成,该ID可通过离线人脸识别SDK里的getLicenseExtraInfo函数获得。
UserDeviceId String Query 更新的用户设备ID。不超过64字符,由接入方自定义,可用于标识具体设备,建议可以使用设备物理编号。
BizType String Query 更新的业务类型。不超过64字符。由接入方自定义,可用于对具体业务进行备注,例如可以取接入方不同的人脸使用场景,或者待交付的客户标识等。
Duration String Query 延长设备到期的时间。单位:年,范围为[1,100],取值100表示永久使用。一年按365天计算。
ExpiredDay String Query Duration传入时,则必须 当前设备的失效时间。失效日期不正确(和实人认证服务端记录的失效时间相差超过一周),则报错。示例:20180101。
说明 该失效时间可以通过DescribeDeviceInfo接口查询获得,失效日期不正确则报错,这个校验是为了确保业务方不因为一些误操作导致重复激活一台设备,误消耗授权。

返回参数

名称 类型 描述
DeviceId String 对应于请求参数中的DeviceId。
UserDeviceId String 对应于请求参数中的UserDeviceId。
BizType String 对应于请求参数中的BizType。
BeginDay String 若请求参数中Duration不为空,则该字段表示延长设备有效期后,授权开始时间。Duration的1年按365天计算。示例:20180101。
ExpiredDay String 若请求参数中Duration不为空,则该字段表示延长设备有效期后,授权到期时间。Duration的1年按365天计算。示例:20180101。

示例

关于使用服务端SDK开发包的示例,请参见以下具体SDK开发包文档中的离线人脸识别SDK示例代码:
以下是拼接HTTPS请求的相关示例:
  • 请求示例
    https://cloudauth.aliyuncs.com/?Action=ModifyDeviceInfo
    &DeviceId=wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
    &UserDeviceId=3iJ1AY$oHcu7mC69
    &BizType=FACE_TEST
    &Duration=1
    &ExpiredDay=20190401
    &<[公共请求参数]>                    
    其中公共请求参数参见API调用方式。
  • 返回示例
    • XML格式
      <?xml version='1.0' encoding='UTF-8'?>
      <ModifyDeviceInfoResponse>
          <Data>
              <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>
          <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>
          <BizType>FACE_TEST</BizType>
          <BeginDay>20190401</BeginDay>
          <ExpiredDay>20200330</ExpiredDay>
          </Data>
          <Success>true</Success>
          <Code>1</Code>
      </ModifyDeviceInfoResponse>
      								
    • JSON格式
      {
        "Data": {
          "DeviceId":wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
          "UserDeviceId":3iJ1AY$oHcu7mC69
          "BizType":FACE_TEST<
          "BeginDay":20190401
          "ExpiredDay":20200330
        },
        "Success": true
      }