API 中心

数字工厂底座

地市云

批量查询用户信息

最近更新时间：9/29/2021, 9:12:35 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名：http://iam-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeAccounts

本接口用于批量查询用户信息。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeAccounts
AccountIds 是 Array of String 查询的帐号ID列表

输出参数

字段名 字段类型 字段描述
NickName string 昵称，用户名
Type Integer 账号类型，1:主账户 2:子账户
Role Integer 用户角色，0:普通用户 1:CP服务商 10:SP运营商 20:客户经理
Strategy Integer 用户策略，0:游客 10:个人认证用户 20:企业管理员 21:企业员工
RegisterType Integer 1:邮箱注册 2:子账户 3:微信注册 4:企业微信注册
MasterId Long 主账户AccountId
AuthType Integer 认证类型，0:个人认证 1:企业认证
AuthStatus Integer 认证状态，0:未认证 1:认证中 2:认证通过 3:认证失败
AccountName string 账户名，主账户登录邮箱, 子账户的创建名
ContactMailStatus Integer 联系邮箱的状态，0:未确认 1:确认中 2:已确认
ContactMail string 联系邮箱
ContactMobileStatus Integer 联系手机的状态，0:未确认 1:确认中 2:已确认
CountryCode string 国家区号
ContactMobile string 联系手机
WxBindStatus Integer 微信的绑定状态，0:未绑定 1:已绑定
WxOpenId string 微信绑定的openId
WxNickName string 微信昵称
MiniProgramBindStatus Integer 微信小程序绑定状态，0:未绑定 1:已绑定
WorkWxBindStatus Integer 企业微信绑定状态，0:未绑定 1:已绑定
WorkWxCorpId string 企业微信的企业Id
WorkWxUserId string 企业微信的用户Id
MasterIsCp bool 子账号的主账号 是否CP服务商
CorpName string 企业认证的企业名称
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId

示例

示例1 请求例子

输入示例

{
    "Action":"DescribeAccounts",
    "AccountIds": ["526233914818170870","526233914818170871"]
}

输出示例

{
       "Response": {
           "Accounts": [{
               "AccountId": "526233914818170870",
               "AccountName": "331844xxx@qq.com",
               "RegisterType": 1,
               "AppId": 0,
               "NickName": "331844xxx@qq.com",
               "Type": 1,
               "Role": 1,
               "Strategy": 20,
               "MasterId": "526233914818170870",
               "Status": 2,
               "ContactMailStatus": 2,
               "ContactMail": "331844502@qq.com",
               "ContactMobileStatus": 0,
               "ContactMobile": "1852092xxxx",
               "WxBindStatus": 0,
               "WxOpenId": "",
               "WxNickName": "",
               "AuthType": 1,
               "AuthStatus": 2,
               "AuthId": "526237206298234870",
               "IsAuthMod": 0,
               "ModAuthType": 0,
               "ModAuthId": "0",
               "CorpName": "腾讯无限测试公司",
               "MailBindStatus": 0,
               "WorkWxBindStatus": 0,
               "WorkWxUserId": "",
               "WorkWxCorpId": "",
               "MiniProgramBindStatus": 0,
               "MasterIsCp": false,
               "AuthTime": 1593590896
           }],
           "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
       }
   }

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述