X-Link API Document | X-Link API Document

device parameter config

Device parameter setting and query, contain media parameters

Get terminal parameters

API info

Url: /web_api/v1/dev_manage/get_dev_param

Method: GET

Content-Type:x-www-form-urlencoded

Request parameter

field	type	required	desc
vehicleNo	string	Yes	Plate No.
paramIDs	string	No	Parameter ID list,Empty indicates that all queries are queried. Multiple queries are separated by commas (,)

Response Data (type:array(object))

Definition viewTable 1: Parameter info

Example

Request example

url

http://localhost:8080/web_api/v1/dev_manage/get_dev_param?vehicleNo=130000000001&paramIDs=1,16

http://localhost:8080/web_api/v1/dev_manage/get_dev_param?vehicleNo=130000000001&paramIDs=1,16

Response sample

json

{
    "code": 200,
    "msg": "Success",
    "data": [{
        "paramID": 1,   //device heartbeat sending interval
        "paramType": 2 , //It is a 4-byte integer
        "paramContent": "60" //All param Content is an integer
    },{
        "paramID": 16, //Primary server APN
        "paramType": 3 , //string
        "paramContent": "127.0.0.1"
    }]
}

{
    "code": 200,
    "msg": "Success",
    "data": [{
        "paramID": 1,   //device heartbeat sending interval
        "paramType": 2 , //It is a 4-byte integer
        "paramContent": "60" //All param Content is an integer
    },{
        "paramID": 16, //Primary server APN
        "paramType": 3 , //string
        "paramContent": "127.0.0.1"
    }]
}

Set device configuration

API info

Url: /web_api/v1/dev_manage/set_dev_param

Method: POST

Content-Type:application/json

Request parameter

field	type	required	desc
vehicleNos	array(string)	Yes	Plate No. list
items	array(object)	Yes	Parameter list,table1

Response Data

None

Example

Request example

json

http://localhost:8080/web_api/v1/dev_manage/set_dev_param
{
    "vehicleNos": ["130000001"],
    "items": [{
        "paramID": 1,
        "paramType": 2,
        "paramContent":"70"
    },{
        "paramID": 117, // audio video param
        "paramType": 4 , //json object string
        "paramContent": "{\"enableAudio\":1,\"rtCodecMode\":0,\"rtResolution\":1,\"rtKeyFrameInteval\":12,\"rtTargetFrameRate\":6,\"rtTargetBitRate\":200,\"stCodecMode\":0,\"stResolution\":5,\"stKeyFrameInteval\":30,\"stTargetFrameRate\":15,\"stTargetBitRate\":1200,\"osd\":11}"
    }]
}

http://localhost:8080/web_api/v1/dev_manage/set_dev_param
{
    "vehicleNos": ["130000001"],
    "items": [{
        "paramID": 1,
        "paramType": 2,
        "paramContent":"70"
    },{
        "paramID": 117, // audio video param
        "paramType": 4 , //json object string
        "paramContent": "{\"enableAudio\":1,\"rtCodecMode\":0,\"rtResolution\":1,\"rtKeyFrameInteval\":12,\"rtTargetFrameRate\":6,\"rtTargetBitRate\":200,\"stCodecMode\":0,\"stResolution\":5,\"stKeyFrameInteval\":30,\"stTargetFrameRate\":15,\"stTargetBitRate\":1200,\"osd\":11}"
    }]
}

Response example

json

{
    "hdr":{
        "code":200,
        "message":"success"
    },"data":["130000001"]
}

{
    "hdr":{
        "code":200,
        "message":"success"
    },"data":["130000001"]
}

Table 1: Parameter info

field	type	desc
paramID	integer	Parameter ID, refer current page (table 2)
paramType	integer	The parameter type is 0:byte. 1:integer2(a 2-byte integer). 2:integer4(a four-byte integer). 3:string(string); 4:stringObject(String object)
paramContent	string	Parameter content

Table 2: JT808 Param ID define

