Querying Enterprise Details as an SP Administrator
Description
This API is used to query enterprise details as an SP administrator.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/sp/corp/{id} |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
id |
Yes |
String |
Path |
Enterprise ID. |
X-Access-Token |
Yes |
String |
Header |
Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID. |
X-Request-Id |
No |
String |
Header |
Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated. |
Accept-Language |
No |
String |
Header |
Language. Values: zh-CN for Chinese (default) and en-US for English. |
Status Codes
HTTP Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid parameters. |
401 |
Authentication is not performed or fails. |
403 |
Insufficient permissions. |
500 |
Server exception. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
adminInfo |
QueryAdminResultDTO object |
Administrator details. |
basicInfo |
QueryCorpBasicResultDTO object |
Basic enterprise details. |
groupDTO |
OrgGroupDTO object |
Media ingestion (including SBC and MCU) group information. |
id |
String |
Enterprise ID. |
resInfo |
QueryCorpResResultDTO object |
Enterprise resource details. |
Parameter |
Type |
Description |
---|---|---|
account |
String |
Huawei Cloud Meeting account of the user. |
adminType |
Integer |
Administrator type.
|
country |
String |
Country or region that the mobile number of the user belongs to. |
|
String |
Email address. |
id |
String |
User UUID. |
name |
String |
Administrator name. |
phone |
String |
Mobile number. |
Parameter |
Type |
Description |
---|---|---|
address |
String |
Address. |
country |
String |
Country or region that the mobile number belongs to. |
description |
String |
Remarks. |
|
String |
Email address. |
fax |
String |
Fax number. |
name |
String |
Enterprise name. |
phone |
String |
Phone number. |
spId |
String |
ID of the SP to which the enterprise belongs. |
Parameter |
Type |
Description |
---|---|---|
groupId |
String |
Group ID. |
groupName |
String |
Group name. |
Parameter |
Type |
Description |
---|---|---|
corpVcRes |
QueryCorpVcResResultDTO object |
Enterprise resource details. |
Parameter |
Type |
Description |
---|---|---|
confCallCount |
Integer |
Number of concurrent participants. |
hwVisionCount |
Integer |
Number of smart TV access accounts. |
ideaHubCount |
Integer |
Number of IdeaHub access accounts. |
liveCount |
Integer |
Number of live broadcast ports. |
recordCapability |
Integer |
Recording storage space, in GB. |
roomCount |
Integer |
Number of whiteboard (SmartRooms) access accounts. |
te1080pHardCount |
Integer |
Number of 1080p hard terminal access accounts. |
te720pHardCount |
Integer |
Number of 720p hard terminal access accounts. |
teSoftCount |
Integer |
Number of soft client accounts. |
thirdPartyHardCount |
Integer |
Number of third-party hard terminal access accounts. |
vmrPkgList |
Array of QueryVmrPkgResResultDTO objects |
List of cloud meeting room types. |
Parameter |
Type |
Description |
---|---|---|
vmrName |
String |
Name of a cloud meeting room package. |
vmrPkgCount |
Integer |
Number of cloud meeting room packages of this specification. |
vmrPkgId |
String |
ID of the cloud meeting room package. |
vmrPkgParties |
Integer |
Number of concurrent participants in the cloud meeting room package. |
vmrPkgUsedCount |
Integer |
Number of allocated cloud meeting room packages of this specification. |
Example Request
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)
Example Response
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": "Hangzhou, Zhejiang", "country": "chinaPR", "description": "description", "email": "zhangsan@huawei.com", "fax": "+123456789", "name": "Huawei Technologies Co., Ltd.", "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": "Large cloud meeting room-50 participants", "vmrPkgCount": 10, "vmrPkgId": "ff808081699b56cb0169c411a0980152", "vmrPkgParties": 50, "vmrPkgUsedCount": 0 } ] } } }
Error Codes
If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.
Example cURL Command
curl -k -i -X GET -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot