更新时间:2024-04-29 GMT+08:00

SP管理员分页搜索企业

描述

SP管理员分页搜索企业。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/sp/corp

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

Integer

Query

查询偏移量,若超过最大数量,则返回最后一页。

默认值:0

limit

Integer

Query

查询数量。

默认值:10

searchKey

Integer

Query

搜索条件,支持名称、手机、邮箱、账号模糊搜索。

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

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值:10。

offset

Integer

页面起始页,从0开始。

data

Array of QueryCorpResultDTO objects

分页查询企业信息。

请求消息示例

GET /v1/usg/dcs/sp/corp?offset=0&limit=5&searchKey=818803911
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Type: application/json
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: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f

{
  "count": 1,
  "data": {
    "adminInfo": {
      "account": "zhangsan@corp",
      "adminType": 0,
      "country": "chinaPR",
      "email": "******",
      "id": "58eed901985149899b966242e0a7d644",
      "name": "zhangsan",
      "phone": "+86191****9092"
    },
    "basicInfo": {
      "address": "浙江杭州",
      "country": "chinaPR",
      "description": "description",
      "email": "******",
      "fax": "+123456789",
      "name": "华为技术有限公司",
      "phone": "+86191****9092",
      "spId": "8a8d1384700be6870170117caca923af"
    },
    "id": 818803911,
    "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
          }
        ]
      }
    }
  },
  "limit": 5,
  "offset": 0
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' 
https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp?offset=0&limit=5&searchKey=818803911