提供一組與用戶賬號體系相關的服務接口，通過本組服務接口可以實現用戶賬戶信息的查詢和設置。

查詢統一身份列表

定義描述

path 版本 描述 是否需要用戶身份的鑒權
/iotx/account/queryIdentityList 1.0.4 查詢統一身份列表 否

請求參數

參數 類型 必填 描述
identityIds List 是 賬號身份ID列表

返回參數

名稱 類型 必有 描述
identityId String 是 賬號身份ID
loginId String 是 OA loginId
loginSource String 是 賬號來源，目前為openAccount
loginName String 否 登錄名
phone String 是 手機號
email String 是 郵箱
nickName String 否 昵稱
avatarUrl String 否 頭像鏈接
gmtCreate Long 是 創建時間
gmtModified Long 是 修改時間

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.4"
      },
      "params": {
        "request": {"identityIds":["506bop1ef3a1cexxxxxxxxf57ae175ac94618"]}
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": [
        {
            "gmtModified": 1508314232000,
            "loginId": "4398047084811",
            "gmtCreate": 1508314232000,
            "identityId": "506bop1ef3a1cexxxxxxxx57ae175ac94618",
            "loginSource": "openAccount",
        }
    ],
    "id":"bb179e80-39fd-xxxx-xxxx-48ca87a3f5c5"
}

修改賬號屬性

定義描述

path 版本 描述 是否需要用戶身份的鑒權
/iotx/account/modifyAccount 1.0.5 修改賬號屬性 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
identityId String 是 identityId
accountMetaV2 JSON 是 賬戶屬性信息

accountMetaV2結構

參數 類型 必填 描述
loginName String 否 登錄名
phone String 手機號和郵箱至少一個必填 手機號
email String 手機號和郵箱至少一個必填 郵箱
nickName String 否 昵稱
appKey String 是 OA的appKey
avatarUrl String 否 頭像鏈接

返回參數

無業務返回參數

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "iotToken": "109049c8xxxxxxxx62e29a3ba",
        "apiVer": "1.0.5"
      },
      "params": {
        "request": {"identityId":"50e5opda16exxxxxxxxc9632a038c2479", "accountMetaV2":{"phone":"157xxxx6621", "appKey":"6xxxx75","nickName":"test"}}
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}

注銷賬號

定義描述

path 版本 描述 是否需要用戶身份的鑒權
account/unregister 1.0.6 賬號注銷 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

無業務請求參數

返回參數

無業務返回參數

示例

  • 請求示例 
    {
     "id":1508232047196,
      "request": {
        "iotToken": "109049cxxxxxxxxb15f6f62e29a3ba",
        "apiVer": "1.0.6"
      },
      "params": {
       },
      "version": "1.0"
}
  • 正常返回示例 
    {
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "class": "com.aliyun.iotx.common.base.service.IoTxResult"
}

檢測賬號是否已注冊

定義描述

path 版本 描述 是否需要用戶身份的鑒權
/user/account/regcheck 1.0.0 檢測賬號是否已注冊 否

請求參數

參數 類型 必填 描述
phone String 否 手機號
email String 否 郵箱地址

返回參數

名稱 類型 必有 描述
data Bool 是 是否已經注冊，true：已經注冊；false：未注冊

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "phone": "186xxxx4567",
          "email": "a***@example.net"
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
  "id": "8d1a665e-ce92-xxxx-xxxx-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": false
}

查詢統一身份

定義描述

path 版本 描述 是否需要用戶身份的鑒權
/user/account/identity/query 1.0.0 查詢統一身份 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
loginId String 否 OA loginId
loginSource String 否 賬號來源類型（OA）
phone String 否 手機號
email String 否 郵箱地址
opType Int 是 1-根據loginId & loginSouce；2-根據手機號碼；3-根據郵箱；其他值非法

返回參數

名稱 類型 描述
phone String 手機號
identityId String 統一身份ID
nickName String 用戶昵稱
loginId String OA loginId
avatarUrl String 頭像地址
loginName String 登錄名
loginSource String 賬號來源

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "loginId": "value1",
          "loginSource": "value2",
          "phone": "value3",
          "email": "value4",
          "opType": "value5",
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
  "id": "8d1a665e-ce92-xxxx-xxxx-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "identityId": "5053opfxxxxxxxx473f5db0e73982",
    "loginId": "493265",
    "loginSource": "openAccount",
    "modifier": "system",
    "nickName": "ktt",
    "phone": "138xxxx3662",
    "loginName": "tester"
  }
}

根據登錄態獲取當前用戶的詳細信息

定義描述

path 版本 描述 是否需要用戶身份的鑒權
/user/account/session/authidentity 1.0.1 根據登錄態獲取當前用戶的詳細信息 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
iotToken String 是 用戶登錄態

返回參數

