Channel Commands

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

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

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

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

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

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

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

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

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

http://192.168.0.203/api/2.0/channels/command/stopRecord/237030/.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/api/2.0/channels/command/setSnooze/1/this is a snooze remark/.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

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