Announcements
Get an announcement
GET
https://api.tunio.ai/v1/announcements/{announcement_id}Get a single announcement by UUID
Path parameters
| Name | Type | Description |
|---|---|---|
| announcement_idRequired | string | Announcement ID |
Responses
| Name | Type | Description |
|---|---|---|
| announcement | object | Announcement provides the requested announcement data. |
| announcement_id | string | UUID uniquely identifies the announcement. |
| background_uuid | string | BackgroundUUID references selected background track. |
| background_volume | number | BackgroundVolume stores chosen background volume (0..1). |
| created_at | string | CreatedAt is when the announcement was created. |
| end_date | string | EndDate optionally defines when playback must end. |
| has_audio_warning | boolean | HasAudioWarning tells whether to prepend alert audio. |
| message | string | Message stores the generated announcement text. |
| mix_uuid | string | MixUUID references the generated mix file UUID. |
| model_id | string | Model references the TTS model UUID used. |
| speed | number | Speed indicates final playback speed. |
| start_date | string | StartDate optionally defines when playback can start. |
| state | string | State describes the rendering state (queued/completed/etc). |
| title | string | Title shows the announcement title. |
| tts_audio_uuid | string | TTSAudioUUID references stored TTS audio for this announcement. |
| tts_duration | integer | TTSDuration stores generated TTS duration in seconds. |
| success | boolean | Success indicates retrieval succeeded. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |
| Name | Type | Description |
|---|---|---|
| message | string | Message contains human readable error details. |
| success | boolean | Success is always false for error payloads. |