1. REST API for Collaboration
  2. Tasks
  3. Collaboration

Get all top-level messages of the specified conversation.

get

/social/api/v1/conversations/{conversationID}/messages

Request

Supported Media Types
Path Parameters
Body ()
Specify a filter to query.
Root Schema : XV1MessageFilterInfo
Type: object
V1 Message Filter Information.
Show Source
Nested Schema : moderationStateFilter
Type: array
Limit to the following Moderation states.
Show Source
Nested Schema : XV1MessageModerationFilterState
Type: object
Show Source
  • Allowed Values: [ "APPROVED", "DRAFT", "REJECTED" ]
    V1 Message Moderation Filter States.

Response

Supported Media Types

200 Response

Successful operation.
Body ()
V1 Message List Information DTO.
Root Schema : XV1MessageListInfo
Type: object
V1 Message List Information DTO.
Show Source
Nested Schema : items
Type: array
The messages being returned. Note that messages are returned starting from the tail of the conversation (newest first).
Show Source
Nested Schema : XV1MessageInfo
Type: object
V1 Message Information DTO.
Show Source
Nested Schema : comments
Type: array
The comments on this message.
Show Source
Nested Schema : XV1MessageModerationState
Type: object
Show Source
  • Allowed Values: [ "APPROVED", "DRAFT", "REJECTED", "REPLACED" ]
    V1 Moderation state of messages in a conversation.
Nested Schema : XV1MessageType
Type: object
Show Source
  • Allowed Values: [ "SYSTEM_ANNOTATION_CLOSED", "SYSTEM_ANNOTATION_OPENED", "SYSTEM_ARTIFACT_COPIED", "SYSTEM_ARTIFACT_CREATED", "SYSTEM_ARTIFACT_NAME_CHANGED", "SYSTEM_ARTIFACT_STATE_CHANGED", "SYSTEM_CONVERSATION_ATTRIBUTES_CHANGED", "SYSTEM_CONVERSATION_DISCOVERABLE_CHANGED", "SYSTEM_CONVERSATION_FORKED_NEXT", "SYSTEM_CONVERSATION_FORKED_PREVIOUS", "SYSTEM_CONVERSATION_MEMBERSHIP_CHANGED", "SYSTEM_CONVERSATION_NAME_CHANGED", "SYSTEM_CONVERSATION_STATE_CLOSED_CHAINED", "SYSTEM_CONVERSATION_STATE_CLOSED_DISABLED", "SYSTEM_CONVERSATION_STATE_CLOSED_DROPPED", "SYSTEM_CONVERSATION_STATE_CLOSED_RESOLVED", "SYSTEM_CONVERSATION_STATE_OPEN_ACTIVE", "SYSTEM_CONVERSATION_TYPE_FIELDS_CHANGED", "SYSTEM_GENERIC", "SYSTEM_RTC_CONFERENCE", "SYSTEM_RTC_CONFERENCE_RECORDING_AVAILABLE", "SYSTEM_UPLOAD_GROUP", "SYSTEM_VERSION_ADDED", "SYSTEM_WIDGET", "SYSTEM_WIDGET_CREATED", "SYSTEM_WIDGET_REMOVED", "USER_ANNOTATION", "USER_ANNOTATION_GROUP", "USER_CHAT", "WEBHOOK_CHAT" ]
    V1 Message Types.

Examples

The following example shows how to get all top-level messages of the specified conversation by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:b97554e5a31e50a734899ee4f79218bd' -H 'Content-Type: application/json' 'https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/2206/messages'

The following example includes a query filter.

curl -X GET -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:b97554e5a31e50a734899ee4f79218bd' -H 'Content-Type: application/json' 'https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/2206/messages?filter={"excludeMembershipMessages":true}'

Example of Response Body

The following shows an example of the response JSON document.

{
  "hasMore" : false,
  "items" : 
  [
    {
      "id" : "24011",
      "objectType" : "waggle/chat",
      "createdByID" : "11001",
      "createdByUserName" : "jeff.pringle@example.com",
      "createdByUserDisplayName" : "jeff.pringle@example.com",
      "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
      "createdDate" : 1455326386743,
      "modifiedByID" : "11001",
      "modifiedByUserName" : "jeff.pringle@example.com",
      "modifiedByUserDisplayName" : "jeff.pringle@example.com",
      "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
      "modifiedDate" : 1455326386743,
      "isRemoved" : false,
      "url" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24011",
      "conversationURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006",
      "ordinal" : 1,
      "type" : "SYSTEM_CONVERSATION_STATE_OPEN_ACTIVE",
      "richText" : "The Conversation state changed to 'Open Active'.",
      "plainText" : "The Conversation state changed to 'Open Active'.",
      "version" : 1,
      "isSystem" : true,
      "nComments" : 0
    },
    {
      "id" : "24009",
      "objectType" : "waggle/chat",
      "createdByID" : "11001",
      "createdByUserName" : "jeff.pringle@example.com",
      "createdByUserDisplayName" : "jeff.pringle@example.com",
      "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
      "createdDate" : 1455326330859,
      "modifiedByID" : "11001",
      "modifiedByUserName" : "jeff.pringle@example.com",
      "modifiedByUserDisplayName" : "jeff.pringle@example.com",
      "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
      "modifiedDate" : 1455326330859,
      "isRemoved" : false,
      "url" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24009",
      "conversationURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006",
      "ordinal" : 0,
      "type" : "SYSTEM_CONVERSATION_STATE_CLOSED_RESOLVED",
      "richText" : "The Conversation state changed to 'Closed Resolved'.",
      "plainText" : "The Conversation state changed to 'Closed Resolved'.",
      "version" : 1,
      "isSystem" : true,
      "nComments" : 0
    }
  ]