开发者中心 - 小鱼易连

【功能说明】

监控摄像头 IPC相关的 api 集中在本页

1、ipc组织架构部门查询

初始平台：公有云，分区云 2023

GET https://sdk.xylink.com/api/rest/external/v1/ipc/organization/page?enterpriseId=***&depCode=***&pageIndex=**&pageSize=**&signature=***

参数说明

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业id
signature	String	Query	是	无	签名值
depCode	String	Query	是	无	部门编码
isAll	boolean	Query	否	false	是否返回当前部门所有层级子部门 true，返回当前部门所有子部门信息 false，只返回当前部门子部门
pageIndex	Integer	Query	否	0	pageIndex的取值范围为 [0, +oo)
pageSize	Integer	Query	否	20	pageSize的取值范围为 (0, 100]

返回成功结果示例：

{
    "page": 0,
    "pageTotal": 1,
    "rowsTotal": 1,
    "rows": 7,
    "list": [
        {
            "depCode": "2c926ba8804ffb0a01804ffd30950000",
            "depName": "2c926ba8804ffb0a01804ffd30950000",
            "parentCode": "2c926ba8804ffb0a01804ffd30950000"
        }
    ]
}

返回结果字段说明:

字段名称	备注
page	当前页码
pageTotal	总页数
rowsTotal	数据总数
rows	每页数据数量
depCode	部门编码
depName	部门名称
parentCode	父部门编码

2、分页获取企业下ipc列表

初始平台：公有云，分区云 2023

GET    https://sdk.xylink.com/api/rest/external/v1/ipc/page?enterpriseId=**&pageIndex=**&pageSize=**&signature=***

参数说明

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseld	String	Query	是	无	企业ID,通过管理平台-云视讯API获得
signature	String	Query	是	无	API签名，参见签名规则
pagelndex	int	Query	是	0	页码
pageSize	int	Query	是	20	每页查询数量，建议不大于50

返回结果：

{
  "page": 0,
  "pageTotal": 2,
  "rowsTotal": 1,
  "rows": 2,
  "list": [
    {
      "id": "***",
      "displayName": "",
      "online": true,
      "ip": "***"
    },
    {
      "id": "***",
      "displayName": "",
      "online": false,
      "ip": "***"
    }
  ]
}

成功时返回结果数据，失败时返回小鱼RESTAPI 错误码

参数名称	说明
id	ipc设备id
displayName	ipc设备显示名称
online	ipc设备是否在线(true或false)
ip	ipc设备ip

3、分页获取企业部门下ipc设备列表

初始平台：公有云，分区云 2023

GET https://sdk.xylink.com/api/rest/external/v1/ipc/query/page?enterpriseId=***&depCode=***&pageIndex=**&pageSize=**&signature=***

参数类型

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业id
signature	String	Query	是	无	签名值
depCode	String	Query	是	无	部门编码
pageIndex	Integer	Query	否	0	页号
pageSize	Integer	Query	否	20	每页条数，最大100

返回成功结果示例：

{
    "page": 1,
    "pageTotal": 2,
    "rowsTotal": 4,
    "rows": 3,
    "list": [
        {
            "id": "8a8087758437701c0184379b2e93000b",
            "displayName": "北京海康-小鱼易连办公室2",
            "online": true,
            "ip": "127.0.0.1",
            "extId": "11010000001310000019",
            "ipcType": 0,
            "longitude": 0.0,
            "latitude": 0.0,
            "altitude": 0.0
        }
    ]
}

返回结果字段说明:

参数	说明
page	当前页码
pageTotal	总页数
rowsTotal	数据总数
rows	每页数据数量
id	ipc设备id
displayName	ipc设备显示名称
online	ipc设备是否在线（true或false）
ip	ipc设备ip
extid	设备唯一编码
ipcType	摄像机类型
longitude	经度（度）
latitude	纬度（度）
altitude	海拔（米）

4.根据摄像头ID查询监控点信息

初始平台：公有云不存在，分区云 20250328

POST https://sdk.xylink.com/api/rest/external/v1/ipc/queryByExtIds?enterpriseId=***&signature=***

参数类型

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业id
signature	String	Query	是	无	签名值
extIds	List	Body	是	无	extId的集合，最大100个

请求参数：

["00000000001310000010","45010720001320108885"]

返回成功结果示例：

[
    {
        "id": "029402eb7a529329017a7fca660e370d",
        "displayName": "科达-XXX数据中心_camera",
        "online": false,
        "ip": "",
        "extId": "00000000001310000010",
        "ipcType": 0,
        "longitude": 0.0,
        "latitude": 0.0,
        "altitude": 0.0
    },
    {
        "id": "029402eb7a529329017a7fca64cb365c",
        "displayName": "科达-xxx市场门口-二期",
        "online": true,
        "ip": "45.5.91.13",
        "extId": "45010720001320108885",
        "ipcType": 0,
        "longitude": 108.279,
        "latitude": 22.8486,
        "altitude": 0.0
    }
]

返回结果字段说明:

参数	说明
id	ipc设备id
displayName	ipc设备显示名称
online	ipc设备是否在线（true或false）
ip	ipc设备ip
extid	设备唯一编码
ipcType	摄像机类型
longitude	经度（度）
latitude	纬度（度）
altitude	海拔（米）

5、邀请 IPC 设备入会

初始平台：公有云，分区云 2023

PUT https://sdk.xylink.com/api/rest/external/v1/conferenceControl/ipc/invitation?enterpriseId=***&signature=***

参数类型

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业 ID，通过管理平台 - 云视讯 API 获得
signature	String	Query	是	无	API 签名，参见签名规则
callNumber	String	Body	是	无	邀请入会的云会议室号码
ipcList	List	Body	是	无	邀请入会的IPC设备列表
id	String	Body	是	无	邀请入会的IPC 设备 ID
displayName	String	Body	是	无	邀请入会的IPC 设备显示名称

请求示例：

{
  "callNumber": "***",
  "ipcList": [
    {
      "id": "***",
      "displayName": "***"
    },
    {
      "id": "***",
      "displayName": "***"
    }
  ]
}

返回结果：

成功时返回200,失败时返回小鱼RESTAPI 错误码

6、设置或取消ipc设备为主画面

初始平台：公有云，分区云 2023

设置或取消会议的主画面(仅支持云会议室呼叫支持设置主画面)

PUT https://sdk.xylink.com/api/rest/external/v1/conferenceControl/ipc/mainImage?enterpriseId=XXX&signature=XXX

参数类型

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业 ID，通过管理平台 - 云视讯 API 获得
signature	String	Query	是	无	API 签名，参见签名规则
callNumber	String	Body	是	无	云会议室号码
ipcDevice	Json	Body	否	无	设置为主画面的IPC设备，如果不传，表示取消当前主画面
id	String	Body	否	无	会中的IPC设备 ID
displayName	String	Body	否	无	会中的IPC设备显示名称

请求示例：

{
  "callNumber": "***",
  "ipcDevice": 
    {
      "id": "***",
      "displayName": "***"
    }
  
}

返回结果：

成功时返回200,失败时返回小鱼RESTAPI 错误码

7、会议中挂断ipc设备

初始平台：公有云，分区云 2023

PUT https://sdk.xylink.com/api/rest/external/v1/conferenceControl/ipc/disconnect?enterpriseId=***&signature=***

参数类型

参数	参数类型	参数位置	是否必须	默认值	说明
enterpriseId	String	Query	是	无	企业 ID，通过管理平台 - 云视讯 API 获得
signature	String	Query	是	无	API 签名，参见签名规则
callNumber	String	Body	是	无	云会议室号码
ipcDevice	Json	Body	是	无	要挂断的IPC设备
id	String	Body	是	无	会中的IPC设备 ID
displayName	String	Body	是	无	会中的IPC设备显示名称

请求示例：

{
  "callNumber": "***",
  "ipcDevice": 
    {
      "id": "***",
      "displayName": "***"
    }
  
}

返回结果：

成功时返回200,失败时返回小鱼RESTAPI 错误码

2025-11-04 14:06:06

导出PDF文档