名稱 類型 描述
companyId String 公司ID
companyName String 公司名
identityId String 統一身份ID
loginName String 登錄名
nickName String 昵稱
phone String 手機號
email String 郵箱地址

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.1"
      },
      "params": {
        "request": {
          "iotToken": "xxxxxxxxxxxxx",
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
  "id": "8d1a665e-ce92-xxxx-xxxx-99d2e81814f3",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "companyId": "95BDDAxxxxxxxxt8240A19D5",
    "companyName": "test物聯技術有限公司",
    "identityId": "5022al4d34xxxxxxxxaf3fac06085",
    "loginName": "test物聯",
    "nickName": "test物聯",
    "phone": "xxxxxxxxxxx",
    "email": "a***@example.net"
  }
}

獲取用戶上傳頭像的URL及加密簽名

當用戶需要修改頭像時流程如下。

  1. 調用此接口獲取上傳的URL和簽名等參數。
  2. App取得上傳的URL和簽名等參數后，通過POST方法將頭像上傳（請參見PostObject）。

    上傳時header中的x-oss-forbid-overwrite參數不能設置為true，否則可能導致上傳失敗。上傳成功后，根據流程1中調用接口的返回參數中的host、dir拼接得出頭像圖片URL地址（拼接規則為“https://”+ host + “/” + dir）。

  3. 通過修改賬號屬性接口更新圖像URL。
path 版本 描述 是否需要用戶身份的鑒權
/living/user/avatar/upload/signature/get 1.0.0 用戶頭像上傳URL以及加密簽名獲取 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
fileSize int 是 頭像圖片文件大小，單位為字節，取值范圍最小為1；最大為10485760（10M）。

返回參數

名稱 類型 描述
accessKey String OSS的accessKey
dir String 圖片在OSS桶里的存儲目錄
expire Long 過期時間戳，毫秒為單位，在此時間戳之前可以向OSS上傳頭像
host String OSS訪問域名地址
signature String 簽名
policy String 請求表單域的合法性校驗信息

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "fileSize": 300888
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
    "id":1508232047194,
    "code":200,
    "data": {
        "signature":"b45CXXXXXXXXXXXXXXXXXXXXXX",
        "accessKey":"LTAXXXXXXXXXXXXX",
        "expire":1578077777777,
        "host":"xxxx.oss-ap-shanghai.aliyuncs.com",
        "dir":"images/third_app_user/profile/50adopbXXXXXX_MmI2NGJjZD.png",
        "policy":"eyJleHBpcmFXXXXXXXXXXX0aW9uIjoiMjAy"
       }
}

綁定外部平臺（淘寶）賬號

path 版本 描述 是否需要用戶身份的鑒權
/account/taobao/bind 1.0.5 將App賬號與淘寶賬號進行綁定，用于同時支持天貓精靈控制用戶設備，詳情請參見自有App接入天貓精靈教程 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
authCode String 是 淘寶OAuth認證返回autoCode

返回參數

名稱 類型 描述
accountId String 賬號ID，此處為淘寶賬號的ID
accountType String 賬號類型，此處固定為TAOBAO

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
          "authCode":"value1"
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "accountId":"value2",
        "accountType":"TAOBAO"
    }
}

獲取綁定的外部平臺（淘寶）賬號

path 版本 描述 是否需要用戶身份的鑒權
/account/thirdparty/get 1.0.5 查詢用戶當前已綁定的外部平臺賬號ID，此處為淘寶賬號ID，用于同時支持天貓精靈控制用戶設備，詳情請參見自有App接入天貓精靈教程 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
accountType String 是 外部平臺類型，此處固定為TAOBAO

返回參數

名稱 類型 描述
accountId String 賬號ID，此處為是淘寶賬號的ID
accountType String 外部平臺類型，此處固定為TAOBAO

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "authCode": "TAOBAO"
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "accountId":"value1",
        "accountType":"TAOBAO"
    }
}

解除綁定的外部平臺（淘寶）賬號

path 版本 描述 是否需要用戶身份的鑒權
/account/thirdparty/unbind 1.0.5 解綁用戶當前已綁定的外部平臺賬號ID，此處為淘寶賬號ID，用于同時支持天貓精靈控制用戶設備，詳情請參見自有App接入天貓精靈教程 是，客戶端SDK需啟用身份的鑒權，進行身份認證

請求參數

參數 類型 必填 描述
accountType String 是 外部平臺類型，此處固定為TAOBAO

返回參數

名稱 類型 描述
accountId String 賬號ID，此處為淘寶賬號的ID
accountType String 外部賬號類型，固定為TAOBAO

示例

  • 請求示例 
    {
     "id":1508232047194,
      "request": {
        "apiVer": "1.0.0"
      },
      "params": {
        "request": {
          "authCode": "TAOBAO"
        }
      },
      "version": "1.0"
}
  • 正常返回示例 
    {
    "code": 200,
    "data": {
        "accountId":"value1",
        "accountType":"TAOBAO"
    }
}