SEEWORLD Technology Corp.

, Inc

Video Service API Document

March 2,2024
 SEEWORLD Technology Corp., Inc

1. version
version author date content
V1.0.0 SEEWORLD 2024.02.21 provide api document

2. range
This document defines the open interface for external real-time video

playback/playback

of the video service

This document defines the device playback resource list interface

3. Protocol overview
This communication interface is developed based on the HTTP1.1 + JSON protocol

4. API
4.1. Get the play address interface

4.1.1. description
Get the play address

4.1.2. URL
https://www.whatsgps.com/api/video/startPull.do

4.1.3. Http request mode

POST (application/json)

4.1.4. Request parameters

 SEEWORLD Technology Corp., Inc

name mandatory type description

deviceId yes String Device imei

key yes String key

channelNumber yes Integer Single channel device pass 1
tag yes Integer 0 real-time, 1 record, 2 intercom，
3 listen
longitude no String longitude

latitude no String latitude

startTime no String Start time, if record, please set

like: yyyy-MM-dd HH:mm:ss

endTime no String End time，if record, please set

like: yyyy-MM-dd HH:mm:ss

platform no Integer 0. web(default) 1. android 2.ios 3.

applet of wechat 4. PC

4.1.5. Response example

#normal
{
"data": {
"controlFlag": false,
"rtmpUrl": "",
"webFlvUrl": "https://video.whatsgps.com:1443/138.2.84.179-20443/jtt
1078/015610004170_1_0.live.flv",
"webUrl": "wss://video.whatsgps.com:1443/138.2.84.179-20443/jtt1078/
015610004170_1_0.live.flv",
"webrtcUrl": "https://video.whatsgps.com:1443/138.2.84.179-20443/ind
ex/api/webrtc?app=jtt1078&stream=015610004170_1_0&type=play"
},
 SEEWORLD Technology Corp., Inc
"ret": 1
}
#exception
{
"code": -108
"msg": "Device is offline, please try again later"
}

4.1.6. Response parameter description

name type description

controlFlag Boolean Whether to issue playback control

instruction (off instruction)
webUrl String websock play address

rtmpUrl String rtmp play address

webFlvUrl String https-flv play address

webrtcUrl String Webrtc playback address (Since v5 is

h265 encoding format,
Does not support native webrtc playback,
v6, v6s, v7 are
h264 encoding format, can use native
webrtc playback)

code String Error code

msg String Error description

4.2. Deliver the command to obtain playback resource

list interface

4.2.1. Description
Delivering the command to obtain playback resource
 SEEWORLD Technology Corp., Inc

4.2.2. URL
https://www.whatsgps.com/api/video/getVideoList.do

4.2.3. Http request mode

POST (application/json)

4.2.4. Request parameter

name mandatory type description

deviceId yes String Device imei

key yes String key

channelNumbe yes Integer Single channel device pass
r 1
startTime no String Start time, if record, please
set
like: yyyy-MM-dd HH:mm:ss
endTime no String End time，if record, please
set like:
yyyy-MM-dd HH:mm:ss

4.2.5. Response example

{
"data": {
"online": true,
"serNO": "fd52d9f9-1434-449e-b39e-489094945f39"
},
"ret": 1
}
 SEEWORLD Technology Corp., Inc

4.2.6. Response parameter description

name type description

online Boolean Online or not

serNO String Command sequence
number

4.3. Get the playback resource list of the device

interface

4.3.1. Description

Get the playback resource list of the device

4.3.2. URL

https://www.whatsgps.com/api/video/getVideoListRes.do

4.3.3. Http request mode

POST (application/json)

4.3.4. Request parameter

name mandatory type description

serNO yes String Command sequence number

key yes String key

 SEEWORLD Technology Corp., Inc

startTime no String Start time, if record, please set

like: yyyy-MM-dd HH:mm:ss

endTime no String End time，if record,please set

like:
yyyy-MM-dd HH:mm:ss

4.3.5. Response example

#normal：
{
"data": {
"imei": "863015610004305",
"resourceTotal": 112,
"videoResourceLists": [
{
"beginTime": "2024-01-05 08:48:41",
"endTime": "2024-01-05 08:54:05",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 09:14:53",
"endTime": "2024-01-05 09:44:17",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 09:56:35",
"endTime": "2024-01-05 10:18:21",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 11:05:46",
"endTime": "2024-01-05 11:12:53",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 11:15:19",
"endTime": "2024-01-05 11:38:56",
"fileSize": 0,
 SEEWORLD Technology Corp., Inc
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 12:15:36",
"endTime": "2024-01-05 12:22:37",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 13:29:23",
"endTime": "2024-01-05 13:36:25",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 14:06:13",
"endTime": "2024-01-05 14:11:33",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 14:21:55",
"endTime": "2024-01-05 14:34:21",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 14:55:52",
"endTime": "2024-01-05 15:16:13",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 15:23:43",
"endTime": "2024-01-05 15:34:30",
"fileSize": 0,
"logicChannelId": 1
},
{
"beginTime": "2024-01-05 15:37:48",
"endTime": "2024-01-05 16:38:00",
"fileSize": 0,
"logicChannelId": 1
},
 SEEWORLD Technology Corp., Inc
{
"beginTime": "2024-01-05 16:38:00",
"endTime": "2024-01-05 16:40:00",
"fileSize": 0,
"logicChannelId": 1
}
]
},
"ret": 1
}
#exception
{
"code": -108
"msg": "Device is offline,please try again later"
}

4.3.6. Response parameter description

name type description

imei String Device imei

resourceTotal Integer Resource total

videoResourceLists List<VideoResourceList> Media resource lists

videoResourceList VideoResourceList Media resource list
logicChannelId Integer Logic channel id
beginTime String Start time format：
yyyy-MM-dd HH:mm:ss
endTime String End time format：
yyyy-MM-dd HH:mm:ss
fileSize Integer File size
code String Error code
msg String Error description
 SEEWORLD Technology Corp., Inc

5. Error code table

code 5.1.1. message

-108 Device is offline, please try again later

-109 Media server expection

-110 No video stream exists on the current channel

of the device
-112 Request parameter exception

-113 The audio and video channels are in use and

cannot be operated
-128 This type is not supported
 SEEWORLD Technology Corp., Inc

6. Notice

6.1. One key supports simultaneous playback on 50

devices

6.2. The v5 video encoding is h265 requires the player

to support h265 decoding, and the audio encoding
format is PCMA

6.3. The video encoding format of v6, v6s, v7 is h264,

and the audio encoding format is PCMA

6.4. At present, only clients can access the intercom

through webrtc
SEEWORLD Technology Corp., Inc