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 38

REST API: Chat

0 
 /5
0 (0votes)
Open API Guide

Start direct and group message threads, and send, edit, and delete chat messages. Read threads and messages, and set the calling user's chat status and favorite threads.

Available Endpoints

Method Endpoint Description
POST Add Message /api/chat/messages Send a chat message to an existing message thread
POST Add Message Thread /api/chat/threads Start a new direct or group message thread.
POST Add Thread Participants /api/chat/threads/{ThreadID}/participants Add people to a message thread.
DELETE Delete Message /api/chat/messages/{MessageID} Delete a chat message.
PUT Edit Message /api/chat/messages/{MessageID} Update the text of a chat message.
GET Get Message /api/chat/messages/{MessageID} Get a chat message by its ID.
GET Get Message Thread /api/chat/threads/{ThreadID} Get a message thread the caller takes part in.
GET Get Messages /api/chat/messages Get the messages in one or more chat threads the calling user takes part in.
GET Get Recent Message Threads /api/chat/threads/me/recent Get the calling user's most recent message threads.
PUT Mark Message As Read /api/chat/threads/readstatus Mark the messages in one or more chat threads as read for the calling user.
PUT Mark Thread As Favorite /api/chat/threads/{ThreadID}/favorite/status Mark or unmark a chat thread as a favorite for the calling user.
PUT Set Online Chat Status /api/chat/me/status Set the calling user's online chat status.

Wiki Index

Pages