Chat Thread - List Chat Participants

Referenz

Dienst:: Communication

API-Version:: 2024-03-15-preview

Ruft die Teilnehmer eines Threads ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	Thread-ID, für die Teilnehmer abgerufen werden sollen.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufgerufenen API.
maxPageSize	query		integer int32	Die maximale Anzahl von Teilnehmern, die pro Seite zurückgegeben werden sollen.
skip	query		integer int32	Überspringt Teilnehmer bis zu einer angegebenen Position als Antwort.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS-Benutzerzugriffstoken (Azure Communication Services).

Antworten

Name	Typ	Beschreibung
200 OK	ChatParticipantsCollection	Anforderung erfolgreich. Die Aktion gibt die Teilnehmer eines Threads zurück.
401 Unauthorized	CommunicationErrorResponse	Nicht autorisiert.
403 Forbidden	CommunicationErrorResponse	Unzulässig.
429 Too Many Requests	CommunicationErrorResponse	Too many requests. (Zu viele Anforderungen.)
Other Status Codes	CommunicationErrorResponse	Service unavailable. (Dienst nicht verfügbar.)

Sicherheit

Authorization

Ein ACS-Benutzerzugriffstoken (Azure Communication Services).

Typ: apiKey
In: header

Beispiele

Get participants with pagination (max page size)

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 401

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

Statuscode:: 403

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

Statuscode:: 429

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

Statuscode:: 503

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

Definitionen

Name	Beschreibung
ChatParticipant	Ein Teilnehmer des Chatthreads.
ChatParticipantsCollection	Die Sammlung von Teilnehmern gehört zu einem bestimmten Thread.

ChatParticipant

Ein Teilnehmer des Chatthreads.

Name	Typ	Beschreibung
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Anzeigename für den Chatteilnehmer.
metadata	object	Kontextmetadaten für den Chatteilnehmer. Die Metadaten bestehen aus Name-Wert-Paaren. Die Gesamtgröße aller Metadatenpaare kann bis zu 1 KB groß sein.
shareHistoryTime	string	Zeit, ab der der Chatverlauf mit dem Teilnehmer geteilt wird. Der Zeitstempel hat RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.

ChatParticipantsCollection

Die Sammlung von Teilnehmern gehört zu einem bestimmten Thread.

Name	Typ	Beschreibung
nextLink	string	Wenn weitere Chatteilnehmer abgerufen werden können, wird der nächste Link aufgefüllt.
value	ChatParticipant[]	Chatteilnehmer.

Freigeben über