Get information about desktop button status

Returns information about desktop application button status

• This feature is available only in AA-14FB panel

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• is_enabled boolean

  Is custom buttons are enabled

• list_items object[]

  Buttons settings

{
  "is_enabled": true,
  "list_items": [
    {
      "is_visible": true,
      "code": "concierge",
      "caption": {
        "used": "Custom concierge",
        "default": "Concierge"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-concierge-custom.png",
        "default": "/api/v1/files?imagePath=button-concierge-default.png"
      }
    }
  ]
}

{
  "is_enabled": true,
  "list_items": [
    {
      "is_visible": true,
      "code": "pincode",
      "caption": {
        "used": "Custom pincode",
        "default": "Pincode"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-pincode-custom.png",
        "default": "/api/v1/files?imagePath=button-pincode-default.png"
      }
    },
    {
      "is_visible": true,
      "code": "recognition",
      "caption": {
        "used": "Custom recognition",
        "default": "Face"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-recognition-custom.png",
        "default": "/api/v1/files?imagePath=button-recognition-default.png"
      }
    },
    {
      "is_visible": true,
      "code": "concierge",
      "caption": {
        "used": "Custom concierge",
        "default": "Concierge"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-concierge-custom.png",
        "default": "/api/v1/files?imagePath=button-concierge-default.png"
      }
    },
    {
      "is_visible": true,
      "code": "call",
      "caption": {
        "used": "Custom call",
        "default": "Call"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-call-custom.png",
        "default": "/api/v1/files?imagePath=button-pincode-default.png"
      }
    },
    {
      "is_visible": true,
      "code": "contacts",
      "caption": {
        "used": "Custom contacts",
        "default": "Contacts"
      },
      "icon": {
        "used": "/api/v1/files?imagePath=button-contacts-custom.png",
        "default": "/api/v1/files?imagePath=button-contacts-default.png"
      }
    }
  ]
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

This feature is disabled on your device

Loading...