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

http://192.168.0.101/api/2.0/channels/command/unmonitor/1/.json

Code Block

{"Task": {
   "id": 595649,
   "device_id": 830,
   "type": "Toggle Monitoring State",
   "type_id": 15,
   "mode": "Starting",
   "mode_id": 1,
   "status": null,
   "description": null,
   "total": 0,
   "completed": 0,
   "time_remained": 0,
   "modified": "1384692937639"
}}

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

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

http://{host}

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

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

monitor

unMonitor/

{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

http://192.168.0.101/api/2.0/channels/command/monitor/1/621/.json

Code Block{

1/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

896170

786122,
        "device_id":

621

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": "

1384693062873

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

http://

192

44.

168

235.

0

52.

101

211/api/2.0/channels/command/

enableRecord

monitor/1/9011/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

615562

336160,
        "device_id":

621

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": "

1384693453126

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

http://

192

44.

168

235.

0

52.

101

211/api/2.0/channels/command/

disableRecord

enableRecord/1/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

728757

3936,
        "device_id":

830

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": "

1384693554471

1618157255630"
    }
}

GET channels/command/

forceProfile/{id}

disableRecord/{

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 profile.specific channel 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

GET

http://

192

44.

168

235.

0

52.

101

211/api/2.0/channels/command/

forceProfile/1

disableRecord/1/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

357097

317048,
        "device_id":

621

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": "

1384693754780

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

http://

192

44.

168

235.

0

52.

101

211/api/2.0/channels/command/

startRecord

forceProfile/

82

1/1/.json

{

Code Block

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

334798

95288,
        "device_id":

630

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": "

1384694509515

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_id}/{agent_id}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the

currently recording channel

desired channel.
agent_id (required)	integer	The ID of the file agent to be used for this record action.

Example Request

GET

http://192.168.0.

101

203/api/2.0/channels/command/startRecord/

stopRecord

1/

82

1/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {
        "id":

334798

237030,
        "device_id":

630

3311,
        "type": "Toggle Recording",
        "type_id": 18,
        "mode": "

Canceling

Starting",
        "mode_id":

3

1,
        "status":

"",

null,
        "description":

""

null,
        "total":

100

0,
        "completed":

15

0,
        "time_remained":

105

0,
        "modified": "

1384694525052

1619164215132"
    }
}

GET channels/command/

setSnooze

stopRecord/{ch_id}

/{remark}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Set Snooze on channel, disabling error notifications till snooze is clearedStops the recording task on this channel.

Resource URL

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

Parameters

Parameter	Data Type	Description
ch_task_id (required)	integer	The task ID of the

desired channel.

remark
(optional)

string

The string to use as a remark

currently recording channel.

Example Request

GET

http://192.168.0.

101

203/api/2.0/channels/command/

setSnooze

stopRecord/

1/this is a snooze remark/

237030/.json

Expand

title	RESPONSE

Code Block

language	json

"ChannelStatistics":

{

id

code":

1

409,
    "

is_snoozed

url":

1, "snooze_remark": "this is a snooze remark", "title": "Ch 1", "uuid": null,

"/api/2.0/channels/command/stopRecord/237030/.json",
    "message": "Conflict",
    "

ip_address

errors": "

225.0.5.1", "ssm_ip_address": null, "port": 2000, "network_id": 3, "iface": "eth0", "program_number": 1, "ts_id": 2, "total_bit_rate": 0, "null_padding_count": null, "mux_bitrate_by_pcr": null, "mux_bitrate_by_time": null, "cc_errors": 0, "source_address": "", "service_type_id": 1, "device_id": 621, "is_record_enabled": 1, "highest_active_event_severity_id": 2, "clock": null, "ChannelProfile": [ { "id": 1,

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

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

Expand

title	RESPONSE

Code Block

language	json

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

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

Expand

title	RESPONSE

Code Block

language	json

{
    "ChannelStatistics": {
        "

title

id":

"default"

1,
        "

notification

monitoring_

set_id

level": 1,
        "

event

access_

rule

type_

set_

id":

1

3,
        "is_

default

snoozed":

1

0,
        "

is

snooze_

scanned

remark":

0

null,
        "

is_active

title": "channel_1",
        "

is_forced

uuid":

0

"B938C5D8-89E1-462C-8853-A1C02B372E18",
        "

is

network_

scrambled

id":

0

1,

}],

ChannelPidStatistics

iface":

[]

"eth0",

"modified": "1384695051231" }}

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

http://192.168.0.101/api/2.0/channels/command/clearSnooze/1/.json

Code Block

