Autional Autional
API Reference GitHub autional.com →

POST /admin/notifications/broadcast

Send notification messages to all users under a tenant or a specified user group, suitable for system maintenance notifications, security alerts, etc. Reference: CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance.

Notification Service `bearerAuth` application/json

Request Body

Schema: dto.BroadcastNotificationRequest

FieldTypeRequiredExampleConstraintsDescription
content string Yes The system will undergo maintenance tonight from 22:00 to 23:00 Content
title string Yes System announcement Title
type string No system Type

Responses

StatusDescriptionSchema
200Broadcast sent successfullydto.BroadcastNotificationDetailResponse
400Invalid request parametersgitee_com_linmes_authms_base_dto.SimpleResponse
401Unauthenticatedgitee_com_linmes_authms_base_dto.SimpleResponse
403Insufficient permissionsgitee_com_linmes_authms_base_dto.SimpleResponse
404Resource not foundgitee_com_linmes_authms_base_dto.SimpleResponse
500Internal server errorgitee_com_linmes_authms_base_dto.SimpleResponse

Referenced Schemas

dto.BroadcastNotificationDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.BroadcastNotificationResponse No
message string No

dto.BroadcastNotificationResponse

Broadcast notification response result

FieldTypeRequiredExampleConstraintsDescription
broadcast_id string No broadcast-1234567890 Broadcast ID
content string No The system will undergo maintenance tonight from 22:00 to 23:00 Content
recipients integer No 100 Recipient count
title string No System announcement Title
type string No system Type

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No