查询互动消息应用信息_视频直播(LIVE)-阿里云帮助中心

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveMessageApp	系统规定参数。取值：DescribeLiveMessageApp。
AppId	String	是	demo	待查询的互动消息应用ID。
DataCenter	String	否	cn-shanghai	数据中心，需要与CreateLiveMessageApp中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。

返回数据

名称	类型	示例值	描述
RequestId	String	9FB68B5B-ED07-18F0-A3CF-083F4E74****	请求ID。
AppId	String	demo	所查询的互动消息应用ID。
AppName	String	testApp	App名称。
AppKey	String	**********************************	互动消息应用的AppKey，在进行与该互动消息应用ID相关的各种鉴权操作时需要该信息。
AppSign	String	**************************************************************************	互动消息应用签名，互动消息服务SDK需要该信息。
AuditType	Integer	2	安全审核方式。取值： 0：不开启安全审核。 1：内置安全审核。 2：自定义安全审核。
AuditUrl	String	http://example.aliyundoc.com/exampleaudit	AuditType取值为2时提供的安全审核地址。
EventCallbackUrl	String	http://example.aliyundoc.com/examplecallback	用户登录、登出、加入、离开群组等事件的回调地址，若为空则不开启事件回调。
Disable	Boolean	false	是否禁用互动消息应用。
CreateTime	Long	1698305471	创建时间，用UNIX时间戳表示，单位：秒。
ModifyTime	Long	1698305471	修改时间，用UNIX时间戳表示，单位：秒。
DataCenter	String	cn-shanghai	数据中心。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveMessageApp
&AppId=demo
&DataCenter=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveMessageAppResponse>
    <RequestId>9FB68B5B-ED07-18F0-A3CF-083F4E74****</RequestId>
    <AppId>demo</AppId>
    <AppName>testApp</AppName>
    <AppKey>**********************************</AppKey>
    <AppSign>**************************************************************************</AppSign>
    <AuditType>2</AuditType>
    <AuditUrl>http://example.aliyundoc.com/exampleaudit</AuditUrl>
    <EventCallbackUrl>http://example.aliyundoc.com/examplecallback</EventCallbackUrl>
    <CallbackUrl>http://example.aliyundoc.com/examplecallback</CallbackUrl>
    <Disable>false</Disable>
    <CreateTime>1698305471</CreateTime>
    <ModifyTime>1698305471</ModifyTime>
    <DataCenter>cn-shanghai</DataCenter>
</DescribeLiveMessageAppResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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",
  "CallbackUrl" : "http://example.aliyundoc.com/examplecallback",
  "Disable" : false,
  "CreateTime" : 1698305471,
  "ModifyTime" : 1698305471,
  "DataCenter" : "cn-shanghai"
}

错误码

HttpCode	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。