文档首页/ 华为云会议 Meeting/ 服务端API参考/ 信息窗管理/ 信息窗节目管理/ 查询信息窗节目
更新时间：2023-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询信息窗节目

描述

获取信息窗节目。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/sss/programs

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

否

Integer

Query

查询偏移量，若超过最大数量，则返回最后一页。

默认值：0

limit

否

Integer

Query

查询数量。

默认值：10

searchKey

否

String

Query

搜索条件，支持节目名称、更新人模糊搜索。

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

否

String

Header

请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。

Accept-Language

否

String

Header

语言参数，默认为中文zh-CN，英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值：10。

offset

Integer

页面起始页，从0开始。

data

Array of ProgramResponseBase objects

节目信息列表。
表5 ProgramResponseBase 数据结构

参数

类型

描述

id

String

节目ID。

lastUpdatedBy

String

更新者。

materialSizeStr

String

节目的总素材大小(含单位)。

playTime

Integer

节目的总播放时长，单位秒。

programName

String

节目名称。

updateTime

Long

更新时间。

请求消息示例

GET /v1/usg/sss/programs?offset=0&limit=5&searchKey=
Connection: keep-alive
X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE
Content-Type: application/json
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: a4facce44898sda03629afd189da71df

{
    "count": 1,
    "data": {
        "id": "e36e633ccaee4cd0a6ffda6b6a65473c",
        "lastUpdatedBy": "",
        "materialSizeStr": "462.71KB",
        "playTime": 10,
        "programName": "VCpBgDe4IM",
        "updateTime": 1593538222443
    },
    "limit": 5,
    "offset": 0
}

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' 
https://api.meeting.huaweicloud.com/v1/usg/sss/publications?offset=0&limit=10
父主题： 信息窗节目管理

相关文档