DescribeLiveMessageApp - ApsaraVideo Live - Alibaba Cloud Documentation Center

Query Interactive Message App

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.

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:
- The required resource types are displayed in bold characters.
- 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
live:DescribeLiveMessageApp	get	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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. It is used to authorize operations related to the application ID.	**********************************
AppSign	string	The signature of the interactive messaging application. It is 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 URL for content moderation. This parameter is returned when the value of 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 callbacks are disabled.	http://example.aliyundoc.com/examplecallback
Disable	boolean	Indicates whether the interactive messaging application is disabled.	false
CreateTime	long	The time when the interactive messaging application was created. The value is a UNIX timestamp. Unit: seconds.	1698305471
ModifyTime	long	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

Sample success responses

JSONformat

{
  "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
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

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

Change history

Change time	Summary of changes	Operation
2024-08-01	The Error code has changed. The response structure of the API has changed	View Change Details
2024-02-22	The Error code has changed. The response structure of the API has changed	View Change Details
2024-01-09	The Error code has changed. The response structure of the API has changed	View Change Details