POST Message/MessageApi/SendMessageToUserOrChannel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
ChannelId	globally unique identifier	None.
SenderId	globally unique identifier	None.
ReceiverId	globally unique identifier	None.
Message	string	None.
IsDeleted	boolean	None.
IsEdited	boolean	None.
MessageDateTime	date	None.
UpdatedDateTime	date	None.
MessageType	MessageTypes	None.
Files	Collection of FileModel	None.
FilesXml	string	None.
SenderName	string	None.
ReceiverName	string	None.
ChannelName	string	None.
IsPinned	boolean	None.
IsStarred	boolean	None.
IsRead	boolean	None.
PinnedByUserId	globally unique identifier	None.
ReactedByUserId	globally unique identifier	None.
ReportMessage	string	None.
TaggedMembers	Collection of globally unique identifier	None.
TaggedMembersIds	string	None.
ParentMessageId	globally unique identifier	None.
FromUserId	globally unique identifier	None.
IsChannel	boolean	None.
IsGroupChat	boolean	None.
IsArchieved	boolean	None.
SharedMessage	SharedMessageModel	None.
SharedMessageId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "954626dc-8b51-4391-b1d0-85367c2e99b8",
  "ChannelId": "45a31b98-8125-46b5-8223-7cf4cb86f53e",
  "SenderId": "47e57eaf-22d9-443b-844b-a26ddef7515f",
  "ReceiverId": "2599758b-ccd8-4c4f-8456-1d846725b878",
  "Message": "sample string 2",
  "IsDeleted": true,
  "IsEdited": true,
  "MessageDateTime": "2025-04-04T02:52:23.9501738+01:00",
  "UpdatedDateTime": "2025-04-04T02:52:23.9501738+01:00",
  "MessageType": 1,
  "Files": [
    {
      "FilePath": "sample string 1",
      "FileName": "sample string 2"
    },
    {
      "FilePath": "sample string 1",
      "FileName": "sample string 2"
    }
  ],
  "FilesXml": "sample string 3",
  "SenderName": "sample string 4",
  "ReceiverName": "sample string 5",
  "ChannelName": "sample string 6",
  "IsPinned": true,
  "IsStarred": true,
  "IsRead": true,
  "PinnedByUserId": "ed0cee60-b60d-4686-bd9f-07a47732968d",
  "ReactedByUserId": "9ef73772-e2f0-457b-8669-bf805891776b",
  "ReportMessage": "sample string 7",
  "TaggedMembers": [
    "fb84f66b-7783-4978-91ef-448885089be0",
    "51f7700e-a007-42f0-8460-36a376b19139"
  ],
  "TaggedMembersIds": "sample string 8",
  "ParentMessageId": "e4aff2ff-c466-4866-91f1-f375326fcb3a",
  "FromUserId": "dcff96af-8938-45d4-a517-a48a3b69aaa3",
  "IsChannel": true,
  "IsGroupChat": true,
  "IsArchieved": true,
  "SharedMessage": {
    "Id": "6b48fd5f-85c2-45ca-9536-787210081de8",
    "ChannelId": "6a4d9765-3094-4f29-8822-a300d4b93b71",
    "SenderId": "09ae0487-0e12-4906-b97a-1ded408a2751",
    "ReceiverId": "5b06a55e-ee6c-4dcd-a8b5-97868efee30a",
    "Message": "sample string 2",
    "MessageDateTime": "2025-04-04T02:52:23.9501738+01:00",
    "MessageType": 1,
    "Files": [
      {
        "FilePath": "sample string 1",
        "FileName": "sample string 2"
      },
      {
        "FilePath": "sample string 1",
        "FileName": "sample string 2"
      }
    ],
    "ReportMessage": "sample string 4",
    "TaggedMembers": [
      "26929fd8-9bef-4cd7-8ad5-d033d3c14594",
      "ba3c8311-b4d0-4192-b35a-cf33216a6e22"
    ],
    "ParentMessageId": "64605cdc-a197-4415-874c-1a095e748081"
  },
  "SharedMessageId": "c367b610-c53f-4c48-87a1-78fe4038fa32"
}

application/xml, text/xml

Sample:

<MessageUpsertInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communicator.Models.Messages">
  <ChannelId>45a31b98-8125-46b5-8223-7cf4cb86f53e</ChannelId>
  <ChannelName>sample string 6</ChannelName>
  <Files>
    <FileModel>
      <FileName>sample string 2</FileName>
      <FilePath>sample string 1</FilePath>
    </FileModel>
    <FileModel>
      <FileName>sample string 2</FileName>
      <FilePath>sample string 1</FilePath>
    </FileModel>
  </Files>
  <FilesXml>sample string 3</FilesXml>
  <FromUserId>dcff96af-8938-45d4-a517-a48a3b69aaa3</FromUserId>
  <Id>954626dc-8b51-4391-b1d0-85367c2e99b8</Id>
  <IsArchieved>true</IsArchieved>
  <IsDeleted>true</IsDeleted>
  <IsEdited>true</IsEdited>
  <IsGroupChat>true</IsGroupChat>
  <IsPinned>true</IsPinned>
  <IsRead>true</IsRead>
  <IsStarred>true</IsStarred>
  <Message>sample string 2</Message>
  <MessageDateTime>2025-04-04T02:52:23.9501738+01:00</MessageDateTime>
  <MessageType>Text</MessageType>
  <ParentMessageId>e4aff2ff-c466-4866-91f1-f375326fcb3a</ParentMessageId>
  <PinnedByUserId>ed0cee60-b60d-4686-bd9f-07a47732968d</PinnedByUserId>
  <ReactedByUserId>9ef73772-e2f0-457b-8669-bf805891776b</ReactedByUserId>
  <ReceiverId>2599758b-ccd8-4c4f-8456-1d846725b878</ReceiverId>
  <ReceiverName>sample string 5</ReceiverName>
  <ReportMessage>sample string 7</ReportMessage>
  <SenderId>47e57eaf-22d9-443b-844b-a26ddef7515f</SenderId>
  <SenderName>sample string 4</SenderName>
  <SharedMessage>
    <ChannelId>6a4d9765-3094-4f29-8822-a300d4b93b71</ChannelId>
    <Files>
      <FileModel>
        <FileName>sample string 2</FileName>
        <FilePath>sample string 1</FilePath>
      </FileModel>
      <FileModel>
        <FileName>sample string 2</FileName>
        <FilePath>sample string 1</FilePath>
      </FileModel>
    </Files>
    <Id>6b48fd5f-85c2-45ca-9536-787210081de8</Id>
    <Message>sample string 2</Message>
    <MessageDateTime>2025-04-04T02:52:23.9501738+01:00</MessageDateTime>
    <MessageType>Text</MessageType>
    <ParentMessageId>64605cdc-a197-4415-874c-1a095e748081</ParentMessageId>
    <ReceiverId>5b06a55e-ee6c-4dcd-a8b5-97868efee30a</ReceiverId>
    <ReportMessage>sample string 4</ReportMessage>
    <SenderId>09ae0487-0e12-4906-b97a-1ded408a2751</SenderId>
    <TaggedMembers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>26929fd8-9bef-4cd7-8ad5-d033d3c14594</d3p1:guid>
      <d3p1:guid>ba3c8311-b4d0-4192-b35a-cf33216a6e22</d3p1:guid>
    </TaggedMembers>
  </SharedMessage>
  <SharedMessageId>c367b610-c53f-4c48-87a1-78fe4038fa32</SharedMessageId>
  <TaggedMembers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>fb84f66b-7783-4978-91ef-448885089be0</d2p1:guid>
    <d2p1:guid>51f7700e-a007-42f0-8460-36a376b19139</d2p1:guid>
  </TaggedMembers>
  <TaggedMembersIds>sample string 8</TaggedMembersIds>
  <UpdatedDateTime>2025-04-04T02:52:23.9501738+01:00</UpdatedDateTime>
</MessageUpsertInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JsonResultOfCommunicatorJsonResult

Name	Type	Additional information
Content	CommunicatorJsonResult	None.
SerializerSettings	JsonSerializerSettings	None.
Encoding	Encoding	None.
Request	HttpRequestMessage	None.

Response Formats

application/json, text/json

Sample:

Sample not available.