Interactive Messaging Apps Overview - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the list of interactive messaging applications by calling ListLiveMessageApps.

Operation description

The China (Shanghai) region is replaced by the Singapore region in the example. The China (Shanghai) region is replaced by the Singapore region in the example. The per-user QPS limit for this operation is 50. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

live:ListLiveMessageApps

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SortType	integer	Yes	The sort type by creation time. Valid values: 1: ascending order. 2: descending order. Valid values: 1 : Ascending order. 2 : Descending order.	1
NextPageToken	integer	No	The starting position of the query page. If this parameter is left empty or set to -1, the first page is returned by default.	-1
DataCenter	string	No	The data center. The value must be the same as the data center specified in CreateLiveMessageApp. Valid values: cn-shanghai (China (Shanghai)) and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B8EB4994-1368-1458-B9F3-5B88D76D734C
HasMore	boolean	Indicates whether there is a next page.	true
NextPageToken	integer	The starting position of the next page. This parameter is returned only when HasMore is set to true.	1
AppList	array<object>	The list of interactive messaging applications.
	object	The details of the application.
AppId	string	The ID of the interactive messaging application.	demo
AppKey	string	The AppKey of the interactive messaging application. This value is required for authentication of related operations on this application.	**********************************
AppSign	string	The signature of the interactive messaging application. This value is required by the interactive messaging SDK.	**************************************************************************
Disable	string	Indicates whether the interactive messaging application is disabled.	false
AppName	string	The application name.	testApp
CreateTime	integer	The creation time, represented as a UNIX timestamp. Unit: seconds.	1698305471
ModifyTime	integer	The modification time, represented as a UNIX timestamp. Unit: seconds.	1698305471
MsgLifeCycle	integer	The storage duration tier for group messages within the application. Valid values: 0: Default value. Messages are stored for 30 days. 1: Messages are stored for 90 days. 2: Messages are stored for 180 days.	1
DataCenter	string	The data center.	cn-shanghai

Examples

Success response

JSON format

{
  "RequestId": "B8EB4994-1368-1458-B9F3-5B88D76D734C",
  "HasMore": true,
  "NextPageToken": 1,
  "AppList": [
    {
      "AppId": "demo",
      "AppKey": "**********************************",
      "AppSign": "**************************************************************************",
      "Disable": "false",
      "AppName": "testApp",
      "CreateTime": 1698305471,
      "ModifyTime": 1698305471,
      "MsgLifeCycle": 1,
      "DataCenter": "cn-shanghai"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.