message_idstring required
creator_idstring required
created_atstring date-time required
deleted_atstring date-time nullable
last_updated_atstring date-time required
workspace_idsstring[] required
channel_idsstring[] required
parent_message_idstring nullable
heard_msnumber nullable
The number of ms of audio listened to by the user requesting the message
notifyboolean required
Has the logged in user cleared the notification for this message
last_heard_updatestring date-time required
Last time we listened/updated notify bit
is_text_messageboolean required
status'offline' | 'paused' | 'processing' | 'scheduled' | 'active' | 'deleted' | 'account-deleted' | 'initializing' | 'inprogress' | 'canceled' | 'failed' required
label_idsstring[] required
source_message_idstring nullable required
audio_delivery'recording' | 'streaming' required
duration_msnumber required
The length of the message in milliseconds
total_heard_msnumber required
The number of ms of audio listened to by all users
notified_usersnumber required
Then number of users who have a notification for this message and have not listened to the audio.
users_caught_up'all' | 'some' | 'none' required
The number of users that listened to the audio or removed the notification
forward_idstring nullable
The ID of a forwarded message (Deprecated, for new implementations we should start using share_link_id
share_link_idstring nullable
The ID of a Share Link to a message
stream_keystring nullable
The stream key used to add audio to the message
socket_disconnects_while_streamingnumber required
The number of times the socket disconnected while the creator was sending audio
type'channel' | 'prerecorded' | 'voicememo' | 'stored' | 'welcome' required
channel_sequencenumber required
The sequencial id of the message within the channel
last_heard_atstring date-time required
The last time anyone listened or cleared notified on this message
folder_idstring nullable
Folder ID, only present when the message type is one of: voicememo,prerecorded
tagged_user_idsstring[] required
IDs of users tagged in the message