機械翻訳について
  1. 会話のためのREST API
  2. タスク
  3. コラボレーション

指定した会話のすべての最上位レベル・メッセージを取得

get

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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
本文()
問合せ対象のフィルタを指定します。
ルート・スキーマ: XV1MessageFilterInfo
型: object
V1メッセージ・フィルタ情報。
ソースを表示
ネストされたスキーマ : moderationStateFilter
型: array
以下の節度状態に制限します。
ソースを表示
ネストされたスキーマ : XV1MessageModerationFilterState
型: object
ソースを表示
トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ: XV1MessageListInfo
型: object
V1メッセージ・リスト情報DTO。
ソースを表示
ネストされたスキーマ: items
型: array
返されるメッセージ。 メッセージは会話の最後尾から順に(最も新しいものが最初に)返されることに注意してください。
ソースを表示
ネストされたスキーマ: XV1MessageInfo
型: object
V1メッセージ情報DTO。
ソースを表示
ネストされたスキーマ: comments
型: array
このメッセージのコメント。
ソースを表示
ネストされたスキーマ : XV1MessageModerationState
型: object
ソースを表示
  • 許容値: [ "APPROVED", "DRAFT", "REJECTED", "REPLACED" ]
    V1会話内のメッセージのモデレーション状態。
ネストされたスキーマ: XV1MessageType
型: object
ソースを表示
  • 許容値: [ "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メッセージ・タイプ。
トップに戻る

例

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

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'

次の例には問合せフィルタが含まれています。

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}'

レスポンス本文の例

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

{
  "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
    }
  ]
先頭に戻る