Share via

Chat Thread - List Chat Participants

  • リファレンス
Service:
Communication
API Version:
2024-03-15-preview

スレッドの参加者を取得します。

GET {endpoint}/chat/threads/{chatThreadId}/participants?api-version=2024-03-15-preview
With optional parameters: 
GET {endpoint}/chat/threads/{chatThreadId}/participants?maxPageSize={maxPageSize}&skip={skip}&api-version=2024-03-15-preview

URI パラメーター

名前 / 必須 型 説明
chatThreadId
 path True

string

参加者を取得するスレッド ID。
endpoint
 path True

string

Azure Communication リソースのエンドポイント。
api-version
 query True

string

呼び出す API のバージョン。
maxPageSize
 query

integer

int32

ページごとに返される参加者の最大数。
skip
 query

integer

int32

応答で指定した位置まで参加者をスキップします。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

ACS (Azure Communication Services) ユーザー アクセス トークン。

応答

名前 型 説明
200 OK

ChatParticipantsCollection

要求が成功しました。 アクションはスレッドの参加者を返します。
401 Unauthorized

CommunicationErrorResponse

権限がありません。
403 Forbidden

CommunicationErrorResponse

Forbidden.
429 Too Many Requests

CommunicationErrorResponse

要求が多すぎます。
Other Status Codes

CommunicationErrorResponse

Service unavailable. (サービス利用不可。)

セキュリティ

Authorization

ACS (Azure Communication Services) ユーザー アクセス トークン。

Type: apiKey
In: header

例

Get participants with pagination (max page size)

Sample Request

GET https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants?maxPageSize=2&api-version=2024-03-15-preview

Sample Response

Status code:
200 
{
  "value": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
        }
      },
      "displayName": "Jane",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
        }
      },
      "displayName": "Alex",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&maxPageSize=2&api-version=2024-03-15-preview"
}
Status code:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
Status code:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
Status code:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
Status code:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定義

名前 説明
ChatParticipant

チャット スレッドの参加者。
ChatParticipantsCollection

参加者のコレクションは、特定のスレッドに属します。

ChatParticipant

チャット スレッドの参加者。

名前 型 説明
communicationIdentifier

CommunicationIdentifierModel

displayName

string

チャット参加者の表示名。
metadata

object

チャット参加者のコンテキスト メタデータ。 メタデータは、名前と値のペアで構成されます。 すべてのメタデータ ペアの合計サイズは、最大 1 KB です。
shareHistoryTime

string

チャット履歴が参加者と共有される時間。 タイムスタンプは RFC3339 形式です。 yyyy-MM-ddTHH:mm:ssZ

ChatParticipantsCollection

参加者のコレクションは、特定のスレッドに属します。

名前 型 説明
nextLink

string

取得できるチャット参加者が増えた場合は、次のリンクが設定されます。
value

ChatParticipant[]

チャット参加者。