Video Triggers
Triggers the specified enVision device to perform a video operation by routing the request through enVision Cloud. The enVision device must be registered to enVision Cloud and compatible with remote triggering video capability and be in a video operating mode in order for this method to be supported.
This document describes the specifications of the API endpoint
Start Video
Request the device to begin color video recording. This can be accessed with the following endpoint
/api/remotetrigger/startrecording
curl "https://api.ece.phdsolutions.ca/api/remotetrigger/startrecording?deviceReference=ABCD2345&transactionReference=ORD1234" \
-X GET \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
HTTP/1.1 200 OK
Content-Length: 0
Date: Fri, 16 May 2025 18:34:52 GMT
Server: Kestrel
api-supported-versions: 1.0
Request Parameters
The start video request has multiple optional query strings to help pass custom values and reference transactions.
Video Only mode as they will be overwritten otherwise during a measurement.Required Request Paramaters
| Property | Required | Data Type | Description |
|---|---|---|---|
deviceReference | Yes | string | the 8-digit Device Registration Code of the target device. Example: ABCD2345 |
transactionReference | Yes | string | a host-supplied transaction reference for tracking purposes. This can be any value you wish to supply as something that will be tracked with the video operation in enVision Cloud and returned in the response. Possible values are an Order ID, Tracking Number or Barcoded identifier. |
Optional Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
cRef1 | No | string | a custom host-supplied reference. This value will be tagged to the transaction stored in enVision Cloud. |
cRef2 | No | string | a custom host-supplied reference. This value will be tagged to the transaction stored in enVision Cloud. |
cRef3 | No | string | a custom host-supplied reference. This value will be tagged to the transaction stored in enVision Cloud. |
Stop Video
Requests the video to stop and encode. This endpoint will only work in Video Only mode. To trigger a stop in Video with Measurement mode trigger a measurement (Cloud Trigger). When the video is stopped it will be saved as a transaction to enVision Cloud using the queries called using the Start Video command. The stop endpoint can be accessed at the following location.
/api/remotetrigger/stoprecording
curl "https://api.ece.phdsolutions.ca/api/remotetrigger/stoprecording?deviceReference=ABCD2345" \
-X GET \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
HTTP/1.1 200 OK
Content-Length: 0
Date: Fri, 16 May 2025 18:34:52 GMT
Server: Kestrel
api-supported-versions: 1.0
Request Parameters
| Property | Required | Data Type | Description |
|---|---|---|---|
deviceReference | Yes | string | the 8-digit Device Registration Code of the target device. Example: ABCD2345 |
Cancel Video
Requests the video to stop and clear all saved video data in memory and local storage on the specified device. This can be accessed at the following endpoint
/api/remotetrigger/cancelrecording
curl "https://api.ece.phdsolutions.ca/api/remotetrigger/cancelrecording?deviceReference=ABCD2345" \
-X GET \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
HTTP/1.1 200 OK
Content-Length: 0
Date: Fri, 16 May 2025 18:34:52 GMT
Server: Kestrel
api-supported-versions: 1.0
Request Parameters
| Property | Required | Data Type | Description |
|---|---|---|---|
deviceReference | Yes | string | the 8-digit Device Registration Code of the target device. Example: ABCD2345 |
HTTP Response Status Codes
All requests have the following response status codes
| Status Code | Description |
|---|---|
| 200 - OK | The request was successfully routed to the target device and a response was provided in the body of the HTTP response. |
| 400 - Bad Request | The device reference Id provided was not valid. |
| 401 - Unauthorized | The bearer token provided was not valid. |
| 504 - Timeout | The remote device did not respond in a timely manner. |