GET restapi/personal/instantmessages/settings/v2
Gets the settings for the instant message system. Boundaries for attachment size, max participants in a group thread etc.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
The settings that the current user has for instant messaging.
Itslearning.RestApi.Entities.InstantMessageSettingsV2| Name | Description | Type | Additional information |
|---|---|---|---|
| SignalRServiceVersion |
Determines which version of SignalR service is used. This varies by customer. |
Itslearning.RestApi.Entities.InstantMessageSignalRServiceVersion |
None. |
| MaxAttachmentFileSizeInBytes |
Gets the maximum file size in bytes an attachment can have. |
integer |
None. |
| MaxParticipantsInAMessageThread |
Gets the maximum participants in a message thread. |
integer |
None. |
| MaxParticipantsInAOneWayThread |
Gets the maximum participants in a one way thread. |
integer |
None. |
| IllegalFileExtensions |
Gets an array of illegal file extensions. Files with illegal file extensions are not allowed to upload as an attachment to a message. |
Collection of string |
None. |
| SignalRHubEndpoint |
The signalR endpoint for instant message system for the current user. This varies by customer |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SignalRServiceVersion": 0,
"MaxAttachmentFileSizeInBytes": 1,
"MaxParticipantsInAMessageThread": 2,
"MaxParticipantsInAOneWayThread": 3,
"IllegalFileExtensions": [
"sample string 1",
"sample string 2"
],
"SignalRHubEndpoint": "sample string 4"
}
application/xml, text/xml
Sample:
<InstantMessageSettingsV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
<IllegalFileExtensions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</IllegalFileExtensions>
<MaxAttachmentFileSizeInBytes>1</MaxAttachmentFileSizeInBytes>
<MaxParticipantsInAMessageThread>2</MaxParticipantsInAMessageThread>
<MaxParticipantsInAOneWayThread>3</MaxParticipantsInAOneWayThread>
<SignalRHubEndpoint>sample string 4</SignalRHubEndpoint>
<SignalRServiceVersion>V1</SignalRServiceVersion>
</InstantMessageSettingsV2>