GetAiRtcAuthCodeList-阿里云帮助中心

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:GetAiRtcAuthCodeList

get

*All Resource

*

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	integer	No	The page number.	1
PageSize	integer	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 elements

Element	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.
	AiRtcAuthCodeDTO	An authorization code.
TotalCount	integer	The total number of entries returned.	10

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.