更新时间:2023-12-18 GMT+08:00
分享

根据ID查询信息窗发布详情

描述

根据ID查询信息窗发布详情。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/sss/publications/{id}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

id

String

Path

发布ID。

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 响应参数

参数

类型

描述

createTime

Long

创建时间。

endTime

Long

结束时间。

id

String

发布ID。

lastUpdatedBy

String

更新者。

publishName

String

发布名称。

publishScope

String

发布范围。

publishStatus

String

根据当前时间确定发布状态。

  • NOT_ONLINE - 未上线

  • PUBLISHING - 发布中

  • ALREADY_OFFLINE - 已下线

startTime

Long

开始时间。

updateTime

Long

更新时间。

deptList

Array of PublishDeptResponseDTO objects

发布部门列表。

deviceList

Array of PublishDeviceResponseDTO objects

发布设备列表。

programList

Array of ProgramResponseBase objects

发布节目ID列表。

表5 PublishDeptResponseDTO 数据结构

参数

类型

描述

deptCode

String

部门编码。

deptName

String

部门名称。

表6 PublishDeviceResponseDTO 数据结构

参数

类型

描述

deviceName

String

设备名称。

deviceUserId

String

设备用户ID。

表7 ProgramResponseBase 数据结构

参数

类型

描述

id

String

节目ID。

lastUpdatedBy

String

更新者。

materialSizeStr

String

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

playTime

Integer

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

programName

String

节目名称。

updateTime

Long

更新时间。

请求消息示例

GET /v1/usg/sss/publications/bfccb099e6e34dca95f72c1404c68cd9
Connection: keep-alive
X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE
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
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 149e8b71037898deffc5e2a44b5e5c230

{
    "id": "bfccb099e6e34dca95f72c1404c68cd9",
    "lastUpdatedBy": "",
    "createTime": 1593538210692,
    "updateTime": 1593538210692,
    "publishName": "NZmsGuY4J6",
    "publishScope": "",
    "startTime": 0,
    "endTime": 253402271999000,
    "publishStatus": "PUBLISHING",
    "programList": [
        {
            "id": "f7350ac9a4aa41beac142dd588f39fbe",
            "lastUpdatedBy": "",
            "updateTime": 1593538210605,
            "programName": "c5bc3AwzNr",
            "materialSizeStr": "462.71KB",
            "playTime": 10
        }
    ],
    "deptList": [
        {
            "deptCode": "SZ1mBIAdBP",
            "deptName": null
        }
    ],
    "deviceList": [
        {
            "deviceUserId": "B6l75EEqjh",
            "deviceName": null
        }
    ]
}

错误码

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

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' https://api.meeting.huaweicloud.com/v1/usg/sss/publications/bfccb099e6e34dca95f72c1404c68cd9

相关文档