GET /api/messages/:message_id

fetch a specific message

Success Response Code: 200

Params

Param name Description
message_id
optional

id of the message to fetch


Value: Must be a Integer
comments_limit
optional

limit the included comment api response details to the N most recent comments


Value: Must be a Integer
likes_limit
optional

limit the included message-like api response details to the N most relevant likes per message


Value: Must be a Integer
comment_likes_limit
optional

limit the included comment-like api response details to the N most relevant likes per comment


Value: Must be a Integer

Response Fields

id id of the message Integer
user the user who created the message User
title message's title String
body message's body String
action text to construct a sentence from the title (e.g. "asked a question") String
verb text to construct a sentence with the user's name (e.g. "User thanked") String
message_type a description of the type of message posted (e.g. "status_message", "chat") String
icon url for the icon image for this message_type String
url url to interact with this message String
permalink_url message's permalink page String
external_url external URL for shared links, bookmarks, etc. String
created_at time the message was created DateTime
updated_at time the message was last updated DateTime
likes likes attached to this message Array<Like>
likes_count number of likes for this message Integer
commentable can the current user create comments on this message Boolean
comments comments attached to this message Array<Comment>
comments_count number of comments for this message Integer
external_resources url links associated with this message, which can include oembed data. Array<ExternalResource>
extensions extensions associated with this message, which can include group, thanks, challenges, project or town_hall data Array<Extension>
recipients users and groups that are @ mentioned, or groups that are referenced by group_id Array<User or Group>
shareable can this message be shared. There are some restrictions on which messages can be shared based on message type and visibility. See shared_message_id parameter for create Message and Remark Boolean
share_count number of times the message has been shared publicly Integer
shared_message shared message referenced by this message. Contains all Message response fields except likes, comments, shared_message Hash
client_provided_guid the client-provided unique identifier for the message, if any. Used for duplicate detection/post aggregation etc. String

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/messages/426.json"

Examples

