DescribeLiveMessageApp API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the information about an interactive messaging application.

Operation description

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:DescribeLiveMessageApp

get

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application.	demo
DataCenter	string	No	The data center. The value must match the data center specified when you called the CreateLiveMessageApp operation to create the application. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	9FB68B5B-ED07-18F0-A3CF-083F4E74****
AppId	string	The ID of the interactive messaging application.	demo
AppName	string	The name of the interactive messaging application.	testApp
AppKey	string	The AppKey of the interactive messaging application, used to authorize operations on the application.	**********************************
AppSign	string	The signature of the interactive messaging application, required by the interactive messaging SDK.	**************************************************************************
AuditType	integer	The content moderation method. Valid values: 0: Content moderation is disabled. 1: Built-in content moderation is used. 2: Custom content moderation is used.	2
AuditUrl	string	The content moderation URL. Returned only when AuditType is 2.	http://example.aliyundoc.com/exampleaudit
EventCallbackUrl	string	The callback URL for events such as user logon, logoff, joining a group, and leaving a group. An empty value indicates that event callbacks are disabled.	http://example.aliyundoc.com/examplecallback
Disable	boolean	Indicates whether the interactive messaging application is disabled.	false
CreateTime	integer	The time when the interactive messaging application was created. The value is a UNIX timestamp. Unit: seconds.	1698305471
ModifyTime	integer	The time when the interactive messaging application was modified. The value is a UNIX timestamp. Unit: seconds.	1698305471
MsgLifeCycle	integer	The retention period of group messages in the application. Valid values: 0 (default): 30 days 1: 90 days 2: 180 days	1
DataCenter	string	The data center.	cn-shanghai

Examples

Success response

JSON format

{
  "RequestId": "9FB68B5B-ED07-18F0-A3CF-083F4E74****",
  "AppId": "demo",
  "AppName": "testApp",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "AuditType": 2,
  "AuditUrl": "http://example.aliyundoc.com/exampleaudit",
  "EventCallbackUrl": "http://example.aliyundoc.com/examplecallback",
  "Disable": false,
  "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.