GetAiRtcAuthCodeList - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieves a list of Real-time Conversational AI authentication codes and their status for a specified batch.

Operation description

Usage notes

This API retrieves a list of authorization codes for a specific batch ID. You can filter the results by status and type.
Pagination is supported via the PageNo and PageSize parameters.
By default, the NeedTotalCount parameter is set to true, indicating that the response includes the total count of matching records.
LicenseItemId is a required parameter that specifies the batch to query.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ice:GetAiRtcAuthCodeList	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
LicenseItemId	string	Yes	The ID of the batch.	17712***
Status	integer	No	The status of the authorization code. Valid values: `1`: Activated `2`: Inactive	1
Type	integer	No	The type of license. Valid values: `1`: Audio call `2`: Vision call	1
PageNo	long	No	The page number.	1
PageSize	long	No	The number of entries per page.	10
NeedTotalCount	boolean	No	Specifies whether to include the total count of records in the response. Defaults to `true`.	true

Response parameters

Parameter	Type	Description	Example
	object	ApiResponse<CollectionResult>
RequestId	string	The request ID.	7B117AF5-2A16-412C-B127-FA6175ED1***
Success	boolean	Indicates whether the call was successful.	true
Code	string	The error code.	Success
Message	string	The error message.	OK
HttpStatusCode	integer	The HTTP status code.	200
AuthCodeList	array	An array of AiRtcAuthCodeDTO objects, each representing an authorization code.
authCodeList	AiRtcAuthCodeDTO	An authorization code.
TotalCount	long	The total number of entries returned.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1***",
  "Success": true,
  "Code": "Success",
  "Message": "OK",
  "HttpStatusCode": 200,
  "AuthCodeList": [
    {
      "Status": 1,
      "Type": 1,
      "AuthCode": "iU1IeJech7***",
      "ActivatedTime": "2024-01-01 06:57:43",
      "DeviceId": "device-***",
      "CreationTime": "2023-12-23T13:33:49Z",
      "License": "a659a06659a***",
      "ModificationTime": "2023-12-23T13:33:49Z",
      "LicenseItemId": "11096067***"
    }
  ],
  "TotalCount": 10
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-11-06	Add Operation	View Change Details