GET 
200
{
  "message": {
    "id": 5,
    "user": {
      "id": 46,
      "first_name": "J'øhn41",
      "last_name": "D'øe41",
      "name": "J'øhn41 D'øe41",
      "html_name": "J&#39;øhn41 D&#39;øe41",
      "url": "https://socialcast.socialcast.test/users/46-j%C3%B8hn41d%C3%B8e41",
      "avatars": {
        "is_system_default": true,
        "id": null,
        "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square16-3b951350d61d203ece2fa5dd274fa7bd35275e132c17310d9006514f8839c857.png",
        "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square30-6db66ac25c338d1e548a68465e2723ff63367c2aafbcc01db24c83964056b892.png",
        "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square45-16865426333e244c59076d4f2475b711ed1ff9d12c97f4cf354f373a0170a1fd.png",
        "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square70-1708999e8f1fea583408d7fc64b2177f853e4123bea2ffcf35f4839c8697e0ba.png",
        "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png"
      },
      "username": "Jøhn41Døe41",
      "active": true,
      "terminated": false,
      "inactive": false,
      "role": "member",
      "type": "User",
      "title": null,
      "out_of_office": false,
      "out_of_office_on": null,
      "back_in_office_on": null,
      "company_login": null
    },
    "title": "Socialcast Product Overview: Communication + Collaboration",
    "body": "http://www.youtube.com/watch?v=MjIyETGKvG0 @Jøhn42Døe42 @testgrøup12",
    "html_body": "<div class=\"markdown-body\"><p><a href=\"http://www.youtube.com/watch?v=MjIyETGKvG0\" title=\"http://www.youtube.com/watch?v=MjIyETGKvG0\">www.youtube.com/watch?v=MjIyETGKvG0</a> <a class=\"internal js-use-turbolink js-mention-user-47\" data-mention-type=\"User\" data-mini-profile=\"true\" data-tooltip-position=\"bottom_left\" data-tooltip-class=\"user_mini_profile\" data-user-id=\"47\" data-tooltip-url=\"/api/users/47-j%C3%B8hn42d%C3%B8e42.json\" href=\"https://socialcast.socialcast.test/users/47-j%C3%B8hn42d%C3%B8e42\" title=\"https://socialcast.socialcast.test/users/47-j%C3%B8hn42d%C3%B8e42\">@Jøhn42Døe42</a> <a class=\"internal js-use-turbolink\" href=\"https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12\" title=\"https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12\">@testgrøup12</a></p></div>",
    "action": "posted a link",
    "verb": null,
    "message_type": "link",
    "icon": null,
    "url": "https://socialcast.socialcast.test/api/messages/5",
    "permalink_url": "https://socialcast.socialcast.test/messages/5",
    "external_url": null,
    "created_at": "2017-04-23T03:15:26+00:00",
    "updated_at": "2017-04-23T03:15:34+00:00",
    "attachments": [],
    "media_files": [],
    "contains_url_only": null,
    "external_resources": [
      {
        "id": 1,
        "url": "http://www.youtube.com/watch?v=MjIyETGKvG0",
        "title": "Socialcast Product Overview: Communication + Collaboration",
        "description": null,
        "canonical_hashtag": null,
        "type": null,
        "source": {
          "name": "YouTube",
          "url": "http://www.youtube.com/"
        },
        "tags": [],
        "oembed": {
          "version": "1.0",
          "provider_name": "YouTube",
          "provider_url": "http://www.youtube.com/",
          "url": "http://www.youtube.com/watch?v=MjIyETGKvG0",
          "title": "Socialcast Product Overview: Communication + Collaboration",
          "type": "video",
          "thumbnail_url": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault_stream_square.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=dac389f00b7e5d4e13c8362fb885051107ddcfc2c987f46534f3ca3fcd92bfb6",
          "html": "<iframe width=\"480\" height=\"270\" src=\"http://www.youtube.com/embed/MjIyETGKvG0?feature=oembed\" frameborder=\"0\" allowfullscreen></iframe>",
          "width": 480,
          "height": 270,
          "thumbnail_width": 75,
          "thumbnail_height": 75,
          "author_url": "http://www.youtube.com/user/SocialcastByVMware",
          "author_name": "Socialcast Enterprise Social Networking",
          "description": null
        },
        "media_files": [
          {
            "id": 1,
            "canonical": true,
            "title": "Socialcast Product Overview: Communication + Collaboration",
            "description": null,
            "file_name": "hqdefault.jpg",
            "thumbnails": {
              "stream": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault_stream.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=a0eb45ef5980c37e3108e8154928f08c31dfb596875654cd5bfe73134d28656f",
              "stream_square": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault_stream_square.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=dac389f00b7e5d4e13c8362fb885051107ddcfc2c987f46534f3ca3fcd92bfb6",
              "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault_square45.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=ff79ead0dc8d59bef96f453804f5f2f1f8d89f4e481ccb6c5704a17bf66cebac",
              "scaled480": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault_scaled480.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=4a77cb71c8275d08068517d9fd97148a9255af99a8302daaad97f9a3256ede3e"
            },
            "thumbnail_metadata": {
              "stream": {
                "width": 50.0,
                "height": 64.0
              },
              "stream_square": {
                "width": 75.0,
                "height": 75.0
              },
              "square45": {
                "width": 45.0,
                "height": 45.0
              },
              "scaled480": {
                "width": 50.0,
                "height": 64.0
              }
            },
            "width": 50,
            "height": 64,
            "page_url": "http://www.youtube.com/watch?v=MjIyETGKvG0",
            "url": "https://s3.amazonaws.com/socialcast_test/tenants/1/media_files/1/hqdefault.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170420%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170420T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=9920d39e90f6e26b7896d7a4339eaa89887348a3ddda2f6482ec15954811ae0e",
            "content_type": "image/png",
            "attachment_id": null
          }
        ]
      }
    ],
    "tags": [],
    "last_interacted_at": 1492917326,
    "group": {
      "id": 21,
      "name": "test&grøup12",
      "html_name": "test&amp;grøup12",
      "url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12",
      "type": "Group",
      "avatars": {
        "is_system_default": true,
        "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square16-de52f6166f708e54b1b832ef06f92e409ae6b09976b4afc3dddbec820123214e.png",
        "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square30-c3483c74bd99384e67bb1c52a48b68e5e5ff04286e3abdbff3a228ee6f40d08b.png",
        "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square45-a31ef7e33bb699a3663623cd7c8244144c7779f6fb34757b1247bb720addbc32.png",
        "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square70-1886d205945147e3e2a37feb87db68bf29603fc508a049c5defa65a0c79e86cd.png",
        "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square140-3f77aeb71272a1df5c7c0e3a0141e91358b3654f9ff918f4974b77e230cab10e.png"
      },
      "username": "testgrøup12",
      "groupname": "testgrøup12",
      "private": false,
      "external_contributor": false,
      "chat_enabled": false,
      "post_enabled": true,
      "activity_url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12/messages_activity"
    },
    "category_id": null,
    "recipients": [
      {
        "id": 47,
        "first_name": "J'øhn42",
        "last_name": "D'øe42",
        "name": "J'øhn42 D'øe42",
        "html_name": "J&#39;øhn42 D&#39;øe42",
        "url": "https://socialcast.socialcast.test/users/47-j%C3%B8hn42d%C3%B8e42",
        "avatars": {
          "is_system_default": true,
          "id": null,
          "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square16-3b951350d61d203ece2fa5dd274fa7bd35275e132c17310d9006514f8839c857.png",
          "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square30-6db66ac25c338d1e548a68465e2723ff63367c2aafbcc01db24c83964056b892.png",
          "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square45-16865426333e244c59076d4f2475b711ed1ff9d12c97f4cf354f373a0170a1fd.png",
          "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square70-1708999e8f1fea583408d7fc64b2177f853e4123bea2ffcf35f4839c8697e0ba.png",
          "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png"
        },
        "username": "Jøhn42Døe42",
        "active": true,
        "terminated": false,
        "inactive": false,
        "role": "member",
        "type": "User",
        "title": null,
        "out_of_office": false,
        "out_of_office_on": null,
        "back_in_office_on": null,
        "company_login": null,
        "mention_name": "Jøhn42Døe42"
      },
      {
        "id": 21,
        "name": "test&grøup12",
        "html_name": "test&amp;grøup12",
        "url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12",
        "type": "Group",
        "avatars": {
          "is_system_default": true,
          "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square16-de52f6166f708e54b1b832ef06f92e409ae6b09976b4afc3dddbec820123214e.png",
          "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square30-c3483c74bd99384e67bb1c52a48b68e5e5ff04286e3abdbff3a228ee6f40d08b.png",
          "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square45-a31ef7e33bb699a3663623cd7c8244144c7779f6fb34757b1247bb720addbc32.png",
          "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square70-1886d205945147e3e2a37feb87db68bf29603fc508a049c5defa65a0c79e86cd.png",
          "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square140-3f77aeb71272a1df5c7c0e3a0141e91358b3654f9ff918f4974b77e230cab10e.png"
        },
        "username": "testgrøup12",
        "private": false,
        "external_contributor": false,
        "chat_enabled": false,
        "post_enabled": true,
        "activity_url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12/messages_activity",
        "mention_name": "testgrøup12"
      }
    ],
    "thumbnail_url": null,
    "player_url": null,
    "player_params": null,
    "likable": false,
    "ratable": false,
    "rating": null,
    "ratings_average": null,
    "ratings_count": null,
    "editable": true,
    "deletable": true,
    "watchable": false,
    "watch": null,
    "flag": null,
    "source": null,
    "poll": null,
    "embed": null,
    "hidden": null,
    "subscribed": null,
    "groups": [
      {
        "id": 21,
        "name": "test&grøup12",
        "html_name": "test&amp;grøup12",
        "url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12",
        "type": "Group",
        "avatars": {
          "is_system_default": true,
          "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square16-de52f6166f708e54b1b832ef06f92e409ae6b09976b4afc3dddbec820123214e.png",
          "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square30-c3483c74bd99384e67bb1c52a48b68e5e5ff04286e3abdbff3a228ee6f40d08b.png",
          "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square45-a31ef7e33bb699a3663623cd7c8244144c7779f6fb34757b1247bb720addbc32.png",
          "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square70-1886d205945147e3e2a37feb87db68bf29603fc508a049c5defa65a0c79e86cd.png",
          "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_group_square140-3f77aeb71272a1df5c7c0e3a0141e91358b3654f9ff918f4974b77e230cab10e.png"
        },
        "username": "testgrøup12",
        "groupname": "testgrøup12",
        "private": false,
        "external_contributor": false,
        "chat_enabled": false,
        "post_enabled": true,
        "activity_url": "https://socialcast.socialcast.test/groups/21-testgr%C3%B8up12/messages_activity"
      }
    ],
    "extensions": [],
    "new_group_id": null,
    "new_group_archived_at": null,
    "days_of_stickiness": 0,
    "sticky_for_current_user": false,
    "shareable": false,
    "share_count": 0,
    "client_provided_guid": null,
    "comments_count": 0,
    "comments": [],
    "likes": [],
    "likes_count": 0,
    "shared_message": null,
    "commentable": true
  }
}