Announcements

Get an announcement

GET
https://api.tunio.ai/v1/announcements/{uuid}

Get a single announcement by UUID

Path parameters

NameTypeDescription
uuidRequiredstringAnnouncement UUID

Responses

NameTypeDescription
announcementobject
Announcement provides the requested announcement data.
created_atstring
CreatedAt is when the announcement was created.
end_datestring
EndDate optionally defines when playback must end.
has_audio_warningboolean
HasAudioWarning tells whether to prepend alert audio.
messagestring
Message stores the generated announcement text.
modelstring
Model references the TTS model UUID used.
speednumber
Speed indicates final playback speed.
start_datestring
StartDate optionally defines when playback can start.
statestring
State describes the rendering state (queued/completed/etc).
titlestring
Title shows the announcement title.
uuidstring
UUID uniquely identifies the announcement.
successboolean
Success indicates retrieval succeeded.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.
NameTypeDescription
messagestring
Message contains human readable error details.
successboolean
Success is always false for error payloads.