DVRIP/Sofia response and command codes

Command and response codes are referenced from a Digital Video Recorder Interface Protocol, which can be found by following this link to python-dvr repository

Table of Contents

• Return Code Definitions
• Command Code Definitions
  • Login/Logout Keep-alive Agreement (C1 Message Number)
  • Get device information (C2 message number)
  • Request message numbers (C3~C11) to set/get configuration-related information
  • Get capability level request (C12 message number)
  • PTZ control (C13 message number)
  • Monitoring and control (C14 message number)
  • Playback control (C15 message number)
  • Voice intercommunications (C16 Message Number)
  • Document Query (C17 Message Number)
  • System Management (C18 Message Number)
  • Disk Management (C19 Message Number)
  • User Management C20 Message Number
  • Alarm Report (C21 Message Number)
  • System Upgrade (C22 Message Number)
  • Automatic Device Discovery (C23 Message Number)
  • System Information Import/Export (C24 Message Number)
  • Keyboard Control (C25 Message Number)
  • Snapshot Capture (C26 Message Number)
  • Serial Port Controls (C27 message number)
  • Time Synchronization
  • Screenshot Upload Message
  • Get Random User
  • Version List
  • FTP test

Return Code Definitions

Return Code	Definition
100	OK
101	unknown error
102	Version not supported
103	Illegal request
104	This user is already logged in
105	This user is not logged in
106	Incorrect username and password
107	No permission
108	time out
109	The search failed and the corresponding file was not found.
110	Search successful, return all files
111	The search was successful and some files were returned.
112	This user already exists
113	This user does not exist
114	This user group already exists
115	This user group does not exist
116	No description provided
117	Message format error
118	PTZ protocol not set
119	No files found
120	configured to enable
121	MEDIA_CHN_NOTCONNECT digital channel is not connected
150	Success, the device needs to be restarted
202	User is not logged in
203	Password is incorrect
204	Illegal user
205	User is locked
206	User is in blacklist
207	Username has already logged in
208	Input is illegal
209	Index duplication, such as the user to be added already exists, etc.
210	Object does not exist, when used for query
211	Object does not exist
212	Account is in use
213	The subset exceeds the scope (such as the group's permissions exceed the permissions table, the user's permissions exceed the group's permissions, etc.)
214	Password is invalid
215	Password does not match
216	Keep account
502	The command is illegal
503	Intercom is on
504	Intercom is not enabled
511	Upgrade has started
512	Upgrade not started
513	Upgrade data error
514	Upgrade failed
515	Upgrade successful
521	Restore default failed
522	Need to restart the device
523	The default configuration is illegal
602	Need to restart the application
603	Need to restart the system
604	Error writing file
605	Feature not supported
606	Authentication failed
607	Configuration does not exist
608	Configuration parsing error

Command Code Definitions

Login/Logout Keep-alive Agreement (C1 Message Number)

Name	Code	Description	Payload
LOGIN_REQ	999/1000	Login request	Login request body
LOGIN_RESP	1001	Login response	Login response body
LOGOUT_REQ	1002	Logout request	Not yet observed
LOGOUT_RESP	1003	Logout response	Not yet observed
FORCELOGOUT_REQ	1004	Force logout request	Not yet observed
FORCELOGOUT_RESP	1005	Force logout response	Not yet observed
KEEPALIVE_REQ	1006	Keep-alive request	Keep alive request
KEEPALIVE_RESP	1007	Keep-alive response	Keep alive response

Get device information (C2 message number)

Name	Code	Description	Payload
SYSINFO_REQ	1020	System information request	System info request body
SYSINFO_RESP	1021	System information response	System info response body

Request message numbers (C3~C11) to set/get configuration-related information

Name	Code	Description	Payload
CONFIG_SET	1040	Set configuration info requests	Set config info requests
CONFIG_SET_RSP	1041	Set configuration info responses	Set config info responses
CONFIG_GET	1042	Get configuration info requests	Get config info requests
CONFIG_GET_RESP	1043	Get configuration info responses	Get config info responses
DEFAULT_CONFIG_GET	1044	Get Default Configuration Request	Not yet observed
DEFAULT_CONFIG_GET_RSP	1045	Get the default configuration response	Not yet observed
CONFIG_CHANNELTILE_SET	1046	Set channel name	Not yet observed
CONFIG_CHANNELTILE_SET_RSP	1047	Set channel name response	Not yet observed
CHANNELTITLE_REQ	1048	Channel title request	Channel title request
CHANNELTITLE_RESP	1049	Channel title response	Channel title response
CONFIG_CHANNELTILE_DOT_SET	1050	Set channel name matrix request	Set channel name matrix request
CONFIG_CHANNELTILE_DOT_SET_RSP	1051	Set channel name matrix response	Set channel name matrix response
SYSTEM_DEBUG_REQ	1052	System debugging request	Not yet observed
SYSTEM_DEBUG_RESP	1053	System debugging response	Not yet observed

Get capability level request (C12 message number)

Name	Code	Description	Payload
ABILITY_GET	1360	System ability request	System ability request
ABILITY_GET_RESP	1361	System ability response	System ability response
SMARTH264_REQ	1362	Smart H264 request	Smart H264 request
SMARTH264_RESP	1363	Smart H264 response	Smart H264 response

PTZ control (C13 message number)

Name	Code	Description	Payload
PTZ_REQ	1400	PTZ control request	Not yet observed
PTZ_RESP	1401	PTZ control response	Not yet observed

Monitoring and control (C14 message number)

Name	Code	Description	Payload
MONITOR_REQ	1410	OP monitor request	OP monitor request
MONITOR_RSP	1411	OP monitor response	OP monitor response
MONITOR_DATA	1412	OP monitor data	JSON data not observed
MONITOR_CLAIM	1413	OP monitor claim request	OP monitor claim request
MONITOR_CLAIM_RSP	1414	OP monitor claim response	OP monitor claim response

Playback control (C15 message number)

Name	Code	Description	Payload
PLAY_REQ	1420	Playback request	Not yet observed
PLAY_RSP	1421	Playback response	Not yet observed
PLAY_DATA	1422	Playback data	Not yet observed
PLAY_EOF	1423	Playback end	Not yet observed
PLAY_CLAIM	1424	Playback stream claim request	Not yet observed
PLAY_CLAIM_RSP	1425	Playback stream claim response	Not yet observed
DOWNLOAD_DATA	1426	Download playback data	Not yet observed

Voice intercommunications (C16 Message Number)

Name	Code	Description	Payload
TALK_REQ	1430	Intercom request	Not yet observed
TALK_RESP	1431	Intercom response	Not yet observed
TALK_CU_PU_DATA	1432	CU to PU intercom data	Not yet observed
TALK_PU_CU_DATA	1433	PU to CU intercom data	Not yet observed
TALK_CLAIM	1434	Intercom stream claim request	Not yet observed
TALK_CLAIM_RSP	1435	Intercom stream claim response	Not yet observed

Document Query (C17 Message Number)

Name	Code	Description	Payload
FILESEARCH_REQ	1440	OP file query request	OP file query request
FILESEARCH_RSP	1441	OP file query response	OP file query response
LOGSEARCH_REQ	1442	OP log query request	OP log query request
LOGSEARCH_RSP	1443	OP log query response	OP log query response
FILESEARCH_BYTIME_REQ	1444	Request to search for files by time	Not yet observed
FILESEARCH_BYTIME_RESP	1445	Response to search for files by time	Not yet observed

System Management (C18 Message Number)

Name	Code	Description	Payload
SYSMANAGER_REQ	1450	System management request	OP default config request
SYSMANAGER_RESP	1451	System management response	OP default config response
OPTIMESETTING_REQ	1450	OP time setting request	OP time setting request
OPTIMESETTING_RESP	1451	OP time setting response	OP time setting response
TIMEQUERY_REQ	1452	OP time query request	OP time query request
TIMEQUERY_RSP	1453	OP time query response	OP time query response

Disk Management (C19 Message Number)

Name	Code	Description	Payload
DSIKMANAGER_REQ	1460	OP storage manager request	OP storage manager request
DSIKMANAGER_RSP	1461	OP storage manager response	OP storage manager response

User Management (C20 Message Number)

Name	Code	Description	Payload
FULLAUTHORITYLIST_GET	1470	OP authority list request	OP authority list request
FULLAUTHORITYLIST_GET_RESP	1471	OP authority list response	OP authority list response
USERS_GET	1472	OP users list request	OP users list request
USERS_GET_RESP	1473	OP users list response	OP users list response
GROUPS_GET	1474	OP groups list request	OP groups list request
GROUPS_GET_RESP	1475	OP groups list response	OP groups list response
ADDGROUP_REQ	1476	Add group request	Not yet observed
ADDGROUP_RSP	1477	Add group response	Not yet observed
MODIFYGROUP_REQ	1478	Modify group request	Not yet observed
MODIFYGROUP_RSP	1479	Modify group response	Not yet observed
DELETEGROUP_REQ	1480	Delete group request	Not yet observed
DELETEGROUP_RSP	1481	Delete group response	Not yet observed
ADDUSER_REQ	1482	OP user info request	OP user info request
ADDUSER_RSP	1483	OP user info response	OP user info respnose
MODIFYUSER_REQ	1484	Modify user request	Not yet observed
MODIFYUSER_RSP	1485	Modify user response	Not yet observed
OPDELUSER_REQ	1486	OP delete user request	OP delete user request
OPDELUSER_RESP	1487	OP delete user response	OP delete user response
MODIFYPASSWORD_REQ	1488	Modify password request	Not yet observed
MODIFYPASSWORD_RSP	1489	Modify password response	Not yet observed

Alarm Report (C21 Message Number)

Name	Code	Description	Payload
GUARD_REQ	1500	Guard request	Guard request
GUARD_RSP	1501	Guard response	Guard response
UNGUARD_REQ	1502	Unguard request	Unguard request
UNGUARD_REQ	1503	Unguard response	Not yet observed
ALARM_REQ	1504	Alarm request (the only message proactively reported by the PU to the CU)	Not yet observed
ALARM_RSP	1505	Alarm response	Not yet observed
NET_ALARM_REQ	1506	Network alert request	Not yet observed
NET_ALARM_RSP	1507	Network alert response	Not yet observed
ALARMCENTER_MSG_REQ	1508	Alarm reporting request	Not yet observed

System Upgrade (C22 Message Number)

Name	Code	Description	Payload
UPGRADE_REQ	1520	Upgrade request	Not yet observed
UPGRADE_RSP	1521	Upgrade response	Not yet observed
UPGRADE_DATA	1522	Upgrade data request	Not yet observed
UPGRADE_DATA_RSP	1523	Upgrade data response	Not yet observed
UPGRADE_PROGRESS	1524	Upgrade progress	Not yet observed
UPGRADE_INFO_REQ	1525	System update info request	System update info request
UPGRADE_INFO_RSP	1526	System upgrade info response	System update info response

Automatic Device Discovery (C23 Message Number)

Name	Code	Description	Payload
IPSEARCH_REQ	1530	IP auto search request	Not yet observed
IPSEARCH_RSP	1531	IP auto search response	IP auto search response
IP_SET_REQ	1532	IP set request	Not yet observed
IP_SET_RSP	1533	IP set response	Not yet observed

System Information Import/Export (C24 Message Number)

Name	Code	Description	Payload
CONFIG_IMPORT_REQ	1540	Configure import request	Not yet observed
CONFIG_IMPORT_RSP	1541	Configure import response	Not yet observed
CONFIG_EXPORT_REQ	1542	Configure export request	Configure export request
CONFIG_EXPORT_RSP	1543	Configure export request	Configure export request
LOG_EXPORT_REQ	1544	Log export request	Not yet observed
LOG_EXPORT_RSP	1545	Log export response	Not yet observed

Keyboard Control (C25 Message Number)

Name	Code	Description	Payload
NET_KEYBOARD_REQ	1550	Keyboard control request	Not yet observed
NET_KEYBOARD_RSP	1551	Keyboard control response	Not yet observed

Snapshot Capture (C26 Message Number)

Name	Code	Description	Payload
NET_SNAP_REQ	1560	OP snapshot request	OP snapshot request
NET_SNAP_RSP	1561	OP snapshot response	Saved as jpeg image
SET_IFRAME_REQ	1562	Set iframe request	Not yet observed
SET_IFRAME_RSP	1563	Set iframe response	Not yet observed

Serial Port Controls (C27 message number)

Name	Code	Description	Payload
RS232_READ_REQ	1570	RS232 read request	Not yet observed
RS232_READ_RSP	1571	RS232 read response	Not yet observed
RS232_WRITE_REQ	1572	RS232 write request	Not yet observed
RS232_WRITE_RSP	1573	RS232 write response	Not yet observed
RS485_READ_REQ	1574	RS485 read request	Not yet observed
RS485_READ_RSP	1575	RS485 read response	Not yet observed
RS485_WRITE_REQ	1576	RS485 write request	Not yet observed
RS485_WRITE_RSP	1577	RS485 write response	Not yet observed
TRANSPARENT_COMM_REQ	1578	Transparent serial port communication request	Not yet observed
TRANSPARENT_COMM_RSP	1579	Transparent serial port communication response	Not yet observed
RS485_TRANSPARENT_DATA_REQ	1580	Transparent data request from RS485 serial port	Not yet observed
RS485_TRANSPARENT_DATA_RSP	1581	Transparent data response from RS485 serial port	Not yet observed
RS232_TRANSPARENT_DATA_REQ	1582	Transparent data request from RS232 serial port	Not yet observed
RS232_TRANSPARENT_DATA_RSP	1583	Transparent data response from RS232 serial port	Not yet observed

Time Synchronization

Name	Code	Description	Payload
OPTimeSettingNoRTC_REQ	1590	OP time setting (no RTC)	OP time setting w/o RTC
OPTimeSettingNoRTC_RESP	1591	OP time setting (no RTC)	OP time setting w/o RTC

Screenshot Upload Message

Name	Code	Description	Payload
PHOTO_GET_REQ	1600	Screenshot upload request	Not yet observed
PHOTO_GET_RSP	1601	Screenshot upload response	Not yet observed

Get Random User

Name	Code	Description	Payload
GetRandomUser_REQ	1660	Get random user request	Get random user request
GetRandomUser_RESP	1661	Get random user response	Get random user response

Version List

Name	Code	Description	Payload
OPVERSIONLIST_REQ	2000	OP version list request	OP version list request
OPVERSIONLIST_RESP	2001	OP version list response	OP version list response

FTP Test

Name	Code	Description	Payload
OPFTPTEST_REQ	2008	OP FTP test request	OP FTP test request
OPFTPTEST_RESP	2009	OP FTP test response	OP FTP test response