指定したユーザーの1対1の会話を取得
get
/social/api/v1/people/{firstPersonID}/chats/{secondPersonID}
1対1の会話が存在しない場合、このメソッドではこれを作成しません。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- firstPersonID: integer(int64)
1対1の会話における1番目のユーザーのID。 1番目と2番目の人のIDの順序は問題になりません。 オブジェクトのlong integer表現の一意識別子。
- secondPersonID: integer(int64)
1対1の会話における2番目のユーザーのID。 1番目と2番目の人のIDの順序は問題になりません。 オブジェクトのlong integer表現の一意識別子。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ: XV1ConversationInfo
型:
objectV1会話情報DTO。
Show Source
- allMembershipsURL(optional): string(url)
この会話の階層メンバーシップへのURL。
- altitude(optional): number(double)
オブジェクトの高度。
- archiveURL(optional): string(url)
この会話のアーカイブへのURL。
- collectionURL(optional): string(url)
コレクションを含むこのオブジェクトのURLです。
- 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書式)。
- dateFormatLocale(optional): string(locale)
この会話に適切な日付書式のロケール。
- discoverableID(optional):
オブジェクトのlong integer表現の一意識別子。
- displayName(optional): string
このオブジェクトの表示名。
- externalID(optional): string
この会話の主な外部ID。
- folderID(optional):
オブジェクトのlong integer表現の一意識別子。
- folderURL(optional): string(url)
この会話のルート・フォルダへのURL。
- gadgetsURL(optional): string(url)
この会話のガジェットへのURL。
- hasMembersLocked(optional): boolean
この会話のメンバーシップがロックされている場合はTrue。
- hierarchicalMembersInfo(optional): object XV1HierarchicalMembersInfo
V1階層メンバー情報DTO。
- id(optional):
オブジェクトのlong integer表現の一意識別子。
- isDisallowGuests(optional): boolean
この会話でゲスト・ユーザーが許可されていない場合はTrue。
- isDisallowOutsiders(optional): boolean
この会話で部外者ユーザーが許可されていない場合はTrue。
- isDiscoverable(optional): boolean
この会話が発見可能(public)であれば真。
- isExtendedAccessControl(optional): boolean
この会話が拡張アクセス制御を使用している場合はTrue。
- isMuted(optional): boolean
この会話が現在のユーザーにミュートされている場合はTrue。
- isNew(optional): boolean
現在のユーザーがこの会話に参加したことがない場合はTrue。
- isRemoved(optional): boolean
このメッセージが削除された場合はTrue。
- isScoped(optional): boolean
この会話のメンバーシップが別の会話によって範囲指定されている場合はTrue。
- isScoping(optional): boolean
これが範囲指定会話である場合はTrue。
- isScopingSame(optional): boolean
この会話が別の会話と同じメンバーシップになるように範囲指定されている場合はTrue。
- languageLocale(optional): string(locale)
この会話の言語ロケール。
- latitude(optional): number(double)
オブジェクトの緯度。
- likesURL(optional): string(url)
この会話のLIKEへのURL。
- longitude(optional): number(double)
オブジェクトの経度。
- membershipsURL(optional): string(url)
この会話のメンバーシップへのURL。
- membersURL(optional): string(url)
この会話のメンバーへのURL。
- messagesURL(optional): string(url)
この会話のメッセージへのURL。
- 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
このオブジェクトの名前。
- nChats(optional): integer(int32)
この会話のチャット数。(チャット数を減らしてチャット数を減らしたもの)
- nFollowups(optional): integer(int32)
会話のフォローアップの数。
- nMarkableChats(optional): integer(int32)
既読としてマークできるチャットの数。 (マーク可能の合計から削除されたマーク可能を差し引きます。 現在のユーザーに依存しません)。
- nOutsiders(optional): integer(int32)
部外者ユーザーの数。
- nUnread(optional): integer(int32)
現在のユーザーが既読としてマークできるチャットの数。
- objectType(optional): string
このオブジェクトのタイプ。
- originalPictureURL(optional): string(url)
元のピクチャのURL。
- profilePictureURL(optional): string(url)
プロファイル・ピクチャのURL (150×150ピクセル)。
- propertiesURL(optional): string(url)
この会話のプロパティへのURL。
- removedByID(optional):
オブジェクトのlong integer表現の一意識別子。
- removedByURL(optional): string(url)
このオブジェクトを最後に削除したユーザーへのURL。
- removedByUserDisplayName(optional): string
このオブジェクトを最後に削除したユーザーの表示名。
- removedByUserName(optional): string
このオブジェクトを最後に削除したユーザーの名前。
- removedDate(optional): string(date)
このオブジェクトが削除された日付。
- removedDateInISO8601Format(optional): string
このオブジェクトが削除された日付(ISO 8601書式)。
- role(optional): string
この会話での現在のユーザーのロール。
- scaledPictureURL(optional): string(url)
スケール調整済ピクチャのURL (44×44ピクセル)。
- secondaryExternalIDs(optional): array secondaryExternalIDs
この会話の2次外部ID。
- securityContextID(optional): string
この会話オブジェクトのセキュリティを規定するサービスのID。
- socialObjectURL(optional): string(url)
このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
- starsURL(optional): string(url)
この会話の星印へのURL。
- state(optional): object XV1ConversationState
- timeZone(optional): string(timezone)
この会話のタイムゾーン。
- url(optional): string(url)
このオブジェクトへのURL。
- userPropertiesURL(optional): string(url)
この会話のユーザー・プロパティへのURL。
- wallPostControl(optional): object XV1WallPostControlEnum
ネストされたスキーマ: XV1HierarchicalMembersInfo
型:
objectV1階層メンバー情報DTO。
Show Source
- conversationAlreadyExists(optional): boolean
operationTypeがCREATE_CONVERSATIONの場合、会話がすでに存在する場合はtrueに設定します。
- createdFolderIDs(optional): object XV1FolderIDListInfo
フォルダIDのリスト。
- ignoredMembers(optional): object XV1IgnoredMemberListInfo
無視されたメンバーのリスト。
- ignoredUsers(optional): object XV1IgnoredUserListInfo
無視されたユーザーのリスト。
- operationType(optional): object XV1HierarchicalMembersOperationType
- removedFolderIDs(optional): object XV1FolderIDListInfo
フォルダIDのリスト。
ネストされたスキーマ: XV1ConversationState
型:
Show Source
object- field(optional): string
許容値:
[ "CLOSED_CHAINED", "CLOSED_DISABLED", "CLOSED_DROPPED", "CLOSED_RESOLVED", "OPEN_ACTIVE" ]V1会話の状態。
ネストされたスキーマ: XV1WallPostControlEnum
型:
Show Source
object- field(optional): string
許容値:
[ "ANYONE_CAN_POST", "OWNER_ONLY_POSTS", "OWNER_TOP_LEVEL" ]V1壁掲示コントロール列挙体。
ネストされたスキーマ: XV1FolderIDListInfo
型:
objectフォルダIDのリスト。
Show Source
- hasMore(optional): boolean
trueの場合、他にも返すアイテムが存在します。
- ids(optional): array ids
フォルダIDのリスト。
- nextURL(optional): string(url)
リストの次のページのURL。 これが最後のページである場合はNull。
- previousURL(optional): string(url)
リストの前のページのURL。 これが最初のページである場合はNull。
- total(optional): integer(int32)
指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
ネストされたスキーマ : XV1IgnoredMemberListInfo
型:
object無視されたメンバーのリスト。
Show Source
- groups(optional): array groups
ユーザーのリスト。
- hasMore(optional): boolean
trueの場合、他にも返すアイテムが存在します。
- nextURL(optional): string(url)
リストの次のページのURL。 これが最後のページである場合はNull。
- previousURL(optional): string(url)
リストの前のページのURL。 これが最初のページである場合はNull。
- total(optional): integer(int32)
指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
- users(optional): array users
ユーザーのリスト。
ネストされたスキーマ: XV1IgnoredUserListInfo
型:
object無視されたユーザーのリスト。
Show Source
- hasMore(optional): boolean
trueの場合、他にも返すアイテムが存在します。
- nextURL(optional): string(url)
リストの次のページのURL。 これが最後のページである場合はNull。
- previousURL(optional): string(url)
リストの前のページのURL。 これが最初のページである場合はNull。
- total(optional): integer(int32)
指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
- users(optional): array users
ユーザーのリスト。
ネストされたスキーマ: XV1HierarchicalMembersOperationType
型:
Show Source
object- field(optional): string
許容値:
[ "ASSOCIATE_CONVERSATION", "CREATE_CONVERSATION", "MOVE_FILE", "MOVE_FOLDER", "MOVE_MEMBERS", "REMOVE_MEMBERS", "REMOVE_MEMBERS_OBJECT", "SHARE_FOLDER" ]階層ユーザーのV1ユーザーおよびグループAPI操作のタイプ。