方舟物联网使用手册

# GetSipChannelList

# 使用说明

  • 调用该接口查询指定监控设备的通道列表。

# 请求参数

参数名称 类型 是否必选 示例值 描述
Action String 是 GetSipChannelList 系统规定参数。取值：GetSipChannelList。
CurrentPage Integer 是 1 指定显示返回结果中的第几页。
PageSize Integer 是 2 指定返回结果中每页显示的通道数量，最大值是200。
IotInstanceId String 是 7159249318287***** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
SipDeviceName String 是 3101150099118014**** 设备认证用户名，长度不能超过20位
SipChannelId String 否 3101150099118014**** 监控通道国标ID，长度不能超过20位
SipChannelName String 否 3101150099118014**** 监控通道名称，长度不能超过32位
BatchNum String 否 69855823814407**** 监控通道批次号，长度不能超过64位

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回的监控通道信息。具体信息请参见以下参数。
CurrentPage Integer 1 当前页号。
List Array of SipChannelInfo 监控通道信息列表。
SipChannelInfo
SipDeviceName String 3101150099118014**** 设备认证用户名
SipChannelId String 3101150099118014**** 监控通道国标ID
SipChannelName String 3101150099118014**** 监控通道名称
Status Long 3 监控通道状态：1 未注册；2 禁用；3 在线 4 离线
RegisterTime Long 1760585287000 通道注册时间戳
PageCount Integer 92 总页数。
PageSize Integer 2 每页显示的监控通道数。
Total Integer 184 监控通道总数。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String 5uBO0qPQCgvK6HFOSszqN5baKBaAIxfS 平台为该请求生成的唯一标识符。
Success Boolean true 是否调用成功。
true：表示调用成功。
false：表示调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=GetSipChannelList
&CurrentPage=1
&PageSize=2
&IotInstanceId=7159249318287*****
&SipDeviceName=3101150099118014****
&SipChannelId=3101150099118014****
&SipChannelName=3101150099118014****
&BatchNum=69855823814407****
&Status=3
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
  <Data>
    <PageCount>92</PageCount>
    <PageSize>2</PageSize>
    <List>
      <SipChannelInfo>
        <SipDeviceName>secret</SipDeviceName>
        <SipChannelId>3101150099118014****</SipChannelId>
        <SipChannelName>3101150099118014****</SipChannelName>
        <Status>3</Status>
        <RegisterTime>1760585287000</RegisterTime>
      </SipChannelInfo>
    </List>
    <CurrentPage>1</CurrentPage>
    <Total>184</Total>
  </Data>
  <RequestId>5uBO0qPQCgvK6HFOSszqN5baKBaAIxfS</RequestId>
  <Success>true</Success>
</xml>

JSON格式

{
  "Data": {
    "PageCount": 92,
    "PageSize": 2,
    "List": {
      "SipChannelInfo": [
        {
          "SipDeviceName": "secret",
          "SipChannelId": "3101150099118014****",
          "SipChannelName": "3101150099118014****",
          "Status": 3,
          "RegisterTime": "1760585287000"
        }
      ]
    },
    "CurrentPage": 1,
    "Total": 184
  },
  "RequestId": "5uBO0qPQCgvK6HFOSszqN5baKBaAIxfS",
  "Success": true
}

← 预览播放 →