Consulta de empresas em páginas como um administrador de SP
Descrição
Esta API é usada por um administrador de SP para consultar empresas em páginas.
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
|
Método de solicitação |
GET |
|---|---|
|
Endereço de solicitação |
/v1/usg/dcs/sp/corp |
|
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
|---|---|---|---|---|
|
offset |
Não |
Integer |
Consulta |
Deslocamento de consulta. Se o valor exceder o número máximo de registros disponíveis, os registros na última página serão retornados. Valor padrão: 0. |
|
limit |
Não |
Integer |
Consulta |
Número de registros a serem consultados. Valor padrão: 10. |
|
searchKey |
Não |
Integer |
Consulta |
Critérios de pesquisa. Pesquisa difusa por nome, número de celular, endereço de e-mail e conta é suportada. |
|
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
|
X-Request-Id |
Não |
String |
Cabeçalho |
ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente. |
|
Accept-Language |
Não |
String |
Cabeçalho |
Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês. |
Códigos de status
|
Código de status HTTP |
Descrição |
|---|---|
|
200 |
Operação bem-sucedida. |
|
400 |
Parâmetros inválidos. |
|
401 |
A autenticação não é executada ou falha. |
|
403 |
Permissões insuficientes. |
|
500 |
Exceção do servidor. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros exibidos por página. Valor padrão: 10. |
|
offset |
Integer |
Número da página inicial da consulta. O valor começa em 0. |
|
data |
Array of QueryCorpResultDTO objects |
Detalhes da empresa. |
Exemplo de solicitação
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)
Exemplo de resposta
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": "zhangsan@huawei.com",
"id": "58eed901985149899b966242e0a7d644",
"name": "zhangsan",
"phone": "+86191****9092"
},
"basicInfo": {
"address": "Hangzhou, Zhejiang",
"country": "chinaPR",
"description": "description",
"email": "zhangsan@huawei.com",
"fax": "+123456789",
"name": "Huawei Technologies Co., Ltd.",
"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": "Large cloud meeting room-50 participants",
"vmrPkgCount": 10,
"vmrPkgId": "ff808081699b56cb0169c411a0980152",
"vmrPkgParties": 50,
"vmrPkgUsedCount": 0
}
]
}
}
},
"limit": 5,
"offset": 0
}
Códigos de erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo de comando 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
