Communication Service
Create direct message
Creates and then returns a direct message. The participants in the direct message can be specified specified with
participantURI parameters. At least one valid participant must be specified and any invalid participants will be
ignored.
POST http://domain:port/application_context/api/core/v2/communications/dms
Response
| Type | Description |
|---|
| Response | the direct message created by this POST. |
Get all communications
GET http://domain:port/application_context/api/core/v2/communications?before=String&limit=int&onlyUnread=boolean&markAllRead=boolean
Query Parameters
| Name | Type | Description | Default Value |
|---|
| before | String | | "" |
| limit | int | | "25" |
| onlyUnread | boolean | | "false" |
| markAllRead | boolean | | "false" |
Get direct messages
Returns any direct messages that the currently authenticated user has been involved in. The returned messages are
returned in date ordering from the most recently active to the least most recently active.
GET http://domain:port/application_context/api/core/v2/communications/dms?before=String&limit=int
Query Parameters
| Name | Type | Description | Default Value |
|---|
| before | String | direct messages older than the date provided. For a limit of 5 then the first 5 direct messages
created before the provided date will be returned. The provided date is required to be formatted in
ISO 8601 format. | "" |
| limit | int | the highest number of direct messages which will be returned from this call. If there are fewer
direct messages available in the given time period, if either before or after is provided, than fewer messages
will be returned then the limit. | "25" |
Response
| Type | Description |
|---|
| EntityCollection | the collection of direct message the currently authenticated user has been involved in. |
Get mentions
GET http://domain:port/application_context/api/core/v2/communications/mentions?before=String&limit=int
Query Parameters
| Name | Type | Description | Default Value |
|---|
| before | String | | "" |
| limit | int | | "25" |
Get shares
GET http://domain:port/application_context/api/core/v2/communications/shares?before=String&limit=int
Query Parameters
| Name | Type | Description | Default Value |
|---|
| before | String | | "" |
| limit | int | | "25" |