Querying Personal Details as a User
Description
This API is used by an enterprise user to query personal details.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/member |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
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 |
---|---|---|
activeTime |
Long |
Activation time (UTC timestamp). |
adminType |
Integer |
Administrator type.
|
corp |
CorpBasicInfoDTO object |
Enterprise registration details, which are returned only when users query the personal details of themselves. |
country |
String |
Country or region that the mobile number of the user belongs to. |
deptCode |
String |
Department code. |
deptName |
String |
Department name. |
deptNamePath |
String |
Department name path. |
desc |
String |
Remarks. |
devType |
QueryDeviceInfoResultDTO object |
Type of the associated device. |
|
String |
Email address. |
englishName |
String |
English name. |
function |
UserFunctionDTO object |
User function flag. |
hidePhone |
Boolean |
Whether to hide the mobile number. |
id |
String |
User ID. |
license |
Integer |
License.
|
name |
String |
Name. |
phone |
String |
Mobile number. |
signature |
String |
Signature. |
sipNum |
String |
SIP number. |
sortLevel |
Integer |
Sequence number in the corporate directory. A smaller value indicates a higher position in the corporate directory. |
status |
Integer |
User status.
|
thirdAccount |
String |
Third-party user ID. |
title |
String |
Job title. |
userAccount |
String |
Huawei Cloud Meeting account. |
userType |
Integer |
User type. 2: enterprise member. |
visionAccount |
String |
Unique smart TV account. |
vmrList |
Array of UserVmrDTO objects |
Cloud meeting room list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Cloud meeting room ID.
NOTE:
It matches vmrID in the API for creating a meeting. |
vmrId |
String |
Fixed meeting ID of the cloud meeting room.
NOTE:
It matches vmrConferenceID in the response of calling the API for creating a meeting. |
vmrName |
String |
Cloud meeting room name. |
vmrMode |
Integer |
Cloud meeting room mode.
|
vmrPkgId |
String |
ID of the cloud meeting room package. This parameter is returned only for cloud meeting rooms. |
vmrPkgLength |
Integer |
Meeting duration of the cloud meeting room package. If the value is 0, the meeting duration is unlimited. This parameter is returned only for cloud meeting rooms. |
vmrPkgName |
String |
Name of the cloud meeting room package. This parameter is returned only for cloud meeting rooms. |
vmrPkgParties |
Integer |
Number of concurrent participants in the cloud meeting room package. This parameter is returned only for cloud meeting rooms. |
status |
Integer |
Cloud meeting room status.
|
Parameter |
Type |
Description |
---|---|---|
account |
String |
Administrator account. |
address |
String |
Enterprise address. |
adminName |
String |
Administrator name. |
autoUserCreate |
Boolean |
Whether automatic user registration is enabled. |
country |
String |
Country or region that the administrator's mobile number belongs to. |
|
String |
Administrator's email address. |
enablePstn |
Boolean |
Whether PSTN is enabled. |
enableSMS |
Boolean |
Whether to send meeting notifications by SMS message. |
id |
String |
Enterprise ID. |
name |
String |
Enterprise name. |
phone |
String |
Administrator's mobile number. |
enableCloudDisk |
Boolean |
Whether Clouddrive is enabled. |
corpType |
Integer |
Enterprise type. |
Example Request
GET /v1/usg/dcs/member Connection: keep-alive X-Access-Token: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y 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: 812 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache http_proxy_id: c94f64967745b0670c299c0688479078 Server: api-gateway X-Request-Id: de796b739528b6a1f72c283a107bdb02 { "id": "ff808081699b56cb0169b81a06ee00d9", "userAccount": "user8001@corpnew", "name": "test008", "englishName": null, "phone": null, "country": null, "email": "user8001@corpnew.com", "sipNum": "+991116003840", "vmrList": [ { "id": "ff808081699b56cb0169b81a06f400db", "vmrId": "913371462", "vmrName": "user8001's cloud meeting room", "vmrMode": 0, "vmrPkgId": null, "vmrPkgName": null, "vmrPkgParties": null, "vmrPkgLength": null, "status": 0 }, { "id": "ff808081699b56cb0169b92b45ab0111", "vmrId": "919728047", "vmrName": "Cloud meeting room 919728047", "vmrMode": 1, "vmrPkgId": "ff808081680d5b8601682b3436070030", "vmrName": "Dedicated operations cloud meeting room_25", "vmrPkgParties": 25, "vmrPkgLength": 0, "status": 0 } ], "deptCode": "1", "deptName": "wangyue", "deptNamePath": "wangyue", "userType": 2, "adminType": 2, "signature": null, "title": null, "desc": null, "corp": { "id": "15659", "name": "Huawei Technologies Co., Ltd.", "address": "hangzhou", "adminName": "wlj", "account": "d74cf0a5c7804860a131ec6067a10fc6", "phone": "+86********", "country": "chinaPR", "email": "********@huawei.com", "enableSMS": true, "enablePstn": false, "autoUserCreate": true }, "function": { "enableRoom": false }, "status": 0, "sortLevel": 10000, "hidePhone": false }
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: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y' https://api.meeting.huaweicloud.com/v1/usg/dcs/member
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