POST Message/MessageApi/SendMessageToUserOrChannel
Request Information
URI Parameters
None.
Body Parameters
MessageUpsertInputModel| Name | Description | 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. |
|
| StarredByUserId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "28a2ed66-192d-416d-b17c-0ad9a154cee3",
"ChannelId": "435a6620-3500-45ff-bb38-e3d4b1300f46",
"SenderId": "5b77fe61-7ac5-4d94-a7ea-22f88a9debbe",
"ReceiverId": "dcdaa7a9-0784-4f0d-975e-902ba1108b9a",
"Message": "sample string 2",
"IsDeleted": true,
"IsEdited": true,
"MessageDateTime": "2025-12-14T01:24:06.1749571+00:00",
"UpdatedDateTime": "2025-12-14T01:24:06.1749571+00:00",
"MessageType": 1,
"Files": [
{
"FilePath": "sample string 1",
"FileName": "sample string 2",
"FileDuration": "sample string 3"
},
{
"FilePath": "sample string 1",
"FileName": "sample string 2",
"FileDuration": "sample string 3"
}
],
"FilesXml": "sample string 3",
"SenderName": "sample string 4",
"ReceiverName": "sample string 5",
"ChannelName": "sample string 6",
"IsPinned": true,
"IsStarred": true,
"IsRead": true,
"PinnedByUserId": "cfb9ba03-9768-438a-95b5-3ec5d5751c0d",
"ReactedByUserId": "d1a64bcc-10c0-407c-b0d6-90a477b6feac",
"ReportMessage": "sample string 7",
"TaggedMembers": [
"021423fa-5ff0-4594-8f26-0392a36b0e83",
"1f27c5e0-bf21-41f2-bf8b-1e60f21c0387"
],
"TaggedMembersIds": "sample string 8",
"ParentMessageId": "9366f782-6693-46e8-8c73-fd48b72e032c",
"FromUserId": "8c141201-4e1d-4766-a4d2-1f5e816e38ea",
"IsChannel": true,
"IsGroupChat": true,
"IsArchieved": true,
"SharedMessage": {
"Id": "b3a7f425-bdc5-4f0a-8e9f-2d31798e4253",
"ChannelId": "ffe20022-134f-4af3-a30a-e0777aa59f66",
"SenderId": "c913321c-ef11-4e8a-b2bc-f6946bfbe3bc",
"ReceiverId": "7ca6dfca-3725-49e8-ae58-ddb6fe80910e",
"Message": "sample string 2",
"MessageDateTime": "2025-12-14T01:24:06.1749571+00:00",
"MessageType": 1,
"Files": [
{
"FilePath": "sample string 1",
"FileName": "sample string 2",
"FileDuration": "sample string 3"
},
{
"FilePath": "sample string 1",
"FileName": "sample string 2",
"FileDuration": "sample string 3"
}
],
"ReportMessage": "sample string 4",
"TaggedMembersList": [
{
"MemberId": "a32cd9c2-7dde-4cac-b571-aaf669f4699b",
"FullName": "sample string 2"
},
{
"MemberId": "a32cd9c2-7dde-4cac-b571-aaf669f4699b",
"FullName": "sample string 2"
}
],
"TaggedMembers": [
"738c9c28-d1ac-4377-9934-9c22a0bb3fcb",
"2239616c-4dcc-4063-b215-0b2b7309a1de"
],
"ParentMessageId": "7f3383d5-89ca-4eec-b8c7-68663b261f99",
"SenderName": "sample string 5"
},
"SharedMessageId": "ca61c498-69ba-45a4-a035-b30805dc2d89",
"StarredByUserId": "6b54f85e-27e1-4a7c-a142-eab636d068cf"
}
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>435a6620-3500-45ff-bb38-e3d4b1300f46</ChannelId>
<ChannelName>sample string 6</ChannelName>
<Files>
<FileModel>
<FileDuration>sample string 3</FileDuration>
<FileName>sample string 2</FileName>
<FilePath>sample string 1</FilePath>
</FileModel>
<FileModel>
<FileDuration>sample string 3</FileDuration>
<FileName>sample string 2</FileName>
<FilePath>sample string 1</FilePath>
</FileModel>
</Files>
<FilesXml>sample string 3</FilesXml>
<FromUserId>8c141201-4e1d-4766-a4d2-1f5e816e38ea</FromUserId>
<Id>28a2ed66-192d-416d-b17c-0ad9a154cee3</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-12-14T01:24:06.1749571+00:00</MessageDateTime>
<MessageType>Text</MessageType>
<ParentMessageId>9366f782-6693-46e8-8c73-fd48b72e032c</ParentMessageId>
<PinnedByUserId>cfb9ba03-9768-438a-95b5-3ec5d5751c0d</PinnedByUserId>
<ReactedByUserId>d1a64bcc-10c0-407c-b0d6-90a477b6feac</ReactedByUserId>
<ReceiverId>dcdaa7a9-0784-4f0d-975e-902ba1108b9a</ReceiverId>
<ReceiverName>sample string 5</ReceiverName>
<ReportMessage>sample string 7</ReportMessage>
<SenderId>5b77fe61-7ac5-4d94-a7ea-22f88a9debbe</SenderId>
<SenderName>sample string 4</SenderName>
<SharedMessage>
<ChannelId>ffe20022-134f-4af3-a30a-e0777aa59f66</ChannelId>
<Files>
<FileModel>
<FileDuration>sample string 3</FileDuration>
<FileName>sample string 2</FileName>
<FilePath>sample string 1</FilePath>
</FileModel>
<FileModel>
<FileDuration>sample string 3</FileDuration>
<FileName>sample string 2</FileName>
<FilePath>sample string 1</FilePath>
</FileModel>
</Files>
<Id>b3a7f425-bdc5-4f0a-8e9f-2d31798e4253</Id>
<Message>sample string 2</Message>
<MessageDateTime>2025-12-14T01:24:06.1749571+00:00</MessageDateTime>
<MessageType>Text</MessageType>
<ParentMessageId>7f3383d5-89ca-4eec-b8c7-68663b261f99</ParentMessageId>
<ReceiverId>7ca6dfca-3725-49e8-ae58-ddb6fe80910e</ReceiverId>
<ReportMessage>sample string 4</ReportMessage>
<SenderId>c913321c-ef11-4e8a-b2bc-f6946bfbe3bc</SenderId>
<SenderName>sample string 5</SenderName>
<TaggedMembers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>738c9c28-d1ac-4377-9934-9c22a0bb3fcb</d3p1:guid>
<d3p1:guid>2239616c-4dcc-4063-b215-0b2b7309a1de</d3p1:guid>
</TaggedMembers>
<TaggedMembersList>
<TaggedOutputModel>
<FullName>sample string 2</FullName>
<MemberId>a32cd9c2-7dde-4cac-b571-aaf669f4699b</MemberId>
</TaggedOutputModel>
<TaggedOutputModel>
<FullName>sample string 2</FullName>
<MemberId>a32cd9c2-7dde-4cac-b571-aaf669f4699b</MemberId>
</TaggedOutputModel>
</TaggedMembersList>
</SharedMessage>
<SharedMessageId>ca61c498-69ba-45a4-a035-b30805dc2d89</SharedMessageId>
<StarredByUserId>6b54f85e-27e1-4a7c-a142-eab636d068cf</StarredByUserId>
<TaggedMembers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>021423fa-5ff0-4594-8f26-0392a36b0e83</d2p1:guid>
<d2p1:guid>1f27c5e0-bf21-41f2-bf8b-1e60f21c0387</d2p1:guid>
</TaggedMembers>
<TaggedMembersIds>sample string 8</TaggedMembersIds>
<UpdatedDateTime>2025-12-14T01:24:06.1749571+00:00</UpdatedDateTime>
</MessageUpsertInputModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
JsonResultOfCommunicatorJsonResult| Name | Description | 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.