Jump to

• Request
• Response
• Examples

Create a new top-level message in the specified conversation.

post

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

Request

Supported Media Types

• application/json

Path Parameters

• conversationID: integer(int64)
  The conversation ID. The object's unique identifier from a long integer representation.

Body ()

The request body defines the details of the request.

Root Schema : XV1ConversationMessageCreateInfo

Type: object

V1 Conversation Message Create Information.

Show Source

• altitude: number(double)
  The message altitude.
• externalID: string
  The message external ID.
• latitude: number(double)
  The message latitude.
• longitude: number(double)
  The message longitude.
• message: string
  The message text.
• widgetID:
  An object's unique identifier from a long integer representation.

{
    "description":"V1 Conversation Message Create Information.",
    "properties":{
        "altitude":{
            "description":"The message altitude.",
            "type":"number",
            "format":"double"
        },
        "externalID":{
            "description":"The message external ID.",
            "type":"string"
        },
        "latitude":{
            "description":"The message latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The message longitude.",
            "type":"number",
            "format":"double"
        },
        "message":{
            "description":"The message text.",
            "type":"string"
        },
        "widgetID":{
            "$ref":"#/definitions/XObjectID"
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Message Information DTO.

Root Schema : XV1MessageInfo

Type: object

V1 Message Information DTO.

Show Source

• altitude: number(double)
  The object's altitude.
• collectionURL: string(url)
  A URL to this object's containing collection.
• comments: array comments
  The comments on this message.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• displayName: string
  The display name of this object.
• documentURL: string(url)
  A URL to any associated document for this message.
• externalID: string
  The external ID for this message.
• folderURL: string(url)
  A URL to any associated folder for this message.
• followupsURL: string(url)
  A URL to followups on this message. Can be null.
• formattedLocale: string
  The locale, if this chat message was dynamically formatted to the specified locale.
• id:
  An object's unique identifier from a long integer representation.
• isRemoved: boolean
  True if this message has been removed.
• isSystem: boolean
  True when the message text was generated by the system.
• latitude: number(double)
  The object's latitude.
• likesURL: string(url)
  A URL to likes on this message. Can be null.
• longitude: number(double)
  The object's longitude.
• moderationState: object XV1MessageModerationState
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• nComments: integer(int32)
  The number of comments or replies to this message.
• objectType: string
  The type of this object.
• ordinal: integer(int32)
  The ordinal for this message. Message ordinals are numbers for messages that are unique within a conversation and can be used with read and unread ranges.
• parentID:
  An object's unique identifier from a long integer representation.
• parentURL: string(url)
  A URL to the parent corresponding to {@code parentID}. Can be null.
• plainText: string
  The plain-text version of this message.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• richText: string
  The rich-text version of this message.
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• starsURL: string(url)
  A URL to stars on this message. Can be null.
• type: object XV1MessageType
• url: string(url)
  A URL to this object.
• version: integer(int32)
  The version number of this message.

{
    "description":"V1 Message Information DTO.",
    "properties":{
        "comments":{
            "description":"The comments on this message.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1MessageInfo"
            }
        },
        "documentURL":{
            "description":"A URL to any associated document for this message.",
            "type":"string",
            "format":"url"
        },
        "externalID":{
            "description":"The external ID for this message.",
            "type":"string"
        },
        "folderURL":{
            "description":"A URL to any associated folder for this message.",
            "type":"string",
            "format":"url"
        },
        "followupsURL":{
            "description":"A URL to followups on this message. Can be null.",
            "type":"string",
            "format":"url"
        },
        "formattedLocale":{
            "description":"The locale, if this chat message was dynamically formatted to the  specified locale.",
            "type":"string"
        },
        "isSystem":{
            "description":"True when the message text was generated by the system.",
            "type":"boolean"
        },
        "likesURL":{
            "description":"A URL to likes on this message. Can be null.",
            "type":"string",
            "format":"url"
        },
        "moderationState":{
            "$ref":"#/definitions/XV1MessageModerationState"
        },
        "nComments":{
            "description":"The number of comments or replies to this message.",
            "type":"integer",
            "format":"int32"
        },
        "ordinal":{
            "description":"The ordinal for this message. Message ordinals are numbers for messages that are unique within a conversation and can be used with read and unread ranges.",
            "type":"integer",
            "format":"int32"
        },
        "parentID":{
            "$ref":"#/definitions/XObjectID"
        },
        "parentURL":{
            "description":"A URL to the parent corresponding to {@code parentID}. Can be null.",
            "type":"string",
            "format":"url"
        },
        "plainText":{
            "description":"The plain-text version of this message.",
            "type":"string"
        },
        "richText":{
            "description":"The rich-text version of this message.",
            "type":"string"
        },
        "starsURL":{
            "description":"A URL to stars on this message. Can be null.",
            "type":"string",
            "format":"url"
        },
        "type":{
            "$ref":"#/definitions/XV1MessageType"
        },
        "version":{
            "description":"The version number of this message.",
            "type":"integer",
            "format":"int32"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

Nested Schema : comments

Type: array

The comments on this message.

Show Source

• [0]: object XV1MessageInfo
  V1 Message Information DTO.

{
    "description":"The comments on this message.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1MessageInfo"
    }
}

Nested Schema : XV1MessageModerationState

Type: object

Show Source

• field: string
  Allowed Values: [ "APPROVED", "DRAFT", "REJECTED", "REPLACED" ]

  V1 Moderation state of messages in a conversation.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Moderation state of messages in a conversation.",
            "enum":[
                "APPROVED",
                "DRAFT",
                "REJECTED",
                "REPLACED"
            ]
        }
    }
}

Nested Schema : XV1MessageType

Type: object

Show Source

• field: string
  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.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Message Types.",
            "enum":[
                "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"
            ]
        }
    }
}

Examples

The following example shows how to create a new top-level message in the specified conversation by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -c mycookies.jar -b mycookies.jar -H 'X-Waggle-RandomID:b97554e5a31e50a734899ee4f79218bd' -H 'Content-Type: application/json' -d '{"message" : "New message goes here", "extrnalID" : "" }' https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006/messages

Example of Request Body

The following shows an example of the request document in JSON format.

{
  "message": "A new message goes here",
  "externalID": "oracle.psr.conv.ext0002AA ",
}

Example of Response Body

The following shows an example of the response JSON document.

{
  "id" : "24021",
  "objectType" : "waggle/chat",
  "createdByID" : "11001",
  "createdByUserName" : "[e-mail]",
  "createdByUserDisplayName" : "[e-mail]",
  "createdByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "createdDate" : 1455328345045,
  "modifiedByID" : "11001",
  "modifiedByUserName" : "[e-mail]",
  "modifiedByUserDisplayName" : "[e-mail]",
  "modifiedByURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/people/11001",
  "modifiedDate" : 1455328345045,
  "isRemoved" : false,
  "url" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24021",
  "conversationURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/conversations/22006",
  "ordinal" : 2,
  "type" : "USER_CHAT",
  "richText" : "New message goes here",
  "plainText" : "New message goes here",
  "version" : 1,
  "isSystem" : false,
  "nComments" : 0,
  "followupsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24021/followups",
  "likesURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24021/likes",
  "starsURL" : "https://socialnetwork06065-ustraveler15926.socialnetwork.dc1.c9dev1.example.com/osn/social/api/v1/messages/24021/stars"
}