Monitor
API Calls
For more details on the making API Calls, view the API Calls section.
  • get
    /monitor/get
    Fetch a single Monitor Object. Accepts the Monitor's ID.
  • list_apartment
    /monitor/list_apartment
    Fetch an array of all Monitor Objects within a specified Apartment. Accepts the Apartment's ID.
  • list
    /monitor/list
    Fetch an array of all Monitor Objects within the Installation.
  • properties_delete
    /monitor/properties_delete
    Delete specified custom properties for a selected Monitor. Set the "keys" parameter to an array or comma-seperated string of keys to delete.
  • properties_update
    /monitor/properties_update
    Update your custom properties for a selected Monitor. Use this API call to associate additional information for this Monitor that will be stored in this Monitor's properties array.
Webhooks
For more details on the data that is sent to your Webhook Endpoint, view the Webhooks section.
  • add
    Triggers when a new Monitor is added to an Apartment or when a monitor is moved from another Installation to an Apartment in this one. Returns a data payload with the Monitor Object of the added Monitor.
  • delete
    Triggers when an existing Monitor is deleted from an Apartment or when a monitor is moved from an apartment in this Installation to an apartment in another Installation. Returns no data payload.
  • update
    Triggers when an existing Monitor is updated and returns a data payload with the Monitor Object of the updated Monitor.
Object
{
    "apartment_id":1,
    "apartment_title":"101A",
    "building_id":1,
    "building_title":"North Tower",
    "camera":false,
    "description":"",
    "device_description":"10.0\" Touchscreen Video Monitor",
    "device_type":"monitor",
    "dnd_mode":false,
    "id":25,
    "language":"EN",
    "latest_software_version":"1.0.7",
    "latest_software_version_int":100000007,
    "logoutDate":null,
    "mac":"000000000000",
    "model":"AT1000MS",
    "os_version":null,
    "properties": {
        "key1":"value1",
        "key2":"value2",
        ... 
    },
    "software_version":null,
    "software_version_int":0,
    "status":"offline",
    "title":"Kitchen",
    "touchscreen":true
}
Sandbox
Please Login to Enable Sandboxing

ALPHA COMMUNICATIONS  |  (DIV. OF GOLDCOM INC.)  |  42 CENTRAL DRIVE  |  FARMINGDALE NY 11735-1202
631-777-5500 MAIN  |   800-666-4800 USA  |   631-777-5599 FAX#  |  http://www.alphacommunications.com
Copyright© 2018-2020 Alpha Communications. All rights reserved.
Amazon, Echo, Alexa, and all related logos are trademarks of Amazon.com, Inc. or its affiliates.
Google LLC All rights reserved. Google and the Google logo are registered trademarks of Google LLC.