Loading ...

REST API: Chat | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Chat
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 34

REST API: Chat

0 
 /5
0 (0votes)
Open API Guide

Create and manage chat rooms, send direct messages, configure notification preferences, and integrate real-time communication features into your workflows. Ideal for building support bots or custom messaging interfaces.

Available Endpoints

Method Endpoint Description
POST Add Message /api/chat/messages Send a chat message to a community user
POST Add Message Thread /api/chat/threads Start a new direct or group message thread in the chat system. Use this to programmatically create conversations between specific community members.
POST Add Thread Participants /api/chat/threads/{ThreadID}/participants Add a new chat thread by copying the participants from an existing thread
DELETE Delete Message /api/chat/messages/{MessageID} Delete a community user's message from database
PUT Edit Message /api/chat/messages/{MessageID} Technical reference for the Update Chat Message endpoint, providing programmatic access to update chat message functionality.
GET Get Message /api/chat/messages/{MessageID} Retrieves a specific chat message by its unique identifier. Returns the full message object including sender details, timestamps, read status, and thread metadata.
GET Get Message Thread /api/chat/threads/{ThreadID} Enables administrators and developers to programmatically retrieve a community user's message thread from database.
GET Get Messages /api/chat/messages Enables administrators and developers to programmatically retrieve a user's chat messages.
GET Get Recent Message Threads /api/chat/threads/me/recent Enables administrators and developers to programmatically retrieve a community user's recent message threads from database.
PUT Mark Message As Read /api/chat/threads/readstatus Technical reference for the Mark Messages As Read endpoint, providing programmatic access to mark messages as read functionality.
PUT Mark Thread As Favorite /api/chat/threads/{ThreadID}/favorite/status Technical reference for the Mark Thread As Favorite endpoint, providing programmatic access to mark thread as favorite functionality.
PUT Set Online Chat Status /api/chat/me/status Technical reference for the Set Online Status endpoint, providing programmatic access to set online status functionality.

Wiki Index

Pages