Versions Compared

Old Version 3

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
{
    "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_id}

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/monitorunMonitor/{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/

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 Start monitoring a specific channel to be recordable. The recording could be handled manually or by trigger eventchannel on a specific device, specified by the required {id} and {dev_id} parameters.

Resource URL

http://{host}/api/2.0/channels/command/enableRecordmonitor/{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 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 Stops a monitored channel to use a specific profile, overriding any default and scheduled profile changes. Also used to release a channel from a forced profilechannel from being recordable.

Resource URL

http://{host}/api/2.0/channels/command/forceProfile/{id}disableRecord/{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

Example Request

GET 

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

forceProfile/1

  1. disableRecord/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

Code Block
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

http://

Parameter

Data Type

Description

ch_

task_

id
(required)

integer

The

task

ID of the

currently recording

desired channel.

Example Request

GET 

agent_id
(required)

integer

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

Example Request

GET 

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

stopRecord

  1. 1/

237030

  1. 1/.json

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

 

 

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

Code Block
languagejson
{ "ChannelStatistics": {
",
        "type_id": 18,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "
id
completed":
1
0,
        "
monitoring
time_
level
remained":
1
0,
        "
access_type_id
modified":
3, "is_snoozed": 1,
"1619164215132"
"snooze_remark": "this is a snooze remark", "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, "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": "",
}
}

 

 

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/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
{
    "code": 409,
    "url": "/api/2.0/channels/command/stopRecord/237030/.json",
    "message": "Conflict",
    "errors": "Recording has been stopped"
}

 

 

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": {
        "
source_transport_mode_
id": 
6
1,
        "
modified
monitoring_level": 
"1618161801841"
1,
        "
main
access_type_
url
id": 
"http://testURL.m3u8"
3,
        "
bandwidth
is_snoozed": 
1757064
0,
        "
program
snooze_
id
remark": null,
        "
codec
title": "
avc1.4D401F,ac-3
channel_1",
        "
audio
uuid": "
audio3
B938C5D8-89E1-462C-8853-A1C02B372E18",
        "
resolution
network_id": 
"960x540"
1,
        "
stream_url
iface": "
http://testURL_Stream.m3u8"
eth0",
        "
segment
total_bit_
duration
rate": 
8.007
994886,
        "
is
null_padding_
scrambled
count": 
0
null,
        "
ChannelProfile
mux_bitrate_by_pcr": 
[
1121269,
        "mux_bitrate_by_time": 1121269,
  
{
      "cc_errors": 0,
        
 
"service_type_id": 
1,
       
7,
        "
title
device_id": 
"Default"
9011,
        "is_record_enabled": 1,
        "
notification
is_
set
descrambling_
id
enabled": 
1
0,
        "t2mi_plp": -1,
        "highest_active_event_
rule_set
severity_id": 1,
        "clock": null,
        "
is
source_
default
address": 
1
"23.45.112.17:80",
        
        "is_scanned
"secondary_source_address": 
0
"",
        
        "is_active
"source_transport_mode_id": 
1
6,
        "modified": "1618161923131",
        "
is
main_
forced
url": 
0
"http://mainURL.m3u8",
        "bandwidth": 1757064,
        "
is
program_
scrambled
id": 
0
null,
        "codec": "avc1.4D401F,ac-3",
  
}
      
   ]
"audio": "audio3",
        "
ChannelPidStatistics
resolution":
 []
 "960x540",
        
}
}
 
 
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
{
    "ChannelStatistics": {
        "id": 1
"stream_url": "http://stream_url.m3u8",
        "segment_duration": 8.007,
        "
monitoring
is_
level
scrambled": 
1
0,
        "
access_type_id
ChannelProfile": 
3,
[
         
"is_snoozed":
 
0,
  {
      
"snooze_remark":
 
null,
         "
title
id": 
"channel_
1
"
,
        
"uuid
        "title": "
B938C5D8-89E1-462C-8853-A1C02B372E18
Default",

 

      
"network_id":
 
1,
         "
iface
notification_set_id": 
"eth0"
1,
       
 "total_bit_rate": 994886,
         "
null
event_rule_
padding
set_
count
id": 
null
1,
        
"mux_bitrate_by_pcr":
 
1121269,
 
       "
mux_bitrate_by_time
is_default": 
1121269
1,
        
"cc_errors":
 
0,
       
  
"
service
is_
type_id
scanned": 
7
0,



      
 "device_id":
 
9011,
         "is_
record_enabled
active": 1,
                "is_
descrambling_enabled
forced": 0,



      
 "t2mi_plp":
 
-1,
         "
highest_active_event_severity_id
is_scrambled": 0

1,
          
"clock":
 
null,
 }
       
"source_address": "23.45.112.17:80"
 ],
        "
secondary_source_address
ChannelPidStatistics": 
"",
[]
    
    "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"
    }
}