Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

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

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}/api/2.0/channels/command/monitor/{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/9011/.json

{
    "Task": {
        "id": 336160,
        "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"
    }
}

 

 

GET channels/command/enableRecord/{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 event.

Resource URL

http://{host}/api/2.0/channels/command/enableRecord/{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/enableRecord/1/.json

{
    "Task": {
        "id": 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": "1618157255630"
    }
}

 

 

GET channels/command/disableRecord/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Stops a specific channel from being recordable.

Resource URL

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

{
    "Task": {
        "id": 317048,
        "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"
    }
}

 

 

GET channels/command/forceProfile/{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 profile.

Resource URL

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

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

{
    "Task": {
        "id": 95288,
        "device_id": 9011,
        "type": "Force Profile",
        "type_id": 13,
        "mode": "Starting",
        "mode_id": 1,
        "status": null,
        "description": null,
        "total": 0,
        "completed": 0,
        "time_remained": 0,
        "modified": "1618157487325"
    }
}

 

 

GET channels/command/startRecord/{ch_id}/{agent_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 reached.

Resource URL

http://{host}/api/2.0/channels/command/startRecord/{ch_id}/{agent_id}/.format

Parameters

Parameter

Data Type

Description

ch_id
(required)

integer

The ID of the desired channel.

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

{
    "Task": {
        "id": 237030,
        "device_id": 3311,
        "type": "Toggle Recording",
        "type_id": 18,
        "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/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

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

{
    "ChannelStatistics": {
        "id": 1,
        "monitoring_level": 1,
        "access_type_id": 3,
        "is_snoozed": 1,
        "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": "",
        "source_transport_mode_id": 6,
        "modified": "1618161801841",
        "main_url": "http://testURL.m3u8",
        "bandwidth": 1757064,
        "program_id": null,
        "codec": "avc1.4D401F,ac-3",
        "audio": "audio3",
        "resolution": "960x540",
        "stream_url": "http://testURL_Stream.m3u8",
        "segment_duration": 8.007,
        "is_scrambled": 0,
        "ChannelProfile": [
            {
                "id": 1,
                "title": "Default",
                "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "is_scanned": 0,
                "is_active": 1,
                "is_forced": 0,
                "is_scrambled": 0
            }
        ],
        "ChannelPidStatistics": []
    }
}

 

 

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

{
    "ChannelStatistics": {
        "id": 1,
        "monitoring_level": 1,
        "access_type_id": 3,
        "is_snoozed": 0,
        "snooze_remark": null,
        "title": "channel_1",
        "uuid": "B938C5D8-89E1-462C-8853-A1C02B372E18",
        "network_id": 1,
        "iface": "eth0",
        "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,
        "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",
                "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "is_scanned": 0,
                "is_active": 1,
                "is_forced": 0,
                "is_scrambled": 0
            }
        ],
        "ChannelPidStatistics": []
    }
}

  • No labels