POST Message/MessageApi/SendMessageToUserOrChannel
Request Information
URI Parameters
None.
Body Parameters
MessageUpsertInputModelName | 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. |
Request Formats
application/json, text/json
Sample:
{ "Id": "47336610-7cec-4437-b62c-51371e1397d2", "ChannelId": "f06ce346-19a7-47d5-a6c3-7b3a5f610463", "SenderId": "f7e54aaf-b9fd-4eb5-9690-7c57407d6f6b", "ReceiverId": "424740d2-e5db-49c9-9509-b6257c31bf1d", "Message": "sample string 2", "IsDeleted": true, "IsEdited": true, "MessageDateTime": "2024-09-19T09:43:22.1112856+01:00", "UpdatedDateTime": "2024-09-19T09:43:22.1112856+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": "6b5df829-9e40-4cd0-ae0c-98c3793b10b7", "ReactedByUserId": "b1b7eade-fabd-4e85-9d95-d174d7d01bb5", "ReportMessage": "sample string 7", "TaggedMembers": [ "d6204bc5-89d4-415c-8997-b4599d0be8ae", "0f7f5659-b94b-4fbc-b7b3-f40e4dcc00ab" ], "TaggedMembersIds": "sample string 8", "ParentMessageId": "e3218362-5096-48ac-a3b3-7f8e094d81ea", "FromUserId": "cb4a377a-a505-4a9f-b0e4-cefb20557c36", "IsChannel": true, "IsGroupChat": true, "IsArchieved": true, "SharedMessage": { "Id": "5b7e2f6f-fdab-46d9-9d57-20bef2dfb7f3", "ChannelId": "f54faa03-80df-4be8-8ed4-b1aa0a7103e7", "SenderId": "6eb2cea8-71c8-4113-a1dc-31a69f7c3ac5", "ReceiverId": "9dd6cf51-5d61-46f5-bce7-ab42a8012b8d", "Message": "sample string 2", "MessageDateTime": "2024-09-19T09:43:22.1112856+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": [ "b1f1c078-b225-4268-aa21-70289edb737c", "514192c6-a9aa-45b6-822e-e2d3cbaddc49" ], "ParentMessageId": "634bd29d-5ae7-4001-ae62-4987db97e417" }, "SharedMessageId": "cf06c214-2b82-42ef-a40b-56926f3933c6" }
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>f06ce346-19a7-47d5-a6c3-7b3a5f610463</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>cb4a377a-a505-4a9f-b0e4-cefb20557c36</FromUserId> <Id>47336610-7cec-4437-b62c-51371e1397d2</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>2024-09-19T09:43:22.1112856+01:00</MessageDateTime> <MessageType>Text</MessageType> <ParentMessageId>e3218362-5096-48ac-a3b3-7f8e094d81ea</ParentMessageId> <PinnedByUserId>6b5df829-9e40-4cd0-ae0c-98c3793b10b7</PinnedByUserId> <ReactedByUserId>b1b7eade-fabd-4e85-9d95-d174d7d01bb5</ReactedByUserId> <ReceiverId>424740d2-e5db-49c9-9509-b6257c31bf1d</ReceiverId> <ReceiverName>sample string 5</ReceiverName> <ReportMessage>sample string 7</ReportMessage> <SenderId>f7e54aaf-b9fd-4eb5-9690-7c57407d6f6b</SenderId> <SenderName>sample string 4</SenderName> <SharedMessage> <ChannelId>f54faa03-80df-4be8-8ed4-b1aa0a7103e7</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>5b7e2f6f-fdab-46d9-9d57-20bef2dfb7f3</Id> <Message>sample string 2</Message> <MessageDateTime>2024-09-19T09:43:22.1112856+01:00</MessageDateTime> <MessageType>Text</MessageType> <ParentMessageId>634bd29d-5ae7-4001-ae62-4987db97e417</ParentMessageId> <ReceiverId>9dd6cf51-5d61-46f5-bce7-ab42a8012b8d</ReceiverId> <ReportMessage>sample string 4</ReportMessage> <SenderId>6eb2cea8-71c8-4113-a1dc-31a69f7c3ac5</SenderId> <TaggedMembers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>b1f1c078-b225-4268-aa21-70289edb737c</d3p1:guid> <d3p1:guid>514192c6-a9aa-45b6-822e-e2d3cbaddc49</d3p1:guid> </TaggedMembers> </SharedMessage> <SharedMessageId>cf06c214-2b82-42ef-a40b-56926f3933c6</SharedMessageId> <TaggedMembers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>d6204bc5-89d4-415c-8997-b4599d0be8ae</d2p1:guid> <d2p1:guid>0f7f5659-b94b-4fbc-b7b3-f40e4dcc00ab</d2p1:guid> </TaggedMembers> <TaggedMembersIds>sample string 8</TaggedMembersIds> <UpdatedDateTime>2024-09-19T09:43:22.1112856+01:00</UpdatedDateTime> </MessageUpsertInputModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
JsonResultOfCommunicatorJsonResultName | 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.