チームまたはチャット メンバーをフェッチするための Teams ボット API の変更

チャットまたはチームの 1 人以上のメンバーの情報を取得する場合は、Microsoft Teamsボット API(C# の場合はTeamsInfo.GetMembersAsync TypeScript または Node.js API のTeamsInfo.getMembers) を使用できます。 詳細については、「 名簿またはユーザー プロファイルをフェッチする」を参照してください。

これらの API には、次の欠点があります。

• 大規模なチームの場合、パフォーマンスが低下し、タイムアウトが発生する可能性が高くなります。Teams がリリースされてから、チームの最大サイズはかなり大きくなりました。 GetMembersAsyncまたはgetMembersはメンバー リスト全体を返すので、大規模なチームの API 呼び出しが返されるまでに長い時間がかかり、呼び出しがタイムアウトになるのは一般的であり、もう一度やり直す必要があります。
• 1 人のユーザーのプロファイルの詳細を取得するのは困難です。1 人のユーザーのプロファイル情報を取得するには、メンバー リスト全体を取得し、目的のユーザーを検索する必要があります。 Bot Framework SDK には、よりシンプルにするためにヘルパー関数がありますが、効率的ではありません。

組織全体のチームの導入により、これらの API を Microsoft 365 のプライバシー制御とより適切に連携させる必要があります。 大規模なチームで使用されるボットは、 User.ReadBasic.All Microsoft Graph アクセス許可と同様の基本的なプロファイル情報を取得できます。 テナント管理者は、テナントで使用できるアプリとボットを十分に制御できますが、これらの設定は Microsoft Graph とは異なります。

次のコードは、Teams ボット API によって返される内容のサンプル JSON 表現を提供します。

[{
    "id": "29:1GcS4EyB_oSI8A88XmWBN7NJFyMqe3QGnJdgLfFGkJnVelzRGos0bPbpsfJjcbAD22bmKc4GMbrY2g4JDrrA8vM06X1-cHHle4zOE6U4ttcc",
    "name": "Anon1 (Guest)",
    "tenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47",
 "userRole": "anonymous"
}, {
    "id": "29:1bSnHZ7Js2STWrgk6ScEErLk1Lp2zQuD5H2qQ960rtvstKp8tKLl-3r8b6DoW0QxZimuTxk_kupZ1DBMpvIQQUAZL-PNj0EORDvRZXy8kvWk",
    "objectId": "76b0b09f-d410-48fd-993e-84da521a597b",
    "givenName": "John",
    "surname": "Patterson",
    "email": "johnp@fabrikam.com",
    "userPrincipalName": "johnp@fabrikam.com",
    "tenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47",
 "userRole": "user"
}, {
    "id": "29:1URzNQM1x1PNMr1D7L5_lFe6qF6gEfAbkdG8_BUxOW2mTKryQqEZtBTqDt10-MghkzjYDuUj4KG6nvg5lFAyjOLiGJ4jzhb99WrnI7XKriCs",
    "objectId": "6b7b3b2a-2c4b-4175-8582-41c9e685c1b5",
    "givenName": "Rick",
    "surname": "Stevens",
    "email": "Rick.Stevens@fabrikam.com",
    "userPrincipalName": "rstevens@fabrikam.com",
    "tenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47",
 "userRole": "user"
}]

API の変更

今後の API の変更を次に示します。

• チャットまたはチームのメンバーのプロファイル情報を取得するための新しい API が TeamsInfo.GetPagedMembersAsync 作成されます。 この API は、Bot Framework バージョン 4.8 以降の SDK で使用できるようになりました。 その他のすべてのバージョンで開発する場合は、 GetConversationPagedMembers メソッドを使用します。

• 1 人のユーザーのプロファイル情報を取得するための TeamsInfo.GetMemberAsync 新しい API が作成されます。 これは、チームまたはチャットの ID と、userPrincipalNameされた UPN、Microsoft Entra オブジェクト ID objectId、または Teams ユーザー ID idをパラメーターとして受け取り、そのユーザーのプロファイル情報を返します。

  注:

  objectIdは、Bot Framework メッセージの Activity オブジェクトで呼び出されたものと一致するように、aadObjectIdに変更されます。 新しい API は、Bot Framework SDK のバージョン 4.8 以降で使用できます。 Teams SDK 拡張機能 Bot Framework 3.x でも使用できます。 一方、 REST エンドポイントを使用できます。

• TeamsInfo.GetMembersAsync C# では、TypeScript または Node.js の TeamsInfo.getMembers は正式に非推奨です。 新しい API が使用可能になったら、それを使用するようにボットを更新する必要があります。 これは、 これらの API が使用する基になる REST API にも適用されます。

• ボットは、チャットまたはチームのメンバーの userPrincipalName または email プロパティを事前に取得できません。 ボットは、Graph API を使用して必要な情報を取得する必要があります。 新しい GetConversationPagedMembers API は、 userPrincipalName プロパティと email プロパティを返すことはできません。

  注:

  Graph API とアクセス トークンを使用して情報を取得することをお勧めします。

関連項目

• Teams 用のボットを構築する
• Teams の使用の概要
• Bot Framework Connector サービスの API リファレンス