{"ChannelStatistics": { "id": 1, "is_snoozed": 0, "snooze_remark": null, "title": "Ch 1", "uuid": null, "ip_address": "225.0.5.1", "ssm_ip_address": null, "port": 2000, "network_id": 3, "iface": "eth1", "program_number": 1, "ts_id": 2, "total_bit_rate": 1860718, "null_padding_count": 617619, "mux_bitrate_by_pcr": 13270594, "mux_bitrate_by_time": 13075190, "cc_errors": 0, "source_address": "192.168.0.98:17035", "service_type_id": 1, "device_id": 621, "is_record_enabled": 1, "highest_active_event_severity_id": 1, "clock": "Jitter 28.24ms, Interval 35ms", "ChannelProfile": [ { "id": 1

    "total_bit_rate": 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,
        "

title

codec": "

default

avc1.4D401F,ac&#45;3",
        "

notification_set_id

audio":

1

"audio3",
        "

event_rule_set_id

resolution":

1

"960x540",
        "

is

stream_

default

url":

1

"http://stream_url.m3u8",
        "

is

segment_

scanned

duration":

0

8.007,
        "is_

active

scrambled":

1

0,
        "

is_forced

ChannelProfile":

0,

"is_scrambled":

0

}],

"ChannelPidStatistics":

[

          "id": 1,

{

content_type

title": "

PAT

Default",

"pid":

0,

cc

notification_set_

errors

id":

0

1,

"bitrate":

24402,

is_scrambled

event_rule_set_id":

0,

1,
                "

parent

is_

pid

default":

null

1,

"ChannelPidStatisticsDescriptors":

[

    "is_scanned": 0,

{

id

is_active":

401

1,

"type": "Content",

value

is_forced":

"PAT" }] },

0,

{

content

is_

type

scrambled":

"NIT",

"pid":

16,

"cc_errors": 0

],

bitrate

ChannelPidStatistics":

3050,

[]

"is_scrambled": 0, "parent_pid": null, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "NIT" }, { "id": 508, "type": "Network Name", "value": "Harashut Hashnia" } ] }, { "content_type": "SDT", "pid": 17, "cc_errors": 0, "bitrate": 4575, "is_scrambled": 0, "parent_pid": null, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "SDT" }, { "id": 328, "type": "Service Provider", "value": "Idan +" }, { "id": 329, "type": "Service Name", "value": "Ch 1" } ] }, { "content_type": "EIT", "pid": 18, "cc_errors": 0, "bitrate": 175395, "is_scrambled": 0, "parent_pid": null, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "EIT" }, { "id": 77, "type": "Short event", "value": "17/11/2013 13:59:00 (00:03:00) שגית המושג" }, { "id": 77, "type": "Short event", "value": "17/11/2013 13:35:00 (00:24:00) האחים דה גמ" }, { "id": 77, "type": "Short event", "value": "17/11/2013 13:30:00 (00:05:00) מלמולים עו" } ] }, { "content_type": "TDT", "pid": 20, "cc_errors": 0, "bitrate": 3050, "is_scrambled": 0, "parent_pid": null, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "TDT" }] }, { "content_type": "Subtitles", "pid": 1025, "cc_errors": 0, "bitrate": 3050, "is_scrambled": 0, "parent_pid": 2560, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "Subtitles" }, { "id": 10, "type": "Language", "value": "heb" } ], "is_pcr": 0, "language": "heb" }, { "content_type": "PMT", "pid": 2560, "cc_errors": 0, "bitrate": 22877, "is_scrambled": 0, "parent_pid": null, "ChannelPidStatisticsDescriptors": [ { "id": 401, "type": "Content", "value": "PMT" }, { "id": 509, "type": "PCR", "value": "Jitter 28.24ms, Interval 35ms" } ] }, { "content_type": "Video", "pid": 2561, "cc_errors": 0, "bitrate": 1779885, "is_scrambled": 0, "parent_pid": 2560, "ChannelPidStatisticsDescriptors": [ { "id": 400, "type": "Encoding", "value": "H.264" }, { "id": 401, "type": "Content", "value": "Video" }, { "id": 505, "type": "Frame Rate", "value": "25.000" }, { "id": 500, "type": "Resolution", "value": "720x576i" }, { "id": 503, "type": "Aspect Ratio", "value": "4:3 SAR 1.09 DAR 1.36" }, { "id": 501, "type": "Color Space", "value": "YUV420" }, { "id": 504, "type": "Profile@Level", "value": "MP@3.0" } ], "payload_type": "H.264", "is_pcr": 1 }, { "content_type": "Audio", "pid": 2562, "cc_errors": 0, "bitrate": 54906, "is_scrambled": 0, "parent_pid": 2560, "ChannelPidStatisticsDescriptors": [ { "id": 400, "type": "Encoding", "value": "LATM/HE-AAC" },

}
}

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

http://44.235.52.211/api/2.0/channels/command/acknowledge/2/2267/.json

Expand

title	RESPONSE

Code Block

language	json

{
    "Task": {

"id":

401,

116407,
        "

type

device_id":

"Content"

9898,

"value": "Audio" }, {

"type": "Event Acknowledge",
        "type_id":

510

22,

"type

"mode": "

Channels

Starting",
        "mode_id": 1,
        "

value

status":

"2"

null,

"description": null,

}

],

"total": 0,
        "

payload_type

completed":

"LATM/HE-AAC",

0,
        "

is

time_

pcr

remained": 0

}

],

"modified": "

1384695423234

1695289925313"
    }
}

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

GET channels/command/unMonitor/{id}

Resource Information

Resource URL

Parameters

Example Request

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

Resource Information

Resource URL

GET channels/command/unMonitor/{id}

Resource Information

Resource URL

Parameters

Example Request

Parameters

Example Request

GET channels/command/

monitor/{id}/{dev_id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/

enableRecord/{id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/

disableRecord/{

id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/

forceProfile/{

id}/{

profile_id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/

startRecord/{ch_id}/{agent_id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/

stopRecord/{ch_id}

Resource Information

Resource URL

Parameters

Example Request

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

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/clearSnooze/{id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/clearSnooze/{id}

Resource Information

Resource URL

Parameters

Example Request

GET channels/command/acknowledge/{{channel_id}}/{{event_id}}/.json

Resource Information

Resource URL

Parameters

Example Request