Loading ...

REST API: Add Message Thread | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Chat » REST API: Add Message Thread
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 6

REST API: Add Message Thread

0 
 /5
0 (0votes)

Add Message Thread

POST /api/chat/threads

Create a group chat. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
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.
Chat JSON Used in the request body This is JSON that represents a chat object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
ParticipantsIds Used in the request body This includes participants you want to send the message to.

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

Request JSON sample for adding a new message thread

{
  "ParticipantsIds": "7,12"
}

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": 12,
      "ThreadURL": "https://myintranet.communifire.com/chat#/threads/12",
      "ThreadImageURL": "https://myintranet.communifire.com/assets/Themes/default/images/group-chat-icon.png",
      "ThreadImageDisplayUserID": 0,
      "MessageID": 0,
      "Participants": "Ben Newman, Mia Wilson",
      "ParticipantsIds": "6, 7, 12",
      "ParticipantUserID": 0,
      "ParticipantOnlineChatStatus": 0,
      "UnreadMessageCount": 0,
      "MessageBody": "No messages yet",
      "MessageBodyHtmlFormatted": "No messages yet",
      "MessageBodyTextFormatted": "No messages yet",
      "MessageBodyTruncated": "No messages yet",
      "StartedByUserID": 6,
      "StartedByUserMediaServerID": 0,
      "LastMessageSenderUserID": 0,
      "IsRead": false,
      "DateSent": "2020-07-02T12:12:41.557",
      "DateSentText": "just now",
      "DateCreated": "2020-07-02T19:12:41.557",
      "ParticipantsJsonString": "[{"id":"7","name":"Ben Newman"},{"id":"12","name":"Mia Wilson"}]",
      "ThreadTitle": "Ben Newman, Mia Wilson",
      "ThreadType": 1,
      "ThreadStatus": 1,
      "IsFavorite": false,
      "RoomName": "12",
      "TenantID": 1
   }
}

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

Wiki Index

Pages

Intranet Software