CoreNotification
This API is partially documented or under construction.
Overview​
Core Notification API implementation for Synology NAS.
Covers SYNO.Core.Notification.Advance, CMS, Line, Mail, Push, SMS, and Sysnotify endpoints not already present in core_sys_info.py.
Methods​
notification_advance_customized_data_get​
Get advanced notification customized data.
Internal API​
SYNO.Core.Notification.Advance.CustomizedData
Returns​
dict[str, object] or str
Customized notification data.
notification_advance_customized_data_set​
Set advanced notification customized data.
Internal API​
SYNO.Core.Notification.Advance.CustomizedData
Parameters​
data str
JSON-encoded customized data payload.
Returns​
dict[str, object] or str
API response.
notification_advance_filter_settings_get​
Get advanced notification filter settings.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings
Returns​
dict[str, object] or str
Filter settings configuration.
notification_advance_filter_settings_set​
Set advanced notification filter settings.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings
Parameters​
settings str
JSON-encoded filter settings.
Returns​
dict[str, object] or str
API response.
notification_advance_filter_profile_get​
Get advanced notification filter settings profile.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings.Profile
Returns​
dict[str, object] or str
Filter settings profile.
notification_advance_filter_profile_set​
Set advanced notification filter settings profile.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings.Profile
Parameters​
profile str
JSON-encoded profile data.
Returns​
dict[str, object] or str
API response.
notification_advance_filter_template_get​
Get advanced notification filter settings template.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings.Template
Returns​
dict[str, object] or str
Filter settings template.
notification_advance_filter_template_set​
Set advanced notification filter settings template.
Internal API​
SYNO.Core.Notification.Advance.FilterSettings.Template
Parameters​
template str
JSON-encoded template data.
Returns​
dict[str, object] or str
API response.
notification_advance_variables_get​
Get advanced notification variables.
Internal API​
SYNO.Core.Notification.Advance.Variables
Returns​
dict[str, object] or str
Notification variables.
notification_advance_variables_set​
Set advanced notification variables.
Internal API​
SYNO.Core.Notification.Advance.Variables
Parameters​
variables str
JSON-encoded variables data.
Returns​
dict[str, object] or str
API response.
notification_advance_warning_percentage_get​
Get advanced notification warning percentage thresholds.
Internal API​
SYNO.Core.Notification.Advance.WarningPercentage
Returns​
dict[str, object] or str
Warning percentage configuration.
notification_advance_warning_percentage_set​
Set advanced notification warning percentage thresholds.
Internal API​
SYNO.Core.Notification.Advance.WarningPercentage
Parameters​
percentage int
Warning percentage threshold value.
Returns​
dict[str, object] or str
API response.
notification_cms_get​
Get CMS notification settings.
Internal API​
SYNO.Core.Notification.CMS
Returns​
dict[str, object] or str
CMS notification settings.
notification_cms_set​
Set CMS notification settings.
Internal API​
SYNO.Core.Notification.CMS
Parameters​
settings str
JSON-encoded CMS notification settings.
Returns​
dict[str, object] or str
API response.
notification_cms_conf_get​
Get CMS notification configuration.
Internal API​
SYNO.Core.Notification.CMS.Conf
Returns​
dict[str, object] or str
CMS notification configuration.
notification_cms_conf_set​
Set CMS notification configuration.
Internal API​
SYNO.Core.Notification.CMS.Conf
Parameters​
conf str
JSON-encoded CMS notification configuration.
Returns​
dict[str, object] or str
API response.
notification_line_get​
Get Line notification configuration.
Internal API​
SYNO.Core.Notification.Line
Returns​
dict[str, object] or str
Line notification configuration.
notification_line_set​
Set Line notification configuration.
Internal API​
SYNO.Core.Notification.Line
Parameters​
token str
Line notification access token.
enable bool
Enable or disable Line notifications.
Returns​
dict[str, object] or str
API response.
notification_mail_get​
Get mail notification settings.
Internal API​
SYNO.Core.Notification.Mail
Returns​
dict[str, object] or str
Mail notification settings.
notification_mail_set​
Set mail notification settings.
Internal API​
SYNO.Core.Notification.Mail
Parameters​
settings str
JSON-encoded mail notification settings.
Returns​
dict[str, object] or str
API response.
notification_mail_auth_get​
Get mail notification authentication settings.
Internal API​
SYNO.Core.Notification.Mail.Auth
Returns​
dict[str, object] or str
Mail authentication settings.
notification_mail_auth_set​
Set mail notification authentication settings.
Internal API​
SYNO.Core.Notification.Mail.Auth
Parameters​
auth_type str
Authentication type (e.g., 'plain', 'login').
username str
SMTP authentication username.
password str
SMTP authentication password.
Returns​
dict[str, object] or str
API response.
notification_mail_oauth_get​
Get mail notification OAuth settings.
Internal API​
SYNO.Core.Notification.Mail.Oauth
Returns​
dict[str, object] or str
Mail OAuth settings.
notification_mail_oauth_set​
Set mail notification OAuth settings.
Internal API​
SYNO.Core.Notification.Mail.Oauth
Parameters​
client_id str
OAuth client ID.
client_secret str
OAuth client secret.
refresh_token str
OAuth refresh token.
Returns​
dict[str, object] or str
API response.
notification_mail_profile_conf_get​
Get mail notification profile configuration.
Internal API​
SYNO.Core.Notification.Mail.Profile.Conf
Returns​
dict[str, object] or str
Mail profile configuration.
notification_mail_profile_conf_set​
Set mail notification profile configuration.
Internal API​
SYNO.Core.Notification.Mail.Profile.Conf
Parameters​
profile str
JSON-encoded mail profile configuration.
Returns​
dict[str, object] or str
API response.
notification_push_get​
Get push notification settings.
Internal API​
SYNO.Core.Notification.Push
Returns​
dict[str, object] or str
Push notification settings.
notification_push_set​
Set push notification settings.
Internal API​
SYNO.Core.Notification.Push
Parameters​
enable bool
Enable or disable push notifications.
Returns​
dict[str, object] or str
API response.
notification_push_auth_token_get​
Get push notification authentication token.
Internal API​
SYNO.Core.Notification.Push.AuthToken
Returns​
dict[str, object] or str
Push authentication token information.
notification_push_auth_token_set​
Set push notification authentication token.
Internal API​
SYNO.Core.Notification.Push.AuthToken
Parameters​
token str
Push authentication token.
Returns​
dict[str, object] or str
API response.
notification_push_mobile_get​
Get mobile push notification settings.
Internal API​
SYNO.Core.Notification.Push.Mobile
Returns​
dict[str, object] or str
Mobile push notification settings.
notification_push_mobile_set​
Set mobile push notification settings.
Internal API​
SYNO.Core.Notification.Push.Mobile
Parameters​
settings str
JSON-encoded mobile push settings.
Returns​
dict[str, object] or str
API response.
notification_push_webhook_provider_get​
Get push notification webhook provider configuration.
Internal API​
SYNO.Core.Notification.Push.Webhook.Provider
Returns​
dict[str, object] or str
Webhook provider configuration.
notification_push_webhook_provider_set​
Set push notification webhook provider configuration.
Internal API​
SYNO.Core.Notification.Push.Webhook.Provider
Parameters​
provider str
Webhook provider name.
url str
Webhook endpoint URL.
token str
Webhook authentication token.
Returns​
dict[str, object] or str
API response.
notification_sms_get​
Get SMS notification settings.
Internal API​
SYNO.Core.Notification.SMS
Returns​
dict[str, object] or str
SMS notification settings.
notification_sms_set​
Set SMS notification settings.
Internal API​
SYNO.Core.Notification.SMS
Parameters​
settings str
JSON-encoded SMS notification settings.
Returns​
dict[str, object] or str
API response.
notification_sms_provider_get​
Get SMS notification provider configuration.
Internal API​
SYNO.Core.Notification.SMS.Provider
Returns​
dict[str, object] or str
SMS provider configuration.
notification_sms_provider_set​
Set SMS notification provider configuration.
Internal API​
SYNO.Core.Notification.SMS.Provider
Parameters​
provider str
SMS provider name.
api_key str
SMS provider API key.
Returns​
dict[str, object] or str
API response.
notification_sysnotify_get​
Get system notification settings.
Internal API​
SYNO.Core.Notification.Sysnotify
Returns​
dict[str, object] or str
System notification settings.
notification_sysnotify_set​
Set system notification settings.
Internal API​
SYNO.Core.Notification.Sysnotify
Parameters​
settings str
JSON-encoded system notification settings.
Returns​
dict[str, object] or str
API response.
push_notification_requesttoken​
Request a push notification authentication token.
Internal API​
SYNO.DSM.PushNotification
Returns​
dict
API response from SYNO.DSM.PushNotification.