Alarms

Alarms

Device alarms trigger when sensor values exceed the threshold values configured on the device or when defined conditions are met. This page provides the API calls to enable these alarms.

Request Components

HTTP Request

POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set'

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token, and must set the content-type to JSON.

Parameter Name Data Type Description
Authorization string HTTP Authorization bearer token
VZ-M2M-Token string A valid session token returned by
POST /api/m2m/v1/session/login
Content-Type string Must be application/json

Back to Top

Request Body

The request body must include the following for each request made. This information verifies the device as well as the account sending the message to configure an alarm:

Parameter Name Data Type Description
accountidentifier JSON object The ID of the authenticating billing account, in the format:
 {"billingaccountid":"0123456789-12345"}
resourceidentifier JSON object The ID of the device to set alarms, in the format:
 {"imei":"168232803251548"}
deviceConfig JSON object Some alarms have thresholds, some alarms have states. Please see the individual alarms below for configuration

Back to Top

Sensor Alarm Key Words

Each sensor will have a special alarm key word. The following is a list of key words for each sensor type:

Sensor Type Alarm Key Word Type Min/Max threshold values
Temperature tempAlarm 4 -20 / 65 in Degrees Centigrade (°C)
Light liteAlarm 4 0 / 64,000 in Lumens
Humidity humiAlarm 4 0 / 95 as a percentage (%) of Relative Humidity
Pressure presAlarm 4

300 / 1100 in Hectopascals (hPA) (100x 1 Pascal). Unit is identical to millibar (mBar).

Note: 1 Atmosphere (ATM) is 14.7 psi or 1013 hPA

Battery battAlarm 4 0 / 100 as a percentage (%) of the battery’s State of Charge (SoC)
Motion acclAlarm 5 0 / 16 in "G"s (multiples of 9.81 M/S2) measured for Acceleration (accel_thresh, stopped_thresh) and Time (stopped_period, holdoff) in Seconds
Note: acceleration can be measured with any axis, combination of axes or all three axes simultaneously
No Motion acclAlarm 13 0 / 16 in "G"s (multiples of 9.81 M/S2) measured for Acceleration (stopped_thresh) and. Time (stopped_period, holdoff) in Seconds
Shock acclAlarm 12 0 / 16 in "G"s (multiples of 9.81 M/S2) for amount of force (shock_thresh) and duration of force (shock_duration) in Seconds
Vibration acclAlarm 8 0 / 16 in "G"s (multiples of 9.81 M/S2) for amount of force (tap_thresh) and duration of force (tap_duration) in Seconds
Tilt Below gyroAlarm 6 3° / 180°; Axis (X, Y, Z) being measured is either Enabled (1) or Disabled (0) with tilt_duration in Seconds
Note: tilt is only measured along one axis at a time (if “X” is being measured, “Y” and “Z” must be disabled)
Tilt Exceeded gyroAlarm 5 3° / 180°; Axis (X, Y, Z) being measured is either Enabled (1) or Disabled (0) with tilt_duration in Seconds
Orientation Exceeded gyroAlarm 2 3° / 180°; Axis (X, Y, Z) being measured is either Enabled (1) or Disabled (0) with tilt_duration in Seconds
Note: orientation is measured with the “X” and “Y” axes only (“Z” must be disabled, both “X” and “Y” must be enabled)
Orientation Below gyroAlarm 3 3° / 180°; Axis (X, Y, Z) being measured is either Enabled (1) or Disabled (0) with tilt_duration in Seconds

Back to Top

Variables and Their Meanings

Some of the variables used have specific meanings and limits that aren’t obvious:

Variable Meaning
threshold The lower limit of the threshold for the alarm
thresholdRange The upper limit of the threshold for the alarm
holdoff

Once the alarm is triggered, the alarm must wait the holdoff period before triggering again (even if the alarm condition clears)

Note: This value is limited to be between 30 seconds and 1 year (31,536,000 Seconds)

setOnlyOnce

 0: The alarm may re-trigger at any time after the holdoff period elapses

 1: The alarm must be reset or reconfigured before being allowed to trigger again

locationRequired

 0: Device responds as immediately as possible for a location fix before sending the alarm to Thingspace

 1: Device waits for the next available opportunity (not exceeding the max radio on-time, set by the user) for a location fix before to sending the alarm to Thingspace

Note: This variable only applies to Acceleration and Gyro alarms

