Retrieve Messages Collection
CUSTOM-IMPORTANT
Apps have limited access to messages! Only the ones sent to the whole network are retrievable.
CUSTOM-ENDPOINT
GET https://api.speakap.io/networks/:eid/messages/
CUSTOM-AUTHORIZATION
Permissions: get_network_timeline, get_group_timelines
CUSTOM-REQUEST
- URI: /networks/{networkEID}/messages/
- Method: GET
- Content-Type: application/vnd.speakap.api-v1.8.2+json+hal
- Authentication: OAuth 2.0
Parameters
| Name | Type | Description |
|---|---|---|
| networkEID | EID | Network EID |
Filters
Besides the Timeline Collection filters, these are also supported:
| Name | Type | Description |
|---|---|---|
| date_since | datetime | Since 1.6.7 Excludes all messages older than this date offset |
| date_until | datetime | Since 1.6.7 Excludes all messages newer than this date offset |
| eid | EIDs | Returns only specific messages, see Multi-GET |
| file_type | string | Only the file type messages of the given type are returns |
| parent | EID | Filters all comments for a specific parent update |
| q | string | Filters all messages in a network matching the specified terms |
| type | string | Limits the collection to messages of a certain message type |
| status | string | draft or published: Returns the messages having one of these two statuses |
Sorting
| Name | Type | Description |
|---|---|---|
| created | datetime | Since 1.6.7 Order by the date of creation of a message |
Examples
The collection endpoint can be used to search for messages within a certain time frame and matching a query at the same time.
Let's say we're interested in all messages matching two buzzwords:
https://api.speakap.io/networks/1234567890abcdef/messages/abcdef0123456789/?q=Synergy%20AND%20Robust
As you can see the search query supports Apache Lucene's Query syntax!
Suppose we're only interested in last year's messages:
Depending on permissions the result would be "Messages sent to the entire network in 2017", "Messages sent to groups in 2017" or "Messages sent to both groups and the entire network in 2017".
Response
| Status | Data |
|---|---|
| 200 | Returns a collection of Message resources |
| 403 | Unauthorized: returns an Error object |