ID	type	desc
1	integer4	Interval for sending heartbeat packets, in seconds
2	integer4	Timeout duration of TCP message response, in seconds
3	integer4	Number of TCP message retransmission times
4	integer4	UDP message response timeout interval, in seconds
5	integer4	UDP message retransmission times
6	integer4	Timeout duration of SMS message response, in seconds
7	integer4	Number of SMS message retransmission times
16	string	Primary server APN
17	string	Primary server user
18	string	Primary server dial-up password for wireless communication
19	string	Primary server address
20	string	Backup server APN
21	string	Secondary server user
22	string	Wireless dial-up password of the standby server
23	string	Secondary server address
24	integer4	Server TCP port
25	integer4	Server UDP port
26	string	IC card authentication master server address
27	integer4	Road transport certificate IC card authentication master server TCP port
28	integer4	Road transport card IC card authentication master server UDP port
29	string	Road transport card IC card authentication backup server IP address or domain name port is the same as the primary server
32	integer4	Position reporting strategy
33	integer4	Position reporting scheme
34	integer4	The driver does not log in to report the interval, the unit is seconds (s),>0
39	integer4	Interval for reporting sleep, expressed in seconds (s), >0
40	integer4	Emergency alarm reporting time interval, the unit is second (s), >0
41	integer4	The default time reporting interval, in seconds (s), is >0
44	integer4	The default reporting interval, in meters (m), is >0
45	integer4	The driver did not log in to report the distance interval, in meters (m), >0
46	integer4	The distance reported at sleep, in meters (m), is >0
47	integer4	Emergency alarm reporting distance interval, the unit is m (m), >0
48	integer4	Inflexion Angle, <180
49	integer2	The electronic fence radius is measured in meters
64	string	Monitoring platform phone numbers
65	string	Reset the phone number, you can use this phone number to dial the terminal phone to reset the terminal
66	string	Restore phone numbers to factory Settings
67	string	Monitor platform SMS phone numbers
68	string	Receiving terminal SMS text alarm number
69	integer4	Terminal answering policy: 0: automatically answers the phone. 1: Automatic answer when ACC is ON, manual answer when OFF
70	integer4	The maximum duration of a call is expressed in seconds (s), where 0 indicates no call and 0xFFFFFFFF indicates no limit
71	integer4	The minimum duration of a call is expressed in seconds (s), where 0 indicates no call and 0xFFFFFFFF indicates no limit
72	string	Monitor telephone numbers
73	string	Monitor platform privilege SMS numbers
80	integer4	The alarm shielding word corresponds to the alarm mark in the location information reporting message. If the corresponding bit is 1, the corresponding alarm is shielded
81	integer4	Alarm sending text SMS switch, corresponding to the alarm sign in the location information reporting message, the corresponding bit is 1, the corresponding alarm text SMS is sent
82	integer4	The alarm shooting switch corresponds to the alarm mark in the position information reporting message, and the corresponding bit is 1 when the corresponding alarm is shot by the camera
83	integer4	The alarm shooting storage mark corresponds to the alarm mark in the location information reporting message. If the corresponding bit is 1, the photo taken during the corresponding alarm will be stored, otherwise it will be uploaded in real time
84	integer4	The key mark corresponds to the alarm mark in the location information reporting message. If the corresponding bit is 1, the corresponding alarm is the key alarm
85	integer4	Maximum speed in kilometers per hour (km/h)
86	integer4	Overspeed duration, in seconds (s)
87	integer4	Continuous driving time threshold, in seconds (s)
88	integer4	The cumulative driving time threshold for the day, in seconds (s)
89	integer4	Minimum rest time, in seconds (s)
90	integer4	Maximum stopping time, in seconds (s)
91	integer2	Overspeed alarm warning difference, the unit is 1/10Km/h
92	integer2	Fatigue driving warning difference, in seconds (s), >0
93	integer2	Collision alarm parameter setting: b7-b0: collision time, unit 4ms; b15-b8: Collision acceleration, unit 0.1g. The value ranges from 0 to 79. The default value is 10.
94	integer2	Rollover alarm parameter setting: rollover Angle, unit 1 degree, default is 30 degrees.
100	integer4	Timing camera control
101	integer4	Range camera control
112	integer4	Image/video quality, 1-10, 1 is best
113	integer4	Brightness, 0-255
114	integer4	Contrast ratio, 0-127
115	integer4	Saturation，0-127
116	integer4	chroma，0-255
128	integer4	Vehicle odometer reading，1/10km
129	integer2	The province where the vehicle is located ID
130	integer2	The city where the vehicle is located ID
131	string	A motor vehicle license plate issued by the traffic administration department of public security
132	byte	License plate color, according to JT/T415-2006 5.4.12
144	byte	GNSS positioning mode
145	byte	GNSS Baud rate
146	byte	The GNSS module locates the data output frequency in detail
147	integer4	GNSS module detailed positioning data acquisition frequency, in seconds, the default is 1.
148	byte	GNSS module detailed positioning data upload mode
149	integer4	GNSS module detailed positioning data upload Settings
256	integer4	CAN bus channel 1 Collection interval (ms), 0 indicates no collection
257	integer2	CAN bus channel 1 Upload interval (s). 0 indicates that no upload is performed
258	integer4	CAN bus channel 2 Collection interval (ms). 0 indicates no collection
259	integer2	CAN bus channel 2 Upload interval (s). 0 indicates that no upload is performed

Table 3: JT1078 video param ID define

ID	type	desc
117	stringObject	Audio video param setting,paramContent is a json string,refer current page table 4
118	stringObject	Audio video channel setting,paramContent is a json string,refer current page table 5
119	stringObject	Single audio video,paramContent is a json string,refer current page table 6

table 4: Audio video param setting(object)

