Accessibility Live Region Announcer
API Contract
REST
/api/v1/accessibility-announcements
6 endpoints
GET
/api/v1/accessibility-announcements/api/v1/accessibility-announcements
List recent announcements sent to live regions (audit log)
Public
Response Example
{
"data": [
{
"announcement_id": "ann-001",
"message": "Dictation started. Speak now.",
"priority": "polite",
"announced_at": "2026-03-26T11:05:01Z"
},
{
"announcement_id": "ann-002",
"message": "Microphone permission denied.",
"priority": "error",
"announced_at": "2026-03-26T11:05:05Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2
}
}
GET
/api/v1/accessibility-announcements/api/v1/accessibility-announcements/:id
Get a specific announcement record by ID
Public
Response Example
{
"announcement_id": "ann-002",
"message": "Microphone permission denied.",
"priority": "error",
"announced_at": "2026-03-26T11:05:05Z"
}
POST
/api/v1/accessibility-announcements/api/v1/accessibility-announcements
Queue a new live region announcement (assertive, polite, or error)
Public
Request Example
{
"message": "Dictation stopped. Text has been saved.",
"priority": "polite"
}
Response Example
{
"announcement_id": "ann-003",
"message": "Dictation stopped. Text has been saved.",
"priority": "polite",
"announced_at": "2026-03-26T11:07:16Z"
}
PUT
/api/v1/accessibility-announcements/api/v1/accessibility-announcements/:id
Update the message or priority of a queued announcement before delivery
Public
Request Example
{
"message": "Dictation stopped. Text saved successfully.",
"priority": "assertive"
}
Response Example
{
"announcement_id": "ann-003",
"message": "Dictation stopped. Text saved successfully.",
"priority": "assertive",
"updated_at": "2026-03-26T11:07:10Z"
}
DELETE
/api/v1/accessibility-announcements/api/v1/accessibility-announcements/:id
Remove a specific announcement from the queue
Public
Response Example
{
"announcement_id": "ann-003",
"deleted": true
}
DELETE
/api/v1/accessibility-announcements/api/v1/accessibility-announcements
Clear the entire announcement queue
Public
Response Example
{
"cleared": true,
"items_removed": 3
}