Loading ...

REST API: Get Recent Message Threads | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Chat » REST API: Get Recent Message Threads
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Recent Message Threads

0 
 /5
0 (0votes)

Get Recent Message Threads

GET /api/chat/threads/me/recent

Get a community user's recent message threads from database. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.

Example URL: https://your-community.com/api/chat/threads/me/recent

Response JSON sample where message thread JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
   {
     "ThreadID": 1,
     "ThreadURL": "https://your-community.com/chat#/threads/1",
     "ThreadImageURL": "https://your-community.com/assets/Themes/default/images/avatar-default.jpg",
     "ThreadImageDisplayUserID": 0,
     "MessageID": 0,
     "Participants": "Penny Ray",
     "ParticipantsIds": "5, 6",
     "ParticipantUserID": 6,
     "ParticipantOnlineChatStatus": 1,
     "ParticipantChatStatusCssClass": "status-online",
     "UnreadMessageCount": 0,
     "MessageBody": "hi",
     "MessageBodyTruncated": "hi",
     "StartedByUserID": 5,
     "StartedByUserMediaServerID": 0,
     "LastMessageSenderUserID": 0,
     "IsRead": true,
     "DateSent": "2019-01-03T08:16:00.99Z",
     "DateSentText": "2 hours ago",
     "DateCreated": "0001-01-01T00:00:00",
     "ParticipantsJsonString": "[{"id":"6","name":"Penny Ray"}]",
     "ThreadTitle": "Penny Ray",
     "ThreadType": 3,
     "DateDividerString": "1/1/0001",
     "DateSentWrtUser": "0001-01-01T00:00:00",
     "IsFavorite": false,
     "RoomName": "1",
     "TenantID": 0
   },
   {
     "ThreadID": 2,
     "ThreadURL": "https://your-community.com/chat#/threads/2",
     "ThreadImageURL": "https://your-community.com/assets/Themes/default/images/avatar-default.jpg",
     "ThreadImageDisplayUserID": 0,
     "MessageID": 0,
     "Participants": "Ben Newman",
     "ParticipantsIds": "1, 5",
     "ParticipantUserID": 1,
     "ParticipantOnlineChatStatus": 2,
     "ParticipantChatStatusCssClass": "status-offline",
     "UnreadMessageCount": 0,
     "MessageBody": "hey there",
     "MessageBodyTruncated": "hey there",
     "StartedByUserID": 1,
     "StartedByUserMediaServerID": 0,
     "LastMessageSenderUserID": 0,
     "IsRead": true,
     "DateSent": "2019-01-02T11:03:46.603Z",
     "DateSentText": "23 hours ago",
     "DateCreated": "2019-01-02T08:47:56.363",
     "ParticipantsJsonString": "[{"id":"1","name":"Ben Newman"}]",
     "ThreadTitle": "Ben Newman",
     "ThreadType": 3,
     "ThreadStatus": 1,
     "DateSentWrtUser": "0001-01-01T00:00:00",
     "IsFavorite": false,
     "RoomName": "2",
     "TenantID": 0
   }
],
}

Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software