field	type	desc
enableAudio	integer	Enable audio,0:no,1:yes
rtCodecMode	integer	Realtime mode 0:CBR(Fixed);1:VBR(Variable);2:ABR(Average)
rtResolution	integer	Realtime resolution 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
rtKeyFrameInteval	integer	Realtime key frame inteval ,range(1000) frames
rtTargetFrameRate	integer	Realtime frame rate ,range(1-120)fps
rtTargetBitRate	integer	Realtime bit rate ,(kbps)
stCodecMode	integer	Storage mode 0:CBR(Fixed); 1:VBR(Variable); 2:ABR(Average)
stResolution	integer	Storage resolution 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
stKeyFrameInteval	integer	Storage key frame inteval range(1000) frames
stTargetFrameRate	integer	Storage frame rate ,range(1-120)fps
stTargetBitRate	integer	Storage bit rate ,(kbps)
osd	integer	OSD,by bit:bit0:datetime,1:plate no.;2:channel;3.longlat;4:drive speed;5:location speed;6:drive time

table 5: Audio video channel setting

field	type	desc
audioVideoCnt	integer	Audio video num
audioCnt	integer	Audio num
videoCnt	integer	Video num
list	array(object)	Channel info,refer table (channel info)

Channel info

field	type	desc
physicsChannelNo	integer	physics channel, start 0
logicChannelNo	integer	Logic channel,refer public define table 2
chType	integer	Channel type,0:audio video;1:audio;2:video
isConnectPTZ	integer	Connect PTZ,channel type is 0 ,2 valid

table 6: Single audio video setting

field	type	desc
item	array(object)	Single audio video setting list,refer table (single channel info)

Single channel info

field	type	desc
channelNo	integer	channel no
rtCodecMode	integer	Realtime mode 0:CBR(Fixed);1:VBR(Variable);2:ABR(Average)
rtResolution	integer	Realtime resolution 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
rtKeyFrameInteval	integer	Realtime key frame inteval ,range(1000) frames
rtTargetFrameRate	integer	Realtime frame rate ,range(1-120)fps
rtTargetBitRate	integer	Realtime bit rate ,(kbps)
stCodecMode	integer	Storage mode 0:CBR(Fixed); 1:VBR(Variable); 2:ABR(Average)
stResolution	integer	Storage resolution 0:QCIF;1:CIF;2:WCIF:3:D1;4:WD1;5:720P;6:1080P
stKeyFrameInteval	integer	Storage key frame inteval range(1000) frames
stTargetFrameRate	integer	Storage frame rate ,range(1-120)fps
stTargetBitRate	integer	Storage bit rate ,(kbps)
osd	integer	OSD,by bit:bit0:datetime,1:plate no.;2:channel;3.longlat;4:drive speed;5:location speed;6:drive time

Start

Request response

Push

Real-time

Historical

device parameter config

Get terminal parameters

Url: /web_api/v1/dev_manage/get_dev_param

Method: GET

Content-Type:x-www-form-urlencoded

Request parameter

Response Data (type:array(object))

Example

Request example

Response sample

Set device configuration

Url: /web_api/v1/dev_manage/set_dev_param

Method: POST

Content-Type:application/json

Request parameter

Response Data

Example

Request example

Response example

Table 1: Parameter info

Table 2: JT808 Param ID define

Table 3: JT1078 video param ID define

table 4: Audio video param setting(object)

table 5: Audio video channel setting

Channel info

table 6: Single audio video setting

Single channel info

device parameter config ​

Get terminal parameters ​

Url: /web_api/v1/dev_manage/get_dev_param ​

Method: GET ​

Content-Type:x-www-form-urlencoded ​

Request parameter ​

Response Data (type:array(object)) ​

Example ​

Request example ​

Response sample ​

Set device configuration ​

Url: /web_api/v1/dev_manage/set_dev_param ​

Method: POST ​

Content-Type:application/json ​

Request parameter ​

Response Data ​

Example ​

Request example ​

Response example ​

Table 1: Parameter info ​

Table 2: JT808 Param ID define ​

Table 3: JT1078 video param ID define ​

table 4: Audio video param setting(object) ​

table 5: Audio video channel setting ​

Channel info ​

table 6: Single audio video setting ​

Single channel info ​

device parameter config

Get terminal parameters

Url: /web_api/v1/dev_manage/get_dev_param

Method: GET

Content-Type:x-www-form-urlencoded

Request parameter

Response Data (type:array(object))

Example

Request example

Response sample

Set device configuration

Url: /web_api/v1/dev_manage/set_dev_param

Method: POST

Content-Type:application/json

Request parameter

Response Data

Example

Request example

Response example

Table 1: Parameter info

Table 2: JT808 Param ID define

Table 3: JT1078 video param ID define

table 4: Audio video param setting(object)

table 5: Audio video channel setting

Channel info

table 6: Single audio video setting

Single channel info