Panel
API Calls
For more details on the making API Calls, view the API Calls section.
-
change_setting/panel/change_settingChange a Panel Setting Value
-
get/panel/getFetch a single Panel Object. Accepts the Panel's ID.
-
kuvrr_call_accepted/panel/kuvrr_call_acceptedTell the AlphaTouch Servers that a call has been answered from a Kuvrr user, so it can notify any other called devices.Important Notes:This API Action Requires that the Kuvrr Call Integration Add-On is enabled!
-
kuvrr_trigger_action/panel/kuvrr_trigger_action/Trigger a Door Release Action from a Kuvrr device. The selected resident who is triggering the action must belong to a building that belongs to the selected panel.Important Notes:A successful call to this API action will result in the action being triggered, and potentially unlocking any door that is impacted by this action!This API Action Requires that the Kuvrr Call Integration Add-On is enabled!
-
list/panel/listFetch an array of all Panel Objects within the Installation.
-
properties_delete/panel/properties_deleteDelete specified custom properties for a selected Panel. Set the "keys" parameter to an array or comma-seperated string of keys to delete.
-
properties_update/panel/properties_updateUpdate your custom properties for a selected Panel. Use this API call to associate additional information for this Panel that will be stored in this Panel's properties array.
-
trigger_pin/panel/trigger_pin//Trigger a Pinned Action. The Action must be enabled and it must be selected as pinned. The selected resident who is triggering the action must belong to a building that belongs to the selected panel.Important Notes:A successful call to this API action will result in the action being triggered, and potentially unlocking any door that is impacted by this action!
Webhooks
For more details on the data that is sent to your Webhook Endpoint, view the Webhooks section.
-
add
-
delete
-
update
Object
{
"action_pins":[
{
"action_length":11,
"caption":"Visitor Access",
"caption_translations":{
"EN":"Visitor Access",
"FR":"Acc\u00e8s Visiteurs",
"GE":"Besucherzugang",
"NL":"Toegang Voor Bezoekers",
"RU":"\u0414\u043e\u0441\u0442\u0443\u043f \u043f\u043e\u0441\u0435\u0442\u0438\u0442\u0435\u043b\u0435\u0439",
"SP":"Acceso De Visitante"
},
"id":1
}
],
"atrc_callup_duration":3,
"atrc_door_number":0,
"atrc_elevator_duration":1,
"atrc_enabled":false,
"atrc_mac":"",
"building_ids":[
"1"
],
"description":"Farmingdale Commons",
"device_description":"7.0\" Touchscreen Video Entry Panel",
"device_type":"panel",
"firmware_version":"29.0.1.240",
"formatted_name_full":"Farmingdale Commons",
"from_phone":"6315555599",
"from_phone_country":"United States",
"from_phone_country_code":"1",
"from_phone_intl":"+16315555599",
"id":10075,
"latest_software_version":"1.0.86",
"latest_software_version_int":100000086,
"logoutDate":null,
"mac":"0C11050780F7",
"model":"AT700AS",
"os_version":"5.1.1",
"properties": {
"key1":"value1",
"key2":"value2",
...
},
"proximity_enabled":true,
"serial_number":"",
"software_version":"1.0.87",
"software_version_int":100000087,
"status":"online",
"title":"Side Entrance",
"visitor_camera_url":""
}
Sandbox
Please Login to Enable Sandboxing
Copyright© 2018-2024 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.