You need to enable JavaScript to run this app.
导航
获取预置位信息
最近更新时间:2023.07.06 15:25:38首次发布时间:2023.01.09 17:19:04

获取设备预置位信息。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称QueryPresetInfo
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
SipIDQueryStringSIP 服务器 ID

Body 参数

字段
类型
必填
说明
DeviceIDString设备国标 ID,可通过调用 ListDevices 接口获取
ChannelIDString通道 ID,可通过调用 ListStreams 接口获取
TimeOutInt查询超时时间,单位:秒(默认值5秒)

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
NumInteger查询到的记录数量
ItemArray of objects查询到的预置位信息列表,参考以下 预置位信息结构说明

预置位信息结构说明

字段
类型
说明
PresetIDInteger预置位 ID
PresetNameString预置位名称(预置位1,预置位2,...)

示例

请求示例

POST https://open.volcengineapi.com?Action=QueryPresetInfo
&Version=2021-01-01
&SipID=340200000020xxxxxxxx
&<公共请求参数>
{
    "DeviceID":"340200859911xxxxxxxx",
    "ChannelID":"110000005813xxxxxxxx",
    "timeout": 30
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022020809562401020404907915037F68",
        "Action": "QueryPresetInfo",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Num": 1,
        "Item": [
            {
               "PresetID": 1,
               "PresetName": "预置位1"
        ]
}