QueryMessageApp - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call QueryMessageApp to query interactive message applications based on specified conditions.

Operation description

QPS limits

The QPS limit for this API is 100 queries per second per user. If the limit is exceeded, API calls will be throttled, which may affect your business. You can call the API properly to avoid this issue. For more information, see QPS limits.

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 support 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

live:QueryMessageApp

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	Interactive message application ID.	VKL3***
AppName	string	No	Interactive message application name.	testApp
SortType	integer	No	Sorting method. Valid values: 0: Ascending order by time. 1: Descending order by time.	1
PageNum	integer	No	Page number. Default value: 1. Valid values: 1 to 100000.	10
PageSize	integer	No	Number of applications displayed per page. Default value: 20. Valid values: 1 to 50.	20

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	array	Return result.
	object
AppList	array	Interactive Messages application list.
	object
AppConfig	object	Application configuration.
	string	Application configuration.	dawd
AppId	string	Interactive Messages application ID.	VKL3***
AppName	string	Interactive Messages application name.	test
CreateTime	integer	UTC timestamp when the application was created.	502280113
Extension	object	Extension field.
	string	Extension field.	test001
Status	integer	Interactive Messages application status. A value of 1 indicates that the application status is Normal.	1
HasMore	boolean	Indicates whether there is a next page. Valid values: true: There is a next page. false: There is no next page.	false
TotalCount	integer	Total number of query results.	4

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": [
    {
      "AppList": [
        {
          "AppConfig": {
            "key": "dawd"
          },
          "AppId": "VKL3***",
          "AppName": "test",
          "CreateTime": 502280113,
          "Extension": {
            "key": "test001"
          },
          "Status": 1
        }
      ],
      "HasMore": false,
      "TotalCount": 4
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.