会話のためのREST API

機械翻訳について

指定した会話の新規最上位レベル・メッセージを作成

post

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

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

conversationID: integer(int64)

会話ID。オブジェクトのlong integer表現の一意識別子。

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ: XV1ConversationMessageCreateInfo

型: object

V1会話メッセージ作成情報。

ソースを表示

altitude(optional): number(double)

メッセージの高度。
externalID(optional): string

メッセージの外部ID。
latitude(optional): number(double)

メッセージの緯度。
longitude(optional): number(double)

メッセージの経度。
message(optional): string

メッセージ・テキスト。
widgetID(optional):

オブジェクトのlong integer表現の一意識別子。

{
    "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"
        }
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

操作の成功

ルート・スキーマ: XV1MessageInfo

型: object

V1メッセージ情報DTO。

ソースを表示

altitude(optional): number(double)

オブジェクトの高度。
collectionURL(optional): string(url)

コレクションを含むこのオブジェクトのURL。
comments(optional): array comments

このメッセージのコメント。
conversationURL(optional): string(url)

このオブジェクトに含まれる会話へのURL。
createdByID(optional):

オブジェクトのlong integer表現の一意識別子。
createdByURL(optional): string(url)

このオブジェクトを作成したユーザーへのURL。
createdByUserDisplayName(optional): string

このオブジェクトを作成したユーザーの表示名。
createdByUserName(optional): string

このオブジェクトを作成したユーザーの名前。
createdDate(optional): string(date)

このオブジェクトが作成された日付。
createdDateInISO8601Format(optional): string

このオブジェクトが作成された日付(ISO 8601書式)。
displayName(optional): string

このオブジェクトの表示名。
documentURL(optional): string(url)

このメッセージに関連付けられているドキュメントへのURL。
externalID(optional): string

このメッセージの外部ID。
folderURL(optional): string(url)

このメッセージに関連付けられているフォルダへのURL。
followupsURL(optional): string(url)

このメッセージのフォローアップへのURL。 nullも可。
formattedLocale(optional): string

このチャット・メッセージが指定したロケールに動的にフォーマットされた場合は、そのロケール。
id(optional):

オブジェクトのlong integer表現の一意識別子。
isRemoved(optional): boolean

このメッセージが削除された場合はTrue。
isSystem(optional): boolean

メッセージ・テキストがシステムによって生成された場合はTrue。
latitude(optional): number(double)

オブジェクトの緯度。
likesURL(optional): string(url)

このメッセージのLIKEへのURL。 nullも可。
longitude(optional): number(double)

オブジェクトの経度。
moderationState(optional): object XV1MessageModerationState
modifiedByID(optional):

オブジェクトのlong integer表現の一意識別子。
modifiedByURL(optional): string(url)

このオブジェクトを最後に変更したユーザーへのURL。
modifiedByUserDisplayName(optional): string

このオブジェクトを最後に変更したユーザーの表示名。
modifiedByUserName(optional): string

このオブジェクトを最後に変更したユーザーの名前。
modifiedDate(optional): string(date)

このオブジェクトが最後に変更された日付。
modifiedDateInISO8601Format(optional): string

このオブジェクトが最後に変更された日付(ISO 8601書式)。
name(optional): string

このオブジェクトの名前。
nComments(optional): integer(int32)

このメッセージへのコメントまたは返信の数。
objectType(optional): string

このオブジェクトのタイプ。
ordinal(optional): integer(int32)

このメッセージの序数。メッセージの序数は、会話内で一意のメッセージ番号であり、既読および未読範囲で使用できます。
parentID(optional):

オブジェクトのlong integer表現の一意識別子。
parentURL(optional): string(url)

{@code parentID}に対応する親へのURL。 nullも可。
plainText(optional): string

このメッセージのプレーン・テキスト・バージョン。
removedByID(optional):

オブジェクトのlong integer表現の一意識別子。
removedByURL(optional): string(url)

このオブジェクトを最後に削除したユーザーへのURL。
removedByUserDisplayName(optional): string

このオブジェクトを最後に削除したユーザーの表示名。
removedByUserName(optional): string

このオブジェクトを最後に削除したユーザーの名前。
removedDate(optional): string(date)

このオブジェクトが削除された日付。
removedDateInISO8601Format(optional): string

このオブジェクトが削除された日付(ISO 8601書式)。
richText(optional): string

このメッセージのリッチ・テキスト・バージョン。
socialObjectURL(optional): string(url)

このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
starsURL(optional): string(url)

このメッセージの星印へのURL。 nullも可。
type(optional): object XV1MessageType
url(optional): string(url)

このオブジェクトへのURL。
version(optional): integer(int32)

このメッセージのバージョン番号。

{
    "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"
        }
    }
}

ネストされたスキーマ: comments

型: array

このメッセージのコメント。

ソースを表示

Array of: object XV1MessageInfo

V1メッセージ情報DTO。

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

ネストされたスキーマ : XV1MessageModerationState

型: object

ソースを表示

field(optional): string

許容値: [ "APPROVED", "DRAFT", "REJECTED", "REPLACED" ]

V1会話内のメッセージのモデレーション状態。

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

ネストされたスキーマ: XV1MessageType

型: object

ソースを表示

field(optional): string

許容値: [ "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メッセージ・タイプ。

{
    "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"
            ]
        }
    }
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを送信し、指定した会話に新規最上位レベル・メッセージを作成する方法を示しています。

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

リクエスト本文の例

JSON形式のリクエスト・ドキュメントの例を次に示します。

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

レスポンス本文の例

レスポンスJSONドキュメントの例を次に示します。

{
  "id" : "24021",
  "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" : 1455328345045,
  "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" : 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"
}

先頭に戻る