チャット: getAllMessages
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
1対1のチャット、グループチャット、会議のチャットなど、ユーザーが参加しているすべての チャット から、すべてのメッセージを取得します。
メモ：これは、 と
model=B支払いモデルをサポートするmodel=A従量制課金 API です。 詳細については、「 支払いモデル」を参照してください。 クエリで支払いモデルを指定しない場合は、既定の 評価モード が使用されます。選択した支払いモデルによっては、ライセンスも必要になる場合があります。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | サポートされていません。 | サポートされていません。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| Application | Chat.Read.All | Chat.ReadWrite.All |
HTTP 要求
GET /users/{id | user-principal-name}/chats/getAllMessages
オプションのクエリ パラメーター
次の例で示すように、既定のライセンス モデルと支払いモデルに基づいて model クエリ パラメーターを使用できます。このパラメーターでは、A と B の値がサポートされています。
GET /users/{id | user-principal-name}/chats/getAllMessages?model=A
GET /users/{id | user-principal-name}/chats/getAllMessages?model=B
modelパラメーターが指定されていない場合は、 評価モードが使用されます。
このメソッドでは、次の例に示すように、応答をカスタマイズするための 日付範囲パラメーター もサポートされています。
GET /users/{id}/chats/getAllMessages?$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, ボット, tenantBot, office365Connector, outgoingWebhook |
| ユーザー ID によって送信されたメッセージを取得する | $filter=from/user/id eq '{oid}' | |
| control(system event) メッセージを取得する | $filter=messageType eq 'systemEventMessage' | |
| 制御 (システム イベント) メッセージを除外する | $filter=messageType ne 'systemEventMessage' |
メモ： これらのフィルター句は、 演算子を使用
orして結合できます。 フィルター句はクエリに複数回表示でき、クエリ内に表示されるたびに異なる値でフィルター処理できます。
要求ヘッダー
| ヘッダー | 値 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文で chatMessages のリストを返します。
例
要求
GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)",
"@odata.count":10,
"@odata.nextLink":"https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages?$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":[
]
}
]
}
関連コンテンツ
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示