tilt_angle This is the threshold for recognizing device tilt and must be set between 3° and 180°
Note: This variable only applies to Gyro alarms
accel_thresh This is the threshold for recognizing the device is in motion. Acceleration in “G”s (multiples of 9.8M/S2 ). Default value is 0.2G, range is 0 to 16G
stopped_thresh This is the change in acceleration (G) of the device, determining if the device has come to a stop. Default value is 0.08G, range is 0 to 16G
stopped_period This is the amount of time (in Seconds) that the device remains in one place to be considered “Stopped”. Default is 300, range is 5 to 259,200 (72 hours)
shock_thresh The threshold of force registered as acceleration in “G”s along any selected axis (or all three). Default is 1.5G, range is 0 to 16G
shock_duration Time in Seconds that the device has seen a force applied greater than the threshold. Default is 0.1, range is 0.003 to 0.640 Seconds
tap_thresh The threshold of force applied as two or more “Taps” registered as acceleration in “G”s along any selected axis (or all three). Default is 0.5G, range is 0 to 16G
tap_duration Time in Seconds that the device has seen two (or more) “Taps” with a force greater than the threshold. Default is 0.1, range is 0.003 to 0.700 Seconds
clear_duration Time in Seconds that the alarm condition has remained clear or tilt has transitioned to clear the alarm along the axis being monitored (gyro alarms only). No default, range is between 1 and 259,200 Seconds (72 hours)

Note: While location isn't a variable (it's a reported parameter), it's helpful to understand that this is the current or cached Longitude and Latitude of where the device is located expressed in Decimal Degrees. Location information will indicate a Type which will be a Cell tower ID (cid), the device’s GPS (gps) or a combination of both (gps&cid). Accuracy may or may not be provided and is not guaranteed

Back to Top

The Axes of a Device

An Axis is a is a straight line that can be drawn through an object to describe an object’s rotation or plane of motion

Objects exist in three dimensions which can be defined by three axes: X, Y and Z. Looking at the device, the three axes would be:

 

These axes are also called "Roll", "Pitch" and "Yaw":

 

Note: The “Y” axis will rotate clockwise facing the device and the “X” axis rotates counter-clockwise facing the device.

Back to Top

Examples:

Example of Temperature Sensor Alarm Configuration Request

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \    
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "0654321123-00001"},
    "resourceidentifier": {"imei":914508030149993 },
    "deviceConfig": {"tempAlarm":{"alarmType":4,"threshold":15,"thresholdRange":20}}
}`

Temperature Alarm API response

      {
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:48:24.342477141Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "tempAlarm": {
                    "alarmType": 4,
                    "threshold": 15,
                    "thresholdRange": 20
                }
            }
        },
        "id": "6581ecb2-ac82-6415-f042-565a9140697c",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:48:24.342477209Z",
        "state": "pending",
        "transactionid": "cc486a9a-d385-4603-875b-3a40d9901d60",
        "version": "1.0",
        "versionid": "dc1a35fa-2456-11eb-95df-ee1179cba4be"
    }

Example of Light Sensor Alarm Configuration Request

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {"liteAlarm":{"alarmType":4,"threshold":1000,"thresholdRange":4000,"holdoff":30}}
}`

Light Alarm API Response

      {
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:51:45.222305686Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "liteAlarm": {
                    "alarmType": 4,
                    "holdoff": 30,
                    "threshold": 1000,
                    "thresholdRange": 4000
                }
            }
        },
        "id": "65b1663f-31cb-6e64-ed16-3a33ef9afd50",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:51:45.222305792Z",
        "state": "pending",
        "transactionid": "10e1f1d2-79f3-413c-b09e-10bc9a7b0b9a",
        "version": "1.0",
        "versionid": "53d60a4c-2457-11eb-a92f-f26ddc710396"
    }

Example of Humidity Sensor Alarm Configuration Request

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {"HumiAlarm":{"alarmType":4,"threshold":60,"thresholdRange":90}}
}`

Humidity Alarm API Response

         {
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:52:54.896511321Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "HumiAlarm": {
                    "alarmType": 4,
                    "threshold": 60,
                    "thresholdRange": 90
                }
            }
        },
        "id": "2521d25c-95ee-6551-f36c-1526357a572c",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:52:54.89651139Z",
        "state": "pending",
        "transactionid": "10b097c0-fa13-4ae7-a840-844d6003d2b8",
        "version": "1.0",
        "versionid": "7d5d7af4-2457-11eb-a5b1-1a07f8c57c79"
    }

Example of Pressure Sensor Alarm Configuration Request

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {"presAlarm":{"alarmType":4,"threshold":1050,"thresholdRange":1100}}
}`

Pressure Alarm API Response

        {
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:54:02.785280707Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "presAlarm": {
                    "alarmType": 4,
                    "threshold": 1050,
                    "thresholdRange": 1100
                }
            }
        },
        "id": "a5c198af-3677-6b9c-e71f-c4294a29e121",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:54:02.785280783Z",
        "state": "pending",
        "transactionid": "ef62dbb1-fb46-4f93-afef-907c0cc38f08",
        "version": "1.0",
        "versionid": "a5d47bfe-2457-11eb-9016-4ab68f14c30b"
    }

Example of Battery Sensor Alarm Configuration Request

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {"battAlarm":{"alarmType":4,"threshold":15,"thresholdRange":80}}
}`

Battery Alarm API Response

   {
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:55:06.055313349Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "battAlarm": {
                    "alarmType": 4,
                    "threshold": 15,
                    "thresholdRange": 80
                }
            }
        },
        "id": "a5f16580-7999-6977-faf5-70cc8ea17d36",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:55:06.055313536Z",
        "state": "pending",
        "transactionid": "2e6a72e0-fd1d-418f-a419-5427efe7871b",
        "version": "1.0",
        "versionid": "cb8ab9a4-2457-11eb-a951-f26ddc710396"
    }

Example of Motion Alarm Configuration Request

Note: Only a single type of acceleration alarm may be enabled on a device at a given time (only one of the following: motion, no-motion, shock, or vibration). Enabling one type of acceleration alarm will overwrite a previously configured acceleration alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":5, 
            "enabled":1,
            "setOnlyOnce":0,
            "locationRequired":1,
            "accel_thresh":0.1,
            "stopped_thresh":0.08,
            "stopped_period":30.0,
            "holdoff":60
        }
    }
}`

Motion Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:56:03.816220586Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "acclAlarm": {
                   "accel_thresh": 0.1,
                    "alarmType": 5,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "stopped_period": 30,
                    "stopped_thresh": 0.08
                }
            }
        },
        "id": "25c14158-9338-6030-f62a-4ef652fd5fcd",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:56:03.816220656Z",
        "state": "pending",
        "transactionid": "8d5ce207-5e17-4a6c-af7a-be919848c458",
        "version": "1.0",
        "versionid": "edf85717-2457-11eb-a5e2-1a07f8c57c79"
    }

Example of No Motion Alarm Configuration Request

Note: Only a single type of acceleration alarm may be enabled on a device at a given time (only one of the following: motion, no-motion, shock, or vibration). Enabling one type of acceleration alarm will overwrite a previously configured acceleration alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":13, 
            "enabled":1,
            "holdoff":60,
            "locationRequired":1,
            "setOnlyOnce":0,
            "stopped_period":10.0,
            "stopped_thresh":0.20
        }
    }  
}`

No Motion Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:57:17.013610222Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "acclAlarm": {
                    "alarmType": 13,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "stopped_period": 10,
                    "stopped_thresh": 0.2
                }
            }
        },
        "id": "853150c9-6de2-6780-f852-c4de15353cfd",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:57:17.013610289Z",
        "state": "pending",
        "transactionid": "982758b6-b67c-4be9-ad39-2ee27f811bba",
        "version": "1.0",
        "versionid": "19996020-2458-11eb-a953-f26ddc710396"
    }

Example of Shock Alarm Configuration Request

Note: Only a single type of acceleration alarm may be enabled on a device at a given time (only one of the following: motion, no-motion, shock, or vibration). Enabling one type of acceleration alarm will overwrite a previously configured acceleration alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":12, 
            "enabled":1,
            "setOnlyOnce":0,
            "locationRequired":0,
            "shock_thresh":1.2,
            "shock_duration":0.01,
            "x_axis":1,
            "y_axis":1,
            "z_axis":1,
            "holdoff":60
        }
    }
}`

Shock Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:58:15.311584266Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "acclAlarm": {
                    "alarmType": 12,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 0,
                    "setOnlyOnce": 0,
                    "shock_duration": 0.01,
                    "shock_thresh": 1.2,
                    "x_axis": 1,
                    "y_axis": 1,
                    "z_axis": 1
                }
            }
        },
        "id": "c521abeb-f48d-6ebc-ea5a-b84ee704072a",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:58:15.311584454Z",
        "state": "pending",
        "transactionid": "92756fd5-b60c-4f04-b4b4-25fa68bde4dc",
        "version": "1.0",
        "versionid": "3c58f0b8-2458-11eb-9630-ee1179cba4be"
    }

Example of Vibration Alarm Configuration Request

Note: Only a single type of acceleration alarm may be enabled on a device at a given time (only one of the following: motion, no-motion, shock, or vibration). Enabling one type of acceleration alarm will overwrite a previously configured acceleration alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":8, 
            "enabled":1,
            "setOnlyOnce":0,
            "locationRequired":0,
            "tap_thresh":2.0,
            "tap_duration":0.05,
            "holdoff":60
        }
    }
}`

Vibration Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:59:05.170923206Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "acclAlarm": {
                    "alarmType": 8,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 0,
                    "setOnlyOnce": 0,
                    "tap_duration": 0.05,
                    "tap_thresh": 2
                }
            }
        },
        "id": "e5f130fb-aff7-6d02-f0e2-deccd5df2544",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:59:05.170923278Z",
        "state": "pending",
        "transactionid": "8584051c-721f-4862-97e0-2b6157406b1e",
        "version": "1.0",
        "versionid": "5a10df2b-2458-11eb-a959-f26ddc710396"
    }

Example of Gyro Tilt Below Alarm Configuration Request

Note: Any axis can be monitored, but only one axis at a time

Note: Only one type of gyro alarm may be configured at a given time (one type of orientation or one type of tilt). Enabling one type of gyro alarm will overwrite a previously configured gyro alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "gyroAlarm": {
            "alarmType": 6, 
            "tilt_angle": 45, 
            "x_axis": 0,  
            "y_axis": 0,  
            "z_axis": 1,  
            "tilt_duration": 30.0,  
            "clear_duration": 30.0,  
            "enabled": 1,  
            "holdoff": 60, 
            "locationRequired": 1, 
            "setOnlyOnce": 0
        }
    }  
}`

Gyro Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T19:59:05.170923206Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "acclAlarm": {
                    "alarmType": 6,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "tilt_angle": 45,
                    "tilt_duration": 30,
                     "x_axis": 30,
                     "y_axis": 0,
                     "z_axis": 1
                }
            }
        },
        "id": "e5f130fb-aff7-6d02-f0e2-deccd5df2544",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T19:59:05.170923278Z",
        "state": "pending",
        "transactionid": "8584051c-721f-4862-97e0-2b6157406b1e",
        "version": "1.0",
        "versionid": "5a10df2b-2458-11eb-a959-f26ddc710396"
    }

Example of Gyro Tilt Exceeded Alarm Configuration Request

Note: Any axis can be monitored, but only one axis at a time

Note: Only one type of gyro alarm may be configured at a given time (one type of orientation or one type of tilt). Enabling one type of gyro alarm will overwrite a previously configured gyro alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "gyroAlarm": {
            "alarmType": 5, 
            "tilt_angle": 45, 
            "x_axis": 0,  
            "y_axis": 0,  
            "z_axis": 1,  
            "tilt_duration": 5.0,  
            "clear_duration": 1.0,  
            "enabled": 1,  
            "holdoff": 30, 
            "locationRequired": 1, 
            "setOnlyOnce": 0
        }
    }
}`

 

Gyro Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T20:01:06.985156031Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "gyroAlarm": {
                    "alarmType": 5,
                    "clear_duration": 1,
                    "enabled": 1,
                    "holdoff": 30,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "tilt_angle": 45,
                    "tilt_duration": 5,
                    "x_axis": 0,
                    "y_axis": 0,
                    "z_axis": 1
                }
            }
        },
        "id": "a5f11ffe-5e41-6231-ebeb-d0c377dc3cb0",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T20:01:06.9851561Z",
        "state": "pending",
        "transactionid": "33c292bc-d22e-4578-b649-aaf60a3fc117",
        "version": "1.0",
        "versionid": "a2ac3fa1-2458-11eb-a638-1a07f8c57c79"
    }

Example of Gyro Orientation Exceeded Alarm Configuration Request

Note: The X and Y axes will always be monitored for this alarm. The Z axis will not

Note: Only one type of gyro alarm may be configured at a given time (one type of orientation or one type of tilt). Enabling one type of gyro alarm will overwrite a previously configured gyro alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "gyroAlarm": 
            {  
                "alarmType": 2,
                "tilt_angle": 45,
                "x_axis": 1,
                "y_axis": 1,
                "z_axis": 0,
                "tilt_duration": 5.0,
                "clear_duration": 10.0,
                "enabled": 1,
                "holdoff": 60,
                "locationRequired": 1,
                "setOnlyOnce": 0
            }  
    }
}`

