chat: getAllRetainedMessages

[アーティクル]
10/02/2024

名前空間: microsoft.graph

1 対 1 のチャット、グループチャット、会議チャットなど、ユーザーが参加しているすべてのチャットから保持されているすべてのメッセージを取得します。

Microsoft Teams エクスポート API を使用してコンテンツをエクスポートする方法の詳細については、「Microsoft Teams エクスポート API でコンテンツをエクスポートする」を参照してください。

注:

この API では、 Teams のアイテム保持ポリシーを構成する必要があります。詳細については、「Microsoft Teams の保持ポリシー」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	サポートされていません。	サポートされていません。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
Application	Chat.Read.All	Chat.ReadWrite.All

HTTP 要求

GET /users/{id}/chats/getAllRetainedMessages

オプションのクエリパラメーター

次の例では、 model クエリパラメーターを A または B の値と共に使用して、推奨されるライセンスと支払いモデルを選択する方法を示します。支払いモデルを指定しない場合、評価モードは既定で使用されます。

GET /users/{id}/chats/getAllRetainedMessages?model=A
GET /users/{id}/chats/getAllRetainedMessages?model=B

このメソッドは、応答のカスタマイズに役立つ次の OData クエリパラメーターをサポートします。一般的な情報については、「OData クエリパラメーター」を参照してください。

名前	説明
$filter	$filter クエリパラメーターは、日付範囲パラメーターを使用して lastModifiedDateTime プロパティの日付と時刻範囲のクエリをサポートします。
$top	$top クエリパラメーターを使用して、応答あたりの項目数を制御します。

次の例は、 $top と $filter クエリパラメーターを使用して、保持されているチャットメッセージの一覧を取得する要求を示しています。

GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z

次の表に、 $filter パラメーターの使用方法を示す例を示します。

シナリオ	`$filter` パラメーター	使用可能な値
ユーザー ID の種類によって送信されたメッセージを取得する	$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}'	`aadUser`, `onPremiseAadUser`, `anonymousGuest`, `federatedUser`, `personalMicrosoftAccountUser`, `skypeUser`, `phoneUser`
アプリケーションの種類によって送信されるメッセージを取得する	$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}'	`aadApplication`, `bot`, `tenantBot`, `office365Connector`, `outgoingWebhook`
ユーザー ID によって送信されたメッセージを取得する	$filter=from/user/id eq '{oid}'
制御 (システムイベント) メッセージを取得する	$filter=messageType eq 'systemEventMessage'
制御 (システムイベント) メッセージを除外する	$filter=messageType ne 'systemEventMessage'

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

このメソッドは、成功すると 200 OK 応答コードと chatMessage オブジェクトのコレクションを応答本文で返します。

例

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Chats.GetAllRetainedMessages.GetAsGetAllRetainedMessagesGetResponseAsync();



mgc users chats get-all-retained-messages get --user-id {user-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
getAllRetainedMessages, err := graphClient.Users().ByUserId("user-id").Chats().GetAllRetainedMessages().GetAsGetAllRetainedMessagesGetResponse(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.users().byUserId("{user-id}").chats().getAllRetainedMessages().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let getAllRetainedMessages = await client.api('/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->users()->byUserId('user-id')->chats()->getAllRetainedMessages()->get()->wait();


Import-Module Microsoft.Graph.Users.Functions

Get-MgUserChatRetainedMessage -UserId $userId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.users.by_user_id('user-id').chats.get_all_retained_messages.get()

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(chatMessage)",
  "@odata.count": 10,
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages?$skip=10",
  "value": [
    {
      "@odata.type": "#microsoft.graph.chatMessage",
      "id": "1600457965467",
      "replyToId": null,
      "etag": "1600457965467",
      "messageType": "message",
      "createdDateTime": "2020-09-18T19:39:25.467Z",
      "lastModifiedDateTime": "2020-09-18T19:39:25.467Z",
      "lastEditedDateTime": null,
      "deletedDateTime": null,
      "subject": null,
      "summary": null,
      "chatId": "19:0de69e5e-2da8-4cf2-821f-5e6585b2c65b_5c64e248-3269-4268-a36e-0f80314e9c39@unq.gbl.spaces",
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "channelIdentity": null,
      "policyViolation": null,
      "eventDetail": null,
      "from": {
        "application": null,
        "device": null,
        "conversation": null,
        "user": {
          "id": "0de69e5e-2da8-4cf2-821f-5e6585b2c65b",
          "displayName": "Richard Wilson",
          "userIdentityType": "aadUser"
        }
      },
      "body": {
        "contentType": "html",
        "content": "<div>\n<blockquote itemscope=\"\" itemtype=\"http://schema.skype.com/Reply\" itemid=\"1600457867820\">\n<strong itemprop=\"mri\" itemid=\"8:orgid:0de69e5e-2da8-4cf2-821f-5e6585b2c65b\">Richard Wilson</strong><span itemprop=\"time\" itemid=\"1600457867820\"></span>\n<p itemprop=\"preview\">1237</p>\n</blockquote>\n<p>this is a reply</p>\n</div>"
      },
      "attachments": [],
      "mentions": [],
      "reactions": []
    }
  ]
}

Microsoft Graph サービス固有の調整制限

次の方法で共有

chat: getAllRetainedMessages

アクセス許可

HTTP 要求

オプションのクエリパラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

次の方法で共有

chat: getAllRetainedMessages

アクセス許可

HTTP 要求

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

例

要求

応答

関連コンテンツ

フィードバック

その他のリソース

オプションのクエリパラメーター