全部产品
Search
文档中心

视频直播:ListLiveMessageApps - 查询直播互动应用列表

更新时间:Dec 05, 2024

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:ListLiveMessageAppslist
*全部资源
*

请求参数

名称类型必填描述示例值
SortTypeinteger

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

  • 1:顺序
  • 2:逆序
1
NextPageTokenlong

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

-1
DataCenterstring

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

cn-shanghai

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

B8EB4994-1368-1458-B9F3-5B88D76D734C
HasMoreboolean

是否有下一页。

true
NextPageTokenlong

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

1
AppListarray<object>

互动消息应用列表。

Appsobject

列表详细信息。

AppIdstring

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

demo
AppKeystring

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

**********************************
AppSignstring

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

**************************************************************************
Disablestring

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

false
AppNamestring

App 名称。

testApp
CreateTimelong

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

1698305471
ModifyTimelong

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

1698305471
MsgLifeCycleinteger

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

  • 0:默认值,存储 30 天。
  • 1:存储 90 天。
  • 2:存储 180 天。
1
DataCenterstring

数据中心。

cn-shanghai

示例

正常返回示例

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-08-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情