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

SP管理员查询企业

描述

获取企业。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/sp/corp/{id}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

id

String

Path

企业id。

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 响应参数

参数

类型

描述

adminInfo

QueryAdminResultDTO object

管理员信息。

basicInfo

QueryCorpBasicResultDTO object

企业基本信息。

groupDTO

OrgGroupDTO object

媒体接入(包括SBC和MCU)分组信息。

id

String

企业id。

resInfo

QueryCorpResResultDTO object

查询企业资源的返回结果。

表5 QueryAdminResultDTO 数据结构

参数

类型

描述

account

String

用户账号。

adminType

Integer

管理员类型。

  • 0:默认管理员
  • 1:普通管理员

country

String

企业id。

email

String

邮箱。

id

String

用户id。

name

String

名称。

phone

String

联系电话。

表6 QueryCorpBasicResultDTO数据结构

参数

类型

描述

address

String

地址。

country

String

联系号码所属的国家。

description

String

备注。

email

String

邮箱地址。

fax

String

传真号码。

name

String

企业名称。

phone

String

联系号码。

spId

String

企业所属spId。

表7 OrgGroupDTO 数据结构

参数

类型

描述

groupId

String

分组Id。

groupName

String

分组名称。

表8 QueryCorpResResultDTO 数据结构

参数

类型

描述

corpVcRes

QueryCorpVcResResultDTO object

企业资源信息。

表9 QueryCorpVcResResultDTO数据结构

参数

类型

描述

confCallCount

Integer

会议并发方数。

hwVisionCount

Integer

智慧屏终端接入数。

ideaHubCount

Integer

ideahub终端接入数。

liveCount

Integer

推流并发数量。

recordCapability

Integer

录播存储空间 (单位:G)。

roomCount

Integer

电子白板接入数。

te1080pHardCount

Integer

1080P硬终端账户数。

te720pHardCount

Integer

720P硬终端账户数。

teSoftCount

Integer

软终端账户数。

thirdPartyHardCount

Integer

第三方硬终端接入数。

vmrPkgList

Array of QueryVmrPkgResResultDTO objects

云会议室类型列表,最多支持8个,暂不限制。

表10 QueryVmrPkgResResultDTO 数据结构

参数

类型

描述

vmrName

String

云会议室套餐包名称。

vmrPkgCount

Integer

该云会议室套餐分配的总数。

vmrPkgId

String

云会议室套餐包id。

vmrPkgParties

Integer

云会议室套餐方数。

vmrPkgUsedCount

Integer

该套餐对应的云会议室已分配数量。

请求消息示例

GET /v1/usg/dcs/sp/corp/818803911
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
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
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 539e8b710378987ffc5eb844b5e5c290

{
  "adminInfo": {
    "account": "zhangsan@corp",
    "adminType": 0,
    "country": "chinaPR",
    "email": "zhangsan@huawei.com",
    "id": "58eed901985149899b966242e0a7d644",
    "name": "zhangsan",
    "phone": "+86191****9092"
  },
  "basicInfo": {
    "address": "浙江杭州",
    "country": "chinaPR",
    "description": "description",
    "email": "zhangsan@huawei.com",
    "fax": "+123456789",
    "name": "华为技术有限公司",
    "phone": "+86191****9092",
    "spId": "8a8d1384700be6870170117caca923af"
  },
  "resInfo": {
    "corpVcRes": {
      "confCallCount": 100,
      "hwVisionCount": 0,
      "ideaHubCount": 0,
      "liveCount": 0,
      "recordCapability": 0,
      "roomCount": 0,
      "te1080pHardCount": 100,
      "te720pHardCount": 100,
      "teSoftCount": 100,
      "thirdPartyHardCount": 100,
      "vmrPkgList": [
        {
          "vmrName": "大型云会议室-50方",
          "vmrPkgCount": 10,
          "vmrPkgId": "ff808081699b56cb0169c411a0980152",
          "vmrPkgParties": 50,
          "vmrPkgUsedCount": 0
        }
      ]
    }
  }
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911
分享:

    相关文档

    相关产品

close