LogoLogo
ALO.ai
Developer Documentation
Developer Documentation
  • Developer Documentation
  • Developer Account
    • API Key
  • SDKs
    • Authentication
    • Chat
      • Configuration
      • Send Messages
        • Upload Files
      • Message History
      • Message Actions
      • Message Counts
      • Translation
      • Typing Indicators
      • API Reference
        • Event
        • Message
    • Presence
      • Configuration
      • Basic Usage
      • Methods
    • Audio
      • Prerequisites
      • Instantiating Audio Service
      • Connect to a Channel
      • Disconnecting Audio Service
      • Push To Talk (PTT)
      • Full Duplex
      • Mute and Unmute Audio
      • Input/Output Device Selection
        • Microphone Selection
        • Speaker Selection
      • Channel Participants
      • Text To Speech Audio (TTS)
      • Automatic Reconnects
      • Handling Events
      • Classes
        • AloAudio
        • AudioUser
        • AudioChannel
        • Participant
    • Video
      • Prerequisites
      • Instantiating Video Service
      • Connect to a Channel
      • Disconnecting Video Service
      • Input Device Selection
        • Microphone Selection
        • Camera Selection
      • Publishing Streams
      • Modifying Published Streams
      • Channel Participants
      • Rendering Streams
        • Local Stream
        • Remote Streams
      • Muting/Unmuting Remote Streams
      • Recording Video (coming soon)
      • Automatic Reconnects
      • Handling Events
      • Classes
        • AloVideo
        • Participant
        • VideoChannel
        • VideoUser
  • ALO APPS
    • Overview
    • Creating Apps
    • Webhooks
      • Verifying Requests from ALO
    • Custom Action Forms
    • Using the ALO Platform API
  • ALO Platform API
    • Overview
    • Authentication
    • API
      • Actions and Periods
      • Channels
      • Channel Messages
      • Channel Users
      • Direct Message Channels
      • Direct Message Channel Chat Messages
      • Direct Message Channel Users
      • Groups
      • Periods
      • Types
      • Users
      • Video Management System
  • Misc
    • Supported Language Codes
Powered by GitBook
LogoLogo

ALO.ai

  • ALO.ai

© Copyright 2025 ALO.ai, Inc. • All Rights Reserved

On this page
  • Message Schema
  • File Schema
  1. SDKs
  2. Chat
  3. API Reference

Message

Specifications for message and file formats.

Message Schema

Name

Type

Description

id

string

The UUID assigned to the message automatically by the service when it is sent.

content

string

The content of the message.

timestamp

string

The Unix timestamp in milliseconds when the message was sent.

channelId

string

The id of the channel the message is persisted to.

userId

string

The id of the user who sent the message.

parent

rootMessageId

string

metadata

object

The custom object of metadata properties. The following keys have special functions when set and so should not be used for custom properties: sourceLanguageCode, targetLanguageCodes.

i18n

object

The internationalization object for storing translations of the message content. Has the following shape: { en: { content: "Hello" }, es: { content: "Hola" } }

files

actions

array

The array of custom items attached to the message via sendMessageAction.

File Schema

Name

Type

Description

id

string

The auto-generated unique id of the file created when it was uploaded.

channelId

string

The id of the channel the file was sent to.

name

string

The name of the file.

lastModified

integer

The last modified date of the file in Unix timestamp in milliseconds.

size

integer

The size of the file in bytes.

contentType

string

The content type of the file (i.e. image/jpeg).

PreviousEventNextPresence

Last updated 8 months ago

The parent that this message is a direct reply to.

The id of the root parent of the reply chain.

array []

The list of objects associated with the message that references files uploaded to the service.

Message
Message
Message
File
File