Customize Event Messages

This topic describes how to customize the messages displayed on the device screen after identification events occur. The events are:

• Authorized access
• Unauthorized access
• User Not Identified
• Wear mask

By default, some of these events do not display any messages. However, it is possible to configure the device to display custom messages for each of these events according to specific needs.

Note: This feature is available only on iDFace and iDFace Max devices, considering the latest available firmware versions.

POST /set_configuration.fcgi

Parameters

• To customize identification messages, the following parameters are required:

  Field	Type	Description
  custom_auth_message	string	Defines the custom message for when access is authorized.
  custom_deny_message	string	Defines the custom message for when access is unauthorized.
  custom_not_identified_message	string	Defines the custom message for when the user is not identified.
  custom_mask_message	string	Defines the custom message for mask usage.
  enable_custom_auth_message	int	Enables (1) or Disables (0) the custom message for authorized access.
  enable_custom_deny_message	int	Enables (1) or Disables (0) the custom message for unauthorized access.
  enable_custom_not_identified_message	int	Enables (1) or Disables (0) the custom message when the user is not identified.
  enable_custom_mask_message	int	Enables (1) or Disables (0) the custom message for mask usage.

Note: The content of custom messages may be truncated depending on the size of the device's display.

Response

• This request has no response.

Request Example:

$.ajax({
    url: "/set_configuration.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify(
        {
            "identifier": {
                "custom_auth_message": "Welcome",
                "custom_deny_message": "Access denied",
                "custom_not_identified_message": "User not recognized",
                "custom_mask_message": "Please wear a mask",
                "enable_custom_auth_message": "1",
                "enable_custom_deny_message": "1",
                "enable_custom_not_identified_message": "1",
                "enable_custom_mask_message": "1"
            }
        }
    )
});