All Products
Search
Document Center

Intelligent Media Services:ActiveAiRtcLicense

Last Updated:Dec 23, 2025

Activates a specified license using the batch ID, authorization code, and device SN.

Operation description

Usage notes

This API is used to activate a specific license for Real-time Conversational AI by providing a batch ID (LicenseItemId), authorization code (AuthCode), and device ID (DeviceId). Upon successful activation, the API returns a response containing the request ID, an error code, the request status, the HTTP status code, and the activated license information.

Note: Ensure that the provided batch ID, authorization code, and device ID are correct. Incorrect information may cause the activation to fail.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ActiveAiRtcLicenseupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LicenseItemIdstringYes

The batch ID.

17712***
AuthCodestringYes

The authorization code.

iU1IeJech7***
DeviceIdstringYes

The device ID.

device-***

Response parameters

ParameterTypeDescriptionExample
object

ApiResponse<CollectionResult>

RequestIdstring

The request ID.

4F9C14FE-1147-15AC-8EDF-A590FF12***
Successboolean

Indicates whether the call was successful.

true
Codestring

The error code returned.

Success
Messagestring

The error message.

OK
HttpStatusCodeinteger

The HTTP status code.

200
Licensestring

The license information.

a659a06659a***

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F9C14FE-1147-15AC-8EDF-A590FF12***",
  "Success": true,
  "Code": "Success",
  "Message": "OK",
  "HttpStatusCode": 200,
  "License": "a659a06659a***"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-11-06Add OperationView Change Details