Querying Enterprises in Pages as an SP Administrator
Description
This API is used by an SP administrator to query enterprises in pages.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/sp/corp |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
offset |
No |
Integer |
Query |
Query offset. If the value exceeds the maximum number of records available, records on the last page are returned. Default value: 0. |
limit |
No |
Integer |
Query |
Number of records to be queried. Default value: 10. |
searchKey |
No |
Integer |
Query |
Search criteria. Fuzzy search by name, mobile number, email address, and account is supported. |
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 |
---|---|---|
count |
Integer |
Total number of records. |
limit |
Integer |
Number of records displayed per page. Default value: 10. |
offset |
Integer |
Number of the query start page. The value starts from 0. |
data |
Array of QueryCorpResultDTO objects |
Enterprise details. |
Example Request
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)
Example Response
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 }
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: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp?offset=0&limit=5&searchKey=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