Autional Autional
API Reference GitHub autional.com →

POST /notifications/test

Send a test notification to the specified channel and target, creating a test notification record in the database to verify the notification service configuration. Reference: CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance.

Notification Service `bearerAuth` application/json

Request Body

Schema: dto.TestNotificationRequest

FieldTypeRequiredExampleConstraintsDescription
channel string Yes email Channel
target string Yes user@example.com Target

Responses

StatusDescriptionSchema
200Test notification sentdto.TestNotificationDetailResponse
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.TestNotificationDetailResponse

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

dto.TestNotificationResponse

Test notification send result

FieldTypeRequiredExampleConstraintsDescription
channel string No email Channel
status string No sent Status
target string No user@example.com Target
test_id string No test-1234567890 Test ID

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No