全部产品
Search

搜索本产品

    视频直播：DescribeLiveMessageApp - 查询直播互动应用信息

    文档中心

    视频直播：DescribeLiveMessageApp - 查询直播互动应用信息

    更新时间：Dec 05, 2024

    调用DescribeLiveMessageApp查询互动消息应用信息。

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    AppIdstring是

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

    		demo
    DataCenterstring否

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

    		cn-shanghai

    返回参数

    名称类型描述示例值
    object

    返回参数。

    RequestIdstring

    请求 ID。

    		9FB68B5B-ED07-18F0-A3CF-083F4E74****
    AppIdstring

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

    		demo
    AppNamestring

    App 名称。

    		testApp
    AppKeystring

    互动消息应用的 AppKey，在进行与该互动消息应用 ID 相关的各种鉴权操作时需要该信息。

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

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

    		**************************************************************************
    AuditTypeinteger

    安全审核方式。取值：

    • 0：不开启安全审核。
    • 1：内置安全审核。
    • 2：自定义安全审核。
    		2
    AuditUrlstring

    AuditType 取值为 2 时提供的安全审核地址。

    		http://example.aliyundoc.com/exampleaudit
    EventCallbackUrlstring

    用户登录、登出、加入、离开群组等事件的回调地址，若为空则不开启事件回调。

    		http://example.aliyundoc.com/examplecallback
    Disableboolean

    是否禁用互动消息应用。

    		false
    CreateTimelong

    创建时间，用 UNIX 时间戳表示，单位：秒。

    		1698305471
    ModifyTimelong

    修改时间，用 UNIX 时间戳表示，单位：秒。

    		1698305471
    MsgLifeCycleinteger

    App 内群组消息的存储时效档位，取值：

    • 0：默认值，存储 30 天。
    • 1：存储 90 天。
    • 2：存储 180 天。
    		1
    DataCenterstring

    数据中心。

    		cn-shanghai

    示例

    正常返回示例

    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",
  "Disable": false,
  "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-02-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-01-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情