查询互动消息应用列表

调用ListLiveMessageApps查询互动消息应用列表。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListLiveMessageApps

系统规定参数。取值:ListLiveMessageApps

SortType Integer 1

排序方式,按创建时间先后进行排序。取值:

  • 1:顺序
  • 2:逆序
NextPageToken Long -1

查询页的起始位置,若为空或者-1则默认为首页。

DataCenter String cn-shanghai

数据中心,需要与CreateLiveMessageApp中的数据中心一致,当前支持上海(取值为cn-shanghai)、新加坡(取值为ap-southeast-1)。

返回数据

名称

类型

示例值

描述

RequestId String B8EB4994-1368-1458-B9F3-5B88D76D734C

请求ID。

HasMore Boolean true

是否有下一页。

NextPageToken Long 1

下一页的起始位置,Hasmore为true时返回。

AppList Array of Apps

互动消息应用列表。

AppId String demo

所查询的互动消息应用ID。

AppKey String **********************************

互动消息应用的AppKey,在该互动消息应用ID的相关操作鉴权时需要该信息。

AppSign String **************************************************************************

互动消息应用签名,互动消息服务SDK需要该信息。

Disable String false

该互动消息应用是否被禁用。

AppName String testApp

App名称。

CreateTime Long 1698305471

创建时间,用UNIX时间戳表示,单位:秒。

ModifyTime Long 1698305471

修改时间,用UNIX时间戳表示,单位:秒。

MsgLifeCycle Integer 1

App内群组消息的存储时效档位,取值:

  • 0:默认值,存储30天。
  • 1:存储90天。
  • 2:存储180天。
DataCenter String cn-shanghai

数据中心。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListLiveMessageApps
&SortType=1
&NextPageToken=-1
&DataCenter=cn-shanghai
&公共请求参数

正常返回示例

XML格式

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

<ListLiveMessageAppsResponse>
    <RequestId>B8EB4994-1368-1458-B9F3-5B88D76D734C</RequestId>
    <HasMore>true</HasMore>
    <NextPageToken>1</NextPageToken>
    <AppList>
        <AppId>demo</AppId>
        <AppKey>**********************************</AppKey>
        <AppSign>**************************************************************************</AppSign>
        <Disable>false</Disable>
        <AppName>testApp</AppName>
        <CreateTime>1698305471</CreateTime>
        <ModifyTime>1698305471</ModifyTime>
        <MsgLifeCycle>1</MsgLifeCycle>
        <DataCenter>cn-shanghai</DataCenter>
    </AppList>
</ListLiveMessageAppsResponse>

JSON格式

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

{
  "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"
  } ]
}

错误码

HttpCode

错误码

错误信息

描述

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

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