Chat Thread - List Chat Participants

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-15-preview

Získá účastníky vlákna.

GET {endpoint}/chat/threads/{chatThreadId}/participants?api-version=2024-03-15-preview

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, pro které chcete získat účastníky.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.
maxPageSize	query		integer int32	Maximální počet účastníků, kteří se mají vrátit na stránku.
skip	query		integer int32	Přeskočí účastníky až na zadanou pozici v odpovědi.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby ACS (Azure Communication Services).

Odpovědi

Name	Typ	Description
200 OK	ChatParticipantsCollection	Žádost byla úspěšná. Akce vrátí účastníky vlákna.
401 Unauthorized	CommunicationErrorResponse	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Typ: apiKey
V: header

Příklady

Get participants with pagination (max page size)

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Stavový kód:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Stavový kód:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Stavový kód:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Stavový kód:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definice

Name	Description
ChatParticipant	Účastník vlákna chatu.
ChatParticipantsCollection	Kolekce účastníků patří do konkrétního vlákna.

ChatParticipant

Účastník vlákna chatu.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Zobrazované jméno účastníka chatu
metadata	object	Kontextová metadata účastníka chatu. Metadata se skládají z párů název/hodnota. Celková velikost všech dvojic metadat může být až 1 kB.
shareHistoryTime	string	Čas, od kterého se historie chatu sdílí s účastníkem. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

ChatParticipantsCollection

Kolekce účastníků patří do konkrétního vlákna.

Name	Typ	Description
nextLink	string	Pokud je možné načíst více účastníků chatu, vyplní se další odkaz.
value	ChatParticipant[]	Účastníci chatu.

Sdílet prostřednictvím