Gyro Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T20:02:16.312300886Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "gyroAlarm": {
                    "alarmType": 2,
                    "clear_duration": 10,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "tilt_angle": 45,
                    "tilt_duration": 5,
                    "x_axis": 1,
                    "y_axis": 1,
                    "z_axis": 0
                }
            }
        },
        "id": "e581e5f6-1dde-6292-e8bc-e3081a1d5fb8",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T20:02:16.312301073Z",
        "state": "pending",
        "transactionid": "c595ec70-6576-4c11-bafd-e426caf00982",
        "version": "1.0",
        "versionid": "cbfebb34-2458-11eb-9687-ee1179cba4be"
    }

Example of Gyro Orientation Below Alarm Configuration Request

Note: The X and Y axes will always be monitored for this alarm. The Z axis will not

Note: Only one type of gyro alarm may be configured at a given time (one type of orientation or one type of tilt). Enabling one type of gyro alarm will overwrite a previously configured gyro alarm type

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": “0654321123-00001”},
    "resourceidentifier":{"imei":914508030149993},
    "deviceConfig": {
        "gyroAlarm": 
            {  
                "alarmType": 3,
                "tilt_angle": 45,
                "x_axis": 1,
                "y_axis": 1,
                "z_axis": 0,
                "tilt_duration": 5.0,
                "clear_duration": 10.0,
                "enabled": 1,
                "holdoff": 60,
                "locationRequired": 1,
                "setOnlyOnce": 0
            }  
    }
}`

Gyro Alarm API Response

{
        "action": "set",
        "capabilityid": "00000000-0001-0001-0001-000000000000",
        "createdon": "2020-11-11T20:03:29.318609568Z",
        "deviceid": "04e12ee2-9720-6664-eced-efbd2718d3e9",
        "fields": {
            "deviceConfig": {
                "gyroAlarm": {
                    "alarmType": 3,
                    "clear_duration": 10,
                    "enabled": 1,
                    "holdoff": 60,
                    "locationRequired": 1,
                    "setOnlyOnce": 0,
                    "tilt_angle": 45,
                    "tilt_duration": 5,
                    "x_axis": 1,
                    "y_axis": 1,
                    "z_axis": 0
                }
            }
        },
        "id": "456119dd-9d3d-681d-faef-d93ef12c9f7f",
        "kind": "ts.event",
        "lastupdated": "2020-11-11T20:03:29.318609679Z",
        "state": "pending",
        "transactionid": "cafe7721-0000-4a9d-a006-f7b016713cd4",
        "version": "1.0",
        "versionid": "f7829c26-2458-11eb-9688-ee1179cba4be"
    }

Back to Top

 

 

Alarm reporting:

Temperature Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T17:09:17.699Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T17:08:55Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "temperature": {
                        "Threshold": "20.0",
                        "ThresholdRange": "30.0",
                        "alarmType": "4",
                        "sensorReading": "30.5",
                        "state": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "05a1106e-9516-6c54-fe88-bbd598e3e253",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T17:09:17.405006459Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-a75663ec-ebeb-4732-9ded-3f875b92ca3f",
            "version": "1.0",
            "versionid": "f4fd2913-2a89-11eb-bfb5-920b2a9a9805"
        }
    }
}

Light Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T17:09:22.764Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T17:08:57Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "light": {
                        "Threshold": "1000",
                        "ThresholdRange": "4000",
                        "alarmType": "4",
                        "sensorReading": "5",
                        "state": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "85010c9f-1f58-6c66-efb3-b992f30de96d",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T17:09:22.45521914Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-5e0f8d81-4131-4bd0-8c93-7895d1159589",
            "version": "1.0",
            "versionid": "f7ffc303-2a89-11eb-a157-42704ab2769c"
        }
    }
}

Humidity Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T17:09:23.682Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T17:09:05Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "humidity": {
                        "Threshold": "18",
                        "ThresholdRange": "25",
                        "alarmType": "4",
                        "sensorReading": "15",
                        "state": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "e5918009-6502-6fd6-e857-f02b7f488831",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T17:09:23.394033832Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-c7e3009d-49a3-42df-accb-455f28f5bcfe",
            "version": "1.0",
            "versionid": "f88f0374-2a89-11eb-9f4f-76b76076d570"
        }
    }
}

Pressure Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T17:09:24.754Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T17:09:10Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "pressure": {
                        "Threshold": "799",
                        "ThresholdRange": "800",
                        "alarmType": "4",
                        "sensorReading": "794",
                        "state": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "e52170ba-4e28-6357-e216-aad76370d2ff",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T17:09:24.450385991Z",
            "state":
 "update",
            "transactionid": "914508030149993-OnBoard-3f1ba145-6f03-4266-834b-794eb3c9faaa",
            "version": "1.0",
            "versionid": "f9303336-2a89-11eb-8d80-9e79657ba390"
        }
    }
}

Battery Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T17:09:17.699Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T17:08:55Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "battery": {
                        "Threshold": "25.0",
                        "ThresholdRange": "30.0",
                        "alarmType": "4",
                        "sensorReading": "20.5",
                        "state": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "05a1106e-9516-6c54-fe88-bbd598e3e253",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T17:09:17.405006459Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-a75663ec-ebeb-4732-9ded-3f875b92ca3f",
            "version": "1.0",
            "versionid": "f4fd2913-2a89-11eb-bfb5-920b2a9a9805"
        }
    }
}

Motion Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T20:54:07.311Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T20:54:04Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "motionDetected": {
                        "alarmType": "5",
                        "holdoff": "60",
                        "location": {
                            "accuracy": "7.0",
                            "latitude": "38.9280242",
                            "longitude": "-104.5099258",
                            "type": "gps&cid"
                        },
                        "locationRequired": "0",
                        "setOnlyOnce": "0",
                        "state": "1",
                        "stopped_period": "10.0",
                        "stopped_thresh": "0.2000",
                        "x": "-0.0603",
                        "y": "-0.0581",
                        "z": "0.9975"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "e5e19862-f7d2-6482-faed-4bc79c1f4f27",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T20:54:07.012570549Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-efd8006f-948f-4ce9-9558-4e14f7a0b960",
            "version": "1.0",
            "versionid": "5d6bec8d-2aa9-11eb-a152-aa4a6a882529"
        }
    }
}

No Motion Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T20:54:07.311Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T20:54:04Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "noMotionDetected": {
                        "alarmType": "13",
                        "holdoff": "60",
                        "location": {
                            "accuracy": "7.0",
                            "latitude": "38.9280242",
                            "longitude": "-104.5099258",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                        "setOnlyOnce": "0",
                        "state": "1",
                        "stopped_period": "10.0",
                        "stopped_thresh": "0.2000",
                        "x": "-0.0603",
                        "y": "-0.0581",
                        "z": "0.9975"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "e5e19862-f7d2-6482-faed-4bc79c1f4f27",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T20:54:07.012570549Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-efd8006f-948f-4ce9-9558-4e14f7a0b960",
            "version": "1.0",
            "versionid": "5d6bec8d-2aa9-11eb-a152-aa4a6a882529"
        }
    }
}

Shock Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T21:10:16.306Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T21:09:54Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "shock": {
                        "alarmType": "12",
                        "holdoff": "30",
                        "location": {
                            "accuracy": "6.0",
                            "latitude": "38.9280509",
                            "longitude": "-104.5098571",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                        "magnitude": "2.0083",
                        "setOnlyOnce": "0",
                        "shock_duration": "0.0100",
                        "shock_thresh": "1.2000",
                        "state": "1",
                        "x": "-0.1323",
                        "x_axis": "0",
                        "y": "-0.2219",
                        "y_axis": "0",
                        "z": "1.9916",
                        "z_axis": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "c581763c-18b7-6744-e140-cd0ed14cf667",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T21:10:16.001808846Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-7e998dde-05d7-4193-9eca-457486e3f64d",
            "version": "1.0",
            "versionid": "9efbf2ab-2aab-11eb-a843-b2402b5399ac"
        }
    }
}

Vibration Alarm

{
    "thing": "CAS",
    "created": "2020-11-19T21:20:08.560Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T21:19:33Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "vibration": {
                        "alarmType": "8",
                        "holdoff": "30",
                        "location": {
                            "accuracy": "5.0",
                            "latitude": "38.9279823",
                            "longitude": "-104.5100402",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                        "magnitude": "4.5007",
                        "setOnlyOnce": "0",
                        "state": "1",
                        "tap_duration": "0.0500",
                        "tap_thresh": "1.0",
                        "x": "0.8403",
                        "y": "1.7788",
                        "z": "4.0479"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "45c15ad9-70e8-620b-fd66-9e005bac6674",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T21:20:08.076028555Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-3a6c680e-0deb-4d3d-91ca-744e038effbc",
            "version": "1.0",
            "versionid": "ffe34ddf-2aac-11eb-96de-aec85ac2cbcd"
        }
    }
}

Gyro Alarm (Tilt Below)

{
    "thing": "CAS",
    "created": "2020-11-19T20:24:05.755Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T20:23:55Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "gyro": {
                        "alarmType": "6",
                        "clear_duration": "1.0",
                        "holdoff": "30",
                        "inclination": "2.0",
                        "location": {
                            "accuracy": "20.0",
                            "latitude": "38.9280853",
                            "longitude": "-104.5100555",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                        "orientation": {
                            "motionInX": "1.0",
                            "motionInY": "2.0",
                            "motionInZ": "0.0",
                            "tiltZ": "2.0"
                        },
                        "setOnlyOnce": "0",
                        "state": "1",
                        "tilt_angle": "45",
                        "tilt_duration": "1.0",
                        "x_axis": "0",
                        "y_axis": "0",
                        "z_axis": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "4591bafb-1c33-62e7-fc0c-b4bcc1eab217",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T20:24:05.430624049Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-5bb57d85-1b46-437c-8b86-8701db43b5f1",
            "version": "1.0",
            "versionid": "2b9855c3-2aa5-11eb-bc4d-1656742e6efe"
        }
    }
}

Gyro Alarm (Tilt Exceeded)

{
    "thing": "CAS",
    "created": "2020-11-19T20:24:05.755Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T20:23:55Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "gyro": {
                        "alarmType": "5",
                        "clear_duration": "1.0",
                        "holdoff": "30",
                        "inclination": "2.0",
                        "location": {
                            "accuracy": "20.0",
                            "latitude": "38.9280853",
                            "longitude": "-104.5100555",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                        "orientation": {
                            "motionInX": "1.0",
                            "motionInY": "2.0",
                            "motionInZ": "0.0",
                            "tiltZ": "2.0"
                        },
                        "setOnlyOnce": "0",
                        "state": "1",
                        "tilt_angle": "45",
                        "tilt_duration": "1.0",
                        "x_axis": "0",
                        "y_axis": "0",
                        "z_axis": "1"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "4591bafb-1c33-62e7-fc0c-b4bcc1eab217",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T20:24:05.430624049Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-5bb57d85-1b46-437c-8b86-8701db43b5f1",
            "version": "1.0",
            "versionid": "2b9855c3-2aa5-11eb-bc4d-1656742e6efe"
        }
    }
}

Gyro Alarm (Orientation Exceeded)

{
    "thing": "CAS",
    "created": "2020-11-19T21:20:08.560Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T21:19:33Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "gyro": {
                        "alarmType": "2",
                        "holdoff": "30",
                        "location": {
                            "accuracy": "5.0",
                            "latitude": "38.9279823",
                            "longitude": "-104.5100402",
                            "type": "gps"
                        },
                        "locationRequired": "0",
                       "orientation": {
                            "motionInX": "1.0",
                            "motionInY": "3.0",
                            "motionInZ": "0.0",
                            "tiltZ": "3.0"
                        },
                        "setOnlyOnce": "0",
                        "state": "1",
                        "tilt_angle": "45",
                        "tilt_duration": "5.0",
                        "x_axis": "1",
                        "y_axis": "1",
                        "z_axis": "0"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "45c15ad9-70e8-620b-fd66-9e005bac6674",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T21:20:08.076028555Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-3a6c680e-0deb-4d3d-91ca-744e038effbc",
            "version": "1.0",
            "versionid": "ffe34ddf-2aac-11eb-96de-aec85ac2cbcd"
        }
    }
}











Gyro Alarm (Orientation Below)

{
    "thing": "CAS",
    "created": "2020-11-19T21:25:58.003Z",
    "content": {
        "kind": "ts.event",
        "action": "create",
        "data": {
            "action": "update",
            "createdon": "2020-11-19T21:25:58Z",
            "deviceid": "a4f15963-4f7e-64f0-ea4e-9ce717123456",
            "fields": {
                "deviceAlarm": {
                    "gyro": {
                        "alarmType": "3",
                        "clear_duration": "10.0",
                        "holdoff": "30",
                        "location": {
                            "accuracy": "3.0",
                            "latitude": "38.9279670",
                            "longitude": "-104.5099563",
                            "type": "gps"
                        },
                        "locationRequired": "1",
                        "orientation": {
                            "motionInX": "1.0",
                            "motionInY": "3.0",
                            "motionInZ": "0.0",
                            "tiltZ": "3.0"
                        },
                        "setOnlyOnce": "0",
                        "state": "1",
                        "tilt_angle": "45",
                        "tilt_duration": "5.0",
                        "x_axis": "1",
                        "y_axis": "1",
                        "z_axis": "0"
                    }
                }
            },
            "foreignid": "e1f15861-7de7-69cb-ed7d-b4a92e123456",
            "id": "05f1f51f-b16f-6657-f661-9816710138e9",
            "imei": 914508030149993,
            "kind": "ts.event",
            "lastupdated": "2020-11-19T21:25:57.474002547Z",
            "state": "update",
            "transactionid": "914508030149993-OnBoard-5700a2c4-cc87-42ce-9381-a4478bc36939",
            "version": "1.0",
            "versionid": "d025343c-2aad-11eb-906c-3a7237aaae0c"
        }
    }
}

 

Back to Top

Clearing or Disabling Alarms:

Disabling Temperature Alarm:

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier": {"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier": {"imei": {{device_imei}}},
    "deviceConfig": {"tempAlarm":{"alarmType":0,"threshold":15,"thresholdRange":20}}
}`

Disabling Light Alarm:

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {"liteAlarm":{"alarmType":0,"threshold":1000,"thresholdRange":4000,"holdoff":30}}
}`

Disabling Humidity Alarm:

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {"HumiAlarm":{"alarmType":0,"threshold":60,"thresholdRange":90}}
}`

Disabling Pressure Alarm:

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {"presAlarm":{"alarmType":0,"threshold":1050,"thresholdRange":1100}}
}`

Disabling Battery Alarm:

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {"battAlarm":{"alarmType":0,"threshold":15,"thresholdRange":80}}
}`

Disabling Motion Alarm

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}` \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":5, 
            "enabled":0,
            "setOnlyOnce":0,
            "locationRequired":1,
            "accel_thresh":0.1,
            "stopped_thresh":0.08,
            "stopped_period":30.0,
            "holdoff":60
        }
    }
}`

Disabling No Motion Alarm

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":13, 
            "enabled":0,
            "holdoff":60,
            "locationRequired":1,
            "setOnlyOnce":0,
            "stopped_period":10.0,
            "stopped_thresh":0.20
        }
    }
}`

Disabling Shock Alarm

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":12, 
            "enabled":0,
            "setOnlyOnce":0,
            "locationRequired":0,
            "shock_thresh":1.2,
            "shock_duration":0.01,
            "x_axis":1,
            "y_axis":1,
            "z_axis":1,
            "holdoff":60
        }
    }
}`

Disabling Vibration Alarm

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "acclAlarm": {
            "alarmType":8, 
            "enabled":0,
            "setOnlyOnce":0,
            "locationRequired":0,
            "tap_thresh":2.0,
            "tap_duration":0.05,
            "holdoff":60
        }
    }
}`

Disabling Gyro Alarm (Tilt Below)

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "gyroAlarm": {
            "alarmType": 6, 
            "tilt_angle": 45, 
            "x_axis": 0,  
            "y_axis": 0,  
            "z_axis": 1,  
            "tilt_duration": 30.0,  
            "clear_duration": 30.0,  
            "enabled": 0,  
            "holdoff": 60, 
            "locationRequired": 1, 
            "setOnlyOnce": 0
        }
    }`

Disabling Gyro Alarm (Tilt Exceeded)

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "gyroAlarm": {
            "alarmType": 5, 
            "tilt_angle": 45, 
            "x_axis": 0,  
            "y_axis": 0,  
            "z_axis": 1,  
            "tilt_duration": 5.0,  
            "clear_duration": 1.0,  
            "enabled": 0,  
            "holdoff": 30, 
            "locationRequired": 1, 
            "setOnlyOnce": 0
        }
    }
}`

Disabling Gyro Alarm (Orientation Exceeded)

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "gyroAlarm": 
            {  
                "alarmType": 2,
                "tilt_angle": 45,
                "x_axis": 1,
                "y_axis": 1,
                "z_axis": 0,
                "tilt_duration": 5.0,
                "clear_duration": 10.0,
                "enabled": 0,
                "holdoff": 60,
                "locationRequired": 1,
                "setOnlyOnce": 0
            }  
    } 
}`

Disabling Gyro Alarm (Orientation Below)

curl -L -X POST 'https://thingspace.verizon.com/api/cc/v1/devices/actions/set' \
-H 'Authorization: Bearer {{Bearer Token}}' \
-H 'VZ-M2M-Token: {{VZ-M2M-Token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "accountidentifier":{"billingaccountid": "{{BillingAcId}}"},
    "resourceidentifier":{"imei":{{device_imei}}},
    "deviceConfig": {
        "gyroAlarm": 
            {  
                "alarmType": 3,
                "tilt_angle": 45,
                "x_axis": 1,
                "y_axis": 1,
                "z_axis": 0,
                "tilt_duration": 5.0,
                "clear_duration": 10.0,
                "enabled": 0,
                "holdoff": 60,
                "locationRequired": 1,
                "setOnlyOnce": 0
            }     
    }
}`

Back to Top