Message Resource

A message is a generic container for content shared between people, a group, or a network.

Changelog

1.0.7

• Support for an array of recipients (write-context).

1.0.8

• Application EID (write-context).
• Localizable body for multi-language messages.

1.0.10

• Added appData property.

1.0.11

• Added bubble property.

1.0.16

• Added numAttachments and numLikes properties.
• Added _user.hasLiked and _user.hasRecentlyCommented properties.
• Added like and likes relation.

1.0.17

• Added embeds property.

1.0.18

• Added announcement message type.
• Added data property.
• Added event property.

1.0.19

• Added mentions property.

1.0.24

• Added file.hasSubfolders and file.path properties.

1.0.26

• Added numRecipients property.
• Added _user.permissions property.

1.1.14

• Added lastEditor relation, lastModified, lastEdited and status fields.
• Added htmlBody
• Added headerBackground

1.3

• Added superseeded property.

1.3.1

• Added _user.subscribed property.

1.3.6

• Added dimensions object for image files.

1.4

• Deprecated attachments relation for update type messages.
• Added numFiles property.
• Added files relation for update type messages.
• Added numImages property.
• Added images relation for update type messages.
• Added numVideos property.
• Added videos relation for update type messages.

1.5

• Renamed event property to announcement.
• Added event message type.
• Added event property.
• Added responderCounts property.

1.5.1

• Added cancel relation for event type messages.
• Added reinstate relation for event type messages.
• Added rsvp relation for event type messages.

1.5.6

• Added reason property to Bubble object.

1.6.6

• Added numVideoViews for file message type

Endpoints

• Create Message
• Retrieve Timeline
• Retrieve Messages Collection
• Rich News
• Attachments

Representations

JSON Properties

Event Properties (since 1.5)

Embedded URL Properties (since 1.0.17)

Mention Properties (since 1.0.19)

File Properties

Links

End-user Metadata (read-only)

Example - Update Message

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/messages/1234567890abcdef/"
        },
        "author": {
            "href": "/networks/fedcba0987654321/users/abcdef0123456789/"
        },
        "comments": {
            "href": "/networks/fedcba0987654321/messages/?parent=1234567890ABCDEF"
        },
        "videos": {
            "href": "/networks/fedcba0987654321/messages/0123456789fedcba/"
        },
        "files": [
            { "href": "/networks/fedcba0987654321/messages/a1b2c3d4e5f67890/" },
            { "href": "/networks/fedcba0987654321/messages/09876f5e4d3c2b1a/" }
        ],
        "recipient": {
            "type": "network",
            "href": "/networks/fedcba0987654321/"
        }
    },
    "_user": {
        "hasRecentlyCommented": true,
        "hasLiked": false
    },
    "EID": "1234567890abcdef",
    "body": "Hello world!",
    "created": "2013-04-12T17:10:10.123+01:00",
    "commentable": true,
    "messageType": "update",
    "numFiles": 2,
    "numVideos": 1
}

Example - Non-all-day Event

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/messages/1234567890abcdef/"
        }
    },
    "EID": "1234567890abcdef",
    "messageType": "event",
    "title": "Friday drinks",
    "htmlBody": "Cheers!",
    "event": {
        "allDay": false,
        "location": {
            "description": "Spiazzo"
        },
        "start": {
            "date": "2017-07-07",
            "time": "18:00",
            "timeZone": "Europe/Amsterdam",
            "timeZoneOffset": "+02:00"
        },
        "end": {
            "date": "2017-07-08",
            "time": "00:00",
            "timeZone": "Europe/Amsterdam",
            "timeZoneOffset": "+02:00"
        }
    }
    "created": "2017-06-27T13:03:51.123+02:00",
    "commentable": false
}

Example - comment with attachment

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/messages/1234567890abcdef/"
        },
        "attachments": [{
            "href": "/networks/fedcba0987654321/messages/a1b2c3d4e5f67890/"
        }],
        "author": {
            "href": "/networks/fedcba0987654321/users/abcdef0123456789/"
        },
        "parent": {
            "href": "/networks/fedcba0987654321/messages/0123456789fedcba/"
        },
        "recipient": {
            "type": "group",
            "href": "/networks/fedcba0987654321/groups/1234567890abcdef/"
        }
    },
    "_user": {
        "hasLiked": false
    },
    "EID": "1234567890abcdef",
    "body": "Check out my curriculum vitae",
    "created": "2013-04-12T17:10:10.123+01:00",
    "messageType": "comment",
    "numAttachments": 1
}

Example - file message

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/messages/a1b2c3d4e5f67890/"
        },
        "author": {
            "href": "/networks/fedcba0987654321/users/abcdef0123456789/"
        }
    },
    "EID": "a1b2c3d4e5f67890",
    "commentable": false,
    "created": "2013-04-12T21:41:15.123+01:00",
    "file": {
        "extension": "doc",
        "filename": "cv.doc",
        "mimeType": "application/msword",
        "name": "cv",
        "path": [
            { "name": "HR", "EID": "9876543210abcdef" },
            { "name": "Résumés", "EID": "abcdef0987654321" }
        ],
        "type": "document",
        "url": "http://vault.speakap.com/file/1234567890abcdef"
    },
    "messageType": "file",
    "type": "message"
}

Example - Announcement

{
    "_links": {
        "originator": {
            "href": "/networks/fedcba0987654321/users/a1b2c3d4e5f67890/"
        },
        "conversation": {
            "href": "/networks/fedcba0987654321/conversations/abcdef0123456789/"
        },
        "participants":  [{
            "href": "/networks/fedcba0987654321/users/1234567890abcdef/",
            "href": "/networks/fedcba0987654321/users/4567890abcdef123/"
        }]
    },
    "EID": "1234567890abcdef",
    "created": "2013-04-12T17:10:10.123+01:00",
    "event": "participant_joined",
    "messageType": "announcement"
}