更新时间:2022-05-05 GMT+08:00
分享

查询用户详情

描述

企业管理员通过该接口查询企业用户详情。

SLA

请求成功率:>99.99%

TP99请求时延:39ms

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/corp/member/{account}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

account

String

Path

account账号。

  • 如果是帐号/密码鉴权方式,是指华为云会议帐号
  • 如果是App ID鉴权方式,是指第三方User ID

accountType

Integer

Query

账号类型。

  • 0:华为云会议账号。用于帐号/密码鉴权方式。
  • 1:第三方User ID,用于App ID鉴权方式。
  • 默认0

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用uuId,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN,英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

activeTime

Long

激活时间,utc时间戳。

adminType

Integer

管理员类型。

  • 0:默认(超级)管理员
  • 1:普通管理员
  • 2:非管理员(即为普通企业成员,UserType是2时有效)

corp

CorpBasicInfoDTO object

企业注册信息。仅用户查询自己的信息才返回该数据。

country

String

联系电话所属的国家。

deptCode

String

部门编码。

deptName

String

部门名称。

deptNamePath

String

部门完整名称。

desc

String

备注。

devType

QueryDeviceInfoResultDTO object

绑定设备类型信息。

email

String

邮箱。

englishName

String

英文名称。

function

UserFunctionDTO object

用户功能位。

hidePhone

Boolean

是否隐藏手机号码。

id

String

用户id。

license

Integer

许可证。

  • 0:商用;
  • 1:免费试用。

name

String

姓名。

phone

String

联系电话。

signature

String

签名。

sipNum

String

SIP号码。

sortLevel

Integer

通讯录排序等级,序号越低优先级越高。

status

Integer

用户状态。

  • 0:正常;
  • 1:停用。

thirdAccount

String

第三方User ID。

title

String

职位。

userAccount

String

华为云会议用户帐号

userType

Integer

用户类型。

  • 2:企业成员帐户

visionAccount

String

智慧屏唯一账号

vmrList

Array of UserVmrDTO objects

云会议室列表。

请求消息示例

GET /v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0
Connection: keep-alive
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 646
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 551aeb8cafbbaa7bbbdc7b1c76bba8ac

{
    "activeTime": 1601221696783,
    "adminType": 2,
    "corp": null,
    "country": "chinaPR",
    "deptCode": "1",
    "deptName": "根部门",
    "deptNamePath": "根部门",
    "desc": "modDesc",
    "devType": {
        "deviceSize": null,
        "model": null,
        "purchaseChannel": null
    },
    "email": "modEmail@huawei.com",
    "englishName": "modEnglishName",
    "function": {
        "enableRoom": true
    },
    "hidePhone": true,
    "id": "f521bebcbb27422cb3241c4cb19942c5",
    "license": 0,
    "name": "modName",
    "phone": "+86123456789",
    "signature": "modSignature",
    "sipNum": "+8657198480",
    "sortLevel": 1,
    "status": 1,
    "thirdAccount": "thirdAccount",
    "title": "modTitle",
    "userAccount": "3e48b79b660e403cb5e0208f7be83961",
    "userType": 2,
    "visionAccount": null,
    "vmrList": [
        {
            "id": "2c908bc76f61a5f2016f61bbfdf5039b",
            "status": "0",
            "vmrId": "912992631",
            "vmrName": "name的云会议室",
            "vmrPkgId": null,
            "vmrPkgLength": null,
            "vmrPkgName": null,
            "vmrPkgParties": null
        }
    ]
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0
分享:

    相关文档

    相关产品

关闭导读