Help Center/ Meeting/ Server API Reference/ Hard Terminal Management/ Managing Activation Codes/ Generating an Activation Code as an Enterprise Administrator
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Generating an Activation Code as an Enterprise Administrator

Description

This API is used by an enterprise administrator to generate an activation code for smart TVs, whiteboards (SmartRooms), and IdeaHubs.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/usg/dcs/corp/vision/activecode

Transport Protocol

HTTPS

Request Parameters

Table 2 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.

country

No

String

Body

Country or region that the mobile number belongs to.

Default value: chinaPR.

maxLength: 255

minLength: 0

deptCode

No

String

Body

Department code. If this parameter is not carried, the root department is used by default.

description

No

String

Body

Remarks.

devName

Yes

String

Body

Terminal name.

devType

Yes

String

Body

Terminal type.

  • idea-hub: IdeaHub.
  • huawei-vision: smart TV.
  • welink-desktop(iwb): SmartRooms meeting version.
  • smart-rooms: SmartRooms full version.

emailAddr

No

String

Body

Email address.

NOTE:

If no Chinese mainland mobile number is specified, the email address is mandatory.

smsNumber

No

String

Body

Number information. If the value is a mobile number, the country/region code must be specified. Only mobile numbers in the Chinese mainland are supported.

For example, if a mobile number is +86xxxxxxx in the Chinese mainland, the country parameter is mandatory. The mobile number is in the format of (^$|^[+]?[0-9]+$).

Status Codes

Table 3 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

Table 4 Response parameters

Parameter

Type

Description

activeCode

String

Activation code.

Example Request

POST /v1/usg/dcs/corp/vision/activecode
Connection: keep-alive
X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD
content-type: application/json
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191))

{
    "country": "chinaPR",
    "deptCode": "1",
    "description": "Test terminal",
    "devName": "test_device",
    "devType": "idea-hub",
    "emailAddr": "email@huawei.com",
    "smsNumber": "+8617389079092"
}

Example Response

HTTP/1.1 200 
Date: Mon, 13 Jul 2020 02:20:32 GMT
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 5032547386ab1e2e6a24842e9e1abea9

{
    "activeCode": "085396746642"
}

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 -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' -d '{"country": "chinaPR","deptCode": "1","description": "Test terminal","devName": "test_device","devType": "idea-hub","emailAddr": "email@huawei.com","smsNumber": "+86173****9092"}'
https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode