Skip to content
本页目录

 

ThingsKit物联网平台

开箱即用的物联网低代码平台

视频配置新增和编辑

接口地址:/api/yt/video

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

javascript
{
  "accessMode": 0,
  "id": "",
  "name": "",
  "organizationId": ""
  "videoPlatformDTO": {
    "appKey": "",
    "appSecret": "",
    "ssl": 0,
    "type": 0,
  },
  "videoPlatformId": "",
  "videoUrl": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

请求参数:

参数名称参数说明请求类型是否必须数据类型
tkVideoDTOTkVideoDTObodytrueTkVideoDTO
  accessMode流获取方式:0 手动填写 1平台获取trueinteger(int32)
  additionalJson摄像头附加信息,json格式falsestring
  avatar封面图falsestring
  brand摄像头厂家falsestring
  createTime创建时间falsestring(date-time)
  creator创建用户falsestring
  defaultConfig租户默认配置falsestring
  description摄像头描述falsestring
  deviceType摄像头型号falsestring
  enabled租户状态:启用/禁用falseboolean
  icon租户图标falsestring
  idIDfalsestring
  name租户名称falsestring
  organizationId组织IDtruestring
  organizationName组织名称falsestring
  playProtocol播放协议:0 http 1 httpsfalseinteger(int32)
  roleIds租户角色列表falsearray
  sn摄像头编号/监控点位编号truestring
  status摄像头状态falseboolean
  streamType码流:0主码流 1子码流 2第三码流falseinteger(int32)
  tenantExpireTime租户到期时间falsestring(date-time)
  tenantId租户IDfalsestring
  tenantProfileId租户配置falsestring
  tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
  updateTime更新时间falsestring(date-time)
  updater更新用户falsestring
  videoPlatformDTO流媒体平台基础信息falseTkVideoPlatformDTO
    appKey秘钥appKeytruestring
    appSecret秘钥appSecrettruestring
    createTime创建时间falsestring
    creator创建用户falsestring
    defaultConfig租户默认配置falsestring
    description租户描述falsestring
    enabled租户状态:启用/禁用falseboolean
    host平台地址+端口truestring
    icon租户图标falsestring
    idIDfalsestring
    name租户名称falsestring
    roleIds租户角色列表falsearray
    ssl流媒体部署环境trueinteger
    tenantExpireTime租户到期时间falsestring
    tenantId租户IDfalsestring
    tenantProfileId租户配置falsestring
    tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
    type平台类型trueinteger
    updateTime更新时间falsestring
    updater更新用户falsestring
  videoPlatformId平台IDfalsestring
  videoUrl视频URLfalsestring

响应参数:

参数名称参数说明类型
accessMode流获取方式:0 手动填写 1平台获取integer(int32)
additionalJson摄像头附加信息,json格式string
avatar封面图string
brand摄像头厂家string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description摄像头描述string
deviceType摄像头型号string
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
organizationId组织IDstring
organizationName组织名称string
playProtocol播放协议:0 http 1 httpsinteger(int32)
roleIds租户角色列表array
sn摄像头编号/监控点位编号string
status摄像头状态boolean
streamType码流:0主码流 1子码流 2第三码流integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
videoPlatformDTO流媒体平台基础信息TkVideoPlatformDTO
  appKey秘钥appKeystring
  appSecret秘钥appSecretstring
  createTime创建时间string(date-time)
  creator创建用户string
  defaultConfig租户默认配置string
  description租户描述string
  enabled租户状态:启用/禁用boolean
  host平台地址+端口string
  icon租户图标string
  idIDstring
  name租户名称string
  roleIds租户角色列表array
  ssl流媒体部署环境integer(int32)
  tenantExpireTime租户到期时间string(date-time)
  tenantId租户IDstring
  tenantProfileId租户配置string
  tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
  type平台类型integer(int32)
  updateTime更新时间string(date-time)
  updater更新用户string
videoPlatformId平台IDstring
videoUrl视频URLstring

响应示例:

javascript
{
	"accessMode": 0,
	"additionalJson": "",
	"avatar": "",
	"brand": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"deviceType": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationId": "",
	"organizationName": "",
	"playProtocol": 0,
	"roleIds": [],
	"sn": "",
	"status": false,
	"streamType": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": "",
	"videoPlatformDTO": {
		"appKey": "",
		"appSecret": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"host": "",
		"icon": "",
		"id": "",
		"name": "",
		"roleIds": [],
		"ssl": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"type": 0,
		"updateTime": "",
		"updater": ""
	},
	"videoPlatformId": "",
	"videoUrl": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

删除视频配置(待翻译)

接口地址:/api/yt/video

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

javascript
{
  "ids": [],
  "tenantId": ""
}
1
2
3
4

请求参数:

参数名称参数说明请求类型是否必须数据类型
deleteDTODeleteDTObodytrueDeleteDTO
  ids删除ID列表truearray
  tenantId租户IDfalsestring

响应参数:

参数名称参数说明类型
errorCodePlatform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - Too many updates (Too many updates over Websocket session)\n\n* 40 - Subscription violation (HTTP: 403 - Forbidden)object
messageError messagestring
statusHTTP Response Status Codeinteger(int32)
timestampTimestampstring(date-time)

获取平台视频流播放地址

接口地址:/api/yt/video/url/{entityId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
entityIdentityIdpathtruestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
dataobject
messagestring

响应示例:

javascript
{
	"code": 0,
	"data": {},
	"message": ""
}
1
2
3
4
5

视频配置分页

接口地址:/api/yt/video{?name,orderFiled,orderType,organizationId,page,pageSize,status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint
statusstatusfalseboolean
namenamefalsestring
organizationIdorganizationIdfalsestring
orderFiledorderFiledfalsestring
orderTypeorderType,可用值:ASC,DESCfalsestring

响应参数:

参数名称参数说明类型
itemsarray
  accessMode流获取方式:0 手动填写 1平台获取integer(int32)
  additionalJson摄像头附加信息,json格式string
  avatar封面图string
  brand摄像头厂家string
  createTime创建时间string(date-time)
  creator创建用户string
  defaultConfig租户默认配置string
  description摄像头描述string
  deviceType摄像头型号string
  enabled租户状态:启用/禁用boolean
  icon租户图标string
  idIDstring
  name租户名称string
  organizationId组织IDstring
  organizationName组织名称string
  playProtocol播放协议:0 http 1 httpsinteger(int32)
  roleIds租户角色列表array
  sn摄像头编号/监控点位编号string
  status摄像头状态boolean
  streamType码流:0主码流 1子码流 2第三码流integer(int32)
  tenantExpireTime租户到期时间string(date-time)
  tenantId租户IDstring
  tenantProfileId租户配置string
  tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
  updateTime更新时间string(date-time)
  updater更新用户string
  videoPlatformDTO流媒体平台基础信息TkVideoPlatformDTO
    appKey秘钥appKeystring
    appSecret秘钥appSecretstring
    createTime创建时间string
    creator创建用户string
    defaultConfig租户默认配置string
    description租户描述string
    enabled租户状态:启用/禁用boolean
    host平台地址+端口string
    icon租户图标string
    idIDstring
    name租户名称string
    roleIds租户角色列表array
    ssl流媒体部署环境integer
    tenantExpireTime租户到期时间string
    tenantId租户IDstring
    tenantProfileId租户配置string
    tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
    type平台类型integer
    updateTime更新时间string
    updater更新用户string
  videoPlatformId平台IDstring
  videoUrl视频URLstring
totalinteger(int32)

响应示例:

javascript
{
	"items": [
		{
			"accessMode": 0,
			"additionalJson": "",
			"avatar": "",
			"brand": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"deviceType": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"organizationId": "",
			"organizationName": "",
			"playProtocol": 0,
			"roleIds": [],
			"sn": "",
			"status": false,
			"streamType": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": "",
			"videoPlatformDTO": {
				"appKey": "",
				"appSecret": "",
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"host": "",
				"icon": "",
				"id": "",
				"name": "",
				"roleIds": [],
				"ssl": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"type": 0,
				"updateTime": "",
				"updater": ""
			},
			"videoPlatformId": "",
			"videoUrl": ""
		}
	],
	"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

获取当前用户的流媒体配置列表

接口地址:/api/yt/video/platform

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

暂无

响应参数:

参数名称参数说明类型
appKey秘钥appKeystring
appSecret秘钥appSecretstring
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态:启用/禁用boolean
host平台地址+端口string
icon租户图标string
idIDstring
name租户名称string
roleIds租户角色列表array
ssl流媒体部署环境integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
type平台类型integer(int32)
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

javascript
[
	{
		"appKey": "",
		"appSecret": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"host": "",
		"icon": "",
		"id": "",
		"name": "",
		"roleIds": [],
		"ssl": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"type": 0,
		"updateTime": "",
		"updater": ""
	}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24