Versions Compared

Old Version 4

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET channels/command/unMonitor/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Stop monitoring a channel, specified by the required {id} parameter.

Resource URL

http://{host}/api/2.0/channels/command/unMonitor/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/unMonitor/1/.json

Code Block
languagejson
{
    "Task": {
        "id": 786122,
        "device_id": 9011,
        "type": "Toggle Monitoring State",
        "type_id": 15,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1618156036339"
    }
}

 

 

GET channels/command/monitor/{id}/{dev_

GET channels/command/unMonitor/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Start Stop monitoring a channel on a specific device, specified by the required {id} and {dev_id} parametersparameter.

Resource URL

http://{host}/api/2.0/channels/command/monitor/{id}unMonitor/{dev_id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

dev_id

(required)

integer

The ID of the target device to monitor the channel.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/

monitor

  1. unMonitor/1

/9011

  1. /.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id":
336160
786122,
        "device_id": 9011,
        "type": "Toggle Monitoring State",
        "type_id": 15,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1618155948474
1618156036339"
    }
}

 

 

GET channels/command/

enableRecord

monitor/{id}/{dev_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Set a specific channel to be recordable. The recording could be handled manually or by trigger eventStart monitoring a channel on a specific device, specified by the required {id} and {dev_id} parameters.

Resource URL

http://{host}/api/2.0/channels/command/monitor/enableRecord{id}/{dev_id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

dev_id
(required)

integer

The ID of the target device to monitor the channel.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/

enableRecord

  1. monitor/1/9011/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id":
3936
336160,
        "device_id": 9011,
        "type": "Toggle
Recording
Monitoring
Support
State",
        "type_id":
16
15,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1618157255630
1618155948474"
    }
}

 

 

GET channels/command/

disableRecord

enableRecord/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Stops Set a specific channel from being recordable.

Resource URL

to be recordable. The recording could be handled manually or by trigger event.

Resource URL

http://{host}/api/2.0/channels/command/disableRecordenableRecord/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/

disableRecord

  1. enableRecord/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id":
317048
3936,
        "device_id": 9011,
        "type": "Toggle Recording Support",
        "type_id": 16,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1618157430897
1618157255630"
    }
}

 

 

GET channels/command/

forceProfile

disableRecord/{id}

/{profile_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Force a monitored channel to use a specific profile, overriding any default and scheduled profile changes. Also used to release a channel from a forced profileStops a specific channel from being recordable.

Resource URL

http://{host}/api/2.0/channels/command/forceProfiledisableRecord/{id}/{profile_id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

profile_id
(required)

other

Values may be either an Integer profile ID to force that profile or "false" to release the channel.

Example Request

GET 

http://

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/

forceProfile

  1. disableRecord/1/

1/

  1. .json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id":
95288
317048,
        "device_id": 9011,
        "type": "
Force
Toggle Recording
Profile
Support",
        "type_id":
13
16,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1618157487325
1618157430897"
    }
}

 

 

GET channels/command/

startRecord

forceProfile/{

ch_

id}/{

agent

profile_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Start recording the channel. The recording will continue until "stopRecord" action is sent or record timeout limit reachedForce a monitored channel to use a specific profile, overriding any default and scheduled profile changes. Also used to release a channel from a forced profile.

Resource URL

http://{host}/api/2.0/channels/command/startRecordforceProfile/{ch_id}/{agentprofile_id}/.format

Parameters

Parameter

Data Type

Description

ch_

id
(required)

integer

The ID of the desired channel.

agent

profile_id
(required)

integer

The ID of the file agent to be used for this record action

other

Values may be either an Integer profile ID to force that profile or "false" to release the channel.

Example Request

GET 

  1. http://

192

  1. 44.

168

  1. 235.

0

  1. 52.

203

  1. 211/api/2.0/channels/command/

startRecord

  1. forceProfile/1/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Task": {
        "id":
237030
95288,
        "device_id":
3311
9011,
        "type": "
Toggle
Force
Recording
Profile",
        "type_id":
18
13,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "
1619164215132
1618157487325"
    }
}

 

 

GET channels/command/

stopRecord

startRecord/{ch_id}/{agent_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Stops Start recording the recording task on this channelchannel. The recording will continue until "stopRecord" action is sent or record timeout limit reached.

Resource URL

http://{host}/api/2.0/channels/command/stopRecordstartRecord/{ch_taskid}/{agent_id}/.format

Parameters

Parameter

Data Type

Description

ch_

task

id
(required)

integer

The ID of the desired channel.

agent_id
(required)

integer

The

task

ID of the

currently recording channel

file agent to be used for this record action.

Example Request

GET 

  1. http://192.168.0.203/api/2.0/channels/command/

stopRecord

  1. startRecord/

237030

  1. 1/1/.json

GET channels/command/setSnooze/{id}/{remark}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Set Snooze on channel, disabling error notifications till snooze is cleared.

Resource URL

http://{host}/api/2.0/channels/command/setSnooze/{id}/{remark}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

remark
(optional)

string

The string to use as a remark.

Example Request

GET 

http://44.235.52.211
Expand
titleRESPONSE
Code Block
languagejson
{
    "
code
Task":
409,
{
        "
url
id": 237030,
"/api/2.0/channels/command/stopRecord/237030/.json"
    "device_id": 3311,
        "
message
type": "
Conflict
Toggle Recording",
"errors
    "type_id":
"Recording
18,
has
been
stopped" }

 

 

      "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1619164215132"
    }
}

 

 

GET channels/command/stopRecord/{ch_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Stops the recording task on this channel.

Resource URL

http://{host}/api/2.0/channels/command/

setSnooze/1/this is a snooze remark/.json Code Block
languagejson
{ "ChannelStatistics": {

stopRecord/{ch_task_id}/.format

Parameters

Parameter

Data Type

Description

ch_task_id
(required)

integer

The task ID of the currently recording channel.

Example Request

GET 

  1. http://192.168.0.203/api/2.0/channels/command/stopRecord/237030/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    
"
id
code":
1
409,
"monitoring_level": 1, 
"url": "/api/2.0/channels/command/stopRecord/237030/.json",
"access_type_id
"message":
3,
"is_snoozed": 1
"Conflict",
"snooze_remark
"errors": "
this
Recording
is
has
a
been
snooze remark
stopped"
, "title": "channel_1", "uuid": "B938C5D8-89E1-462C-8853-A1C02B372E18", "network_id": 1, "iface": "eth0", "total_bit_rate": 1345436, "null_padding_count": null, "mux_bitrate_by_pcr": 1501420, "mux_bitrate_by_time": 1501420, "cc_errors": 0, "service_type_id": 7,

}

 

 

GET channels/command/setSnooze/{id}/{remark}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Set Snooze on channel, disabling error notifications till snooze is cleared.

Resource URL

http://{host}/api/2.0/channels/command/setSnooze/{id}/{remark}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired channel.

remark
(optional)

string

The string to use as a remark.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/channels/command/setSnooze/1/this is a snooze remark/.json

Expand
titleRESPONSE
Code Block
languagejson
 
 
GET channels/command/clearSnooze/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Clears the Snooze state from a channel.
Resource URL
http://{host}/api/2.0/channels/command/clearSnooze/{id}/.format
Parameters
Parameter
Data Type
Description
is
(required)
integer
The ID of the desired channel.
Example Request
GET 
  1. http://44.235.52.211/api/2.0/channels/command/clearSnooze/1/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "ChannelStatistics": {
        "
device_
id": 
9011
1,
        "
is
monitoring_
record_enabled
level": 1,
        "
is
access_
descrambling
type_
enabled
id": 
0
3,
        "
t2mi
is_
plp
snoozed": 
-1
0,
        "
highest_active_event_severity_id
snooze_remark": 
1
null,
        "
clock
title": 
null
"channel_1",
        "
source_address
uuid": "
23.45.112.17:80
B938C5D8-89E1-462C-8853-A1C02B372E18",
        "
secondary
network_
source_address
id": 
""
1,
        
"source_transport_mode_id": 6
"iface": "eth0",
        "
modified
total_bit_rate": 
"1618161801841"
994886,
        "
main
null_padding_
url
count": 
"http://testURL.m3u8"
null,
        "
bandwidth
mux_bitrate_by_pcr": 
1757064
1121269,
        "
program_id
mux_bitrate_by_time": 
null
1121269,
        "
codec
cc_errors": 
"avc1.4D401F,ac-3"
0,
        "
audio
service_type_id": 
"audio3"
7,
        "
resolution
device_id": 
"960x540"
9011,
        "
stream
is_record_
url
enabled": 
"http://testURL_Stream.m3u8"
1,
        "
segment
is_descrambling_
duration
enabled": 
8.007
0,
        "
is
t2mi_
scrambled
plp": 
0
-1,
        "
ChannelProfile
highest_active_event_severity_id": 
[
1,
        "clock": null,
  
{
      "source_address": "23.45.112.17:80",
        
 
"
id
secondary_source_address": 
1
"",
        "source_transport_mode_id": 6,
        "
title
modified": "
Default
1618161923131",



        
       "notification_set_id
"main_url": 
1
"http://mainURL.m3u8",
        "bandwidth": 1757064,
        "
event_rule
program_
set_
id": 
1
null,
        "codec": "avc1.4D401F,ac-3",
        "
is_default
audio": 
1
"audio3",
        "resolution": "960x540",
        "
is
stream_
scanned
url": 
0
"http://stream_url.m3u8",
        "segment_duration": 8.007,
        "is_
active
scrambled": 
1
0,
        
        "is_forced
"ChannelProfile": 
0,
[
            {
   
"is_scrambled":
 
0
            
 }
"id": 1,
        
],
        
 
"
ChannelPidStatistics
title":
 []
 "Default",
               
}
}
 
 
GET channels/command/clearSnooze/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Clears the Snooze state from a channel.
Resource URL
http://{host}/api/2.0/channels/command/clearSnooze/{id}/.format
Parameters
Parameter
Data Type
Description
is
(required)
integer
The ID of the desired channel.
Example Request
GET 
  1. http://44.235.52.211/api/2.0/channels/command/clearSnooze/1/.json
 Code Block
languagejson
{
    "ChannelStatistics": {
 "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "
id
is_scanned": 
1
0,
        
"monitoring_level": 1,

        "
access
is_
type_id
active": 
3
1,
        
"is_snoozed": 0,
        
   
"
snooze
is_
remark
forced": 
null
0,



      
 "title":
 
"channel_1",
         "
uuid
is_scrambled": 
"B938C5D8-89E1-462C-8853-A1C02B372E18",
0
          
"network_id":
 
1,
 }
       
"iface": "eth0"
 ],
        "
total_bit_rate
ChannelPidStatistics": 
994886,
[]
    
    "null_padding_count": null,
        "mux_bitrate_by_pcr": 1121269,
        "mux_bitrate_by_time": 1121269,
        "cc_errors": 0,
        "service_type_id": 7,
        "device_id": 9011,
        "is_record_enabled": 1,
        "is_descrambling_enabled": 0,
        "t2mi_plp": -1,
        "highest_active_event_severity_id": 1,
        "clock": null,
        "source_address": "23.45.112.17:80",
        "secondary_source_address": "",
        "source_transport_mode_id": 6,
        "modified": "1618161923131",
        "main_url": "http://mainURL.m3u8",
        "bandwidth": 1757064,
        "program_id": null,
        "codec": "avc1.4D401F,ac-3",
        "audio": "audio3",
        "resolution": "960x540",
        "stream_url": "http://stream_url.m3u8",
        "segment_duration": 8.007,
        "is_scrambled": 0,
        "ChannelProfile": [
            {
                "id": 1,
                "title": "Default",
}
}
 
GET channels/command/acknowledge/{{channel_id}}/{{event_id}}/.json
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
GET
Acknowledges the channel events occured.
Resource URL
http://{host}/api/2.0/channels/command/acknowledge/{{channel_id}}/{{event_id}}/.format
** To get the channel ID and Event ID, use GET API command http://{host}/api/2.0/channels/events/.json 
Parameters
Parameter
Data Type
Description
is
(required)
integer
The ID of the desired channel.
Example Request
GET 
  1. http://44.235.52.211/api/2.0/channels/command/acknowledge/2/2267/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "Task": {
        
        
"
notification_set_
id": 
1
116407,



        
       "event_rule_set
"device_id": 
1
9898,

                "is_default":
 
1,
       "type": "Event Acknowledge",
        "
is
type_
scanned
id": 
0
22,
        "mode": "Starting",
        "
is
mode_
active
id": 1,
        "status": null,
        "
is_forced
description": 
0
null,
        
        "is_scrambled
"total": 0,
        "completed": 0,
  
}
      
   ]
"time_remained": 0,
        "
ChannelPidStatistics
modified": 
[]
"1695289925313"
    }
}