Chat Thread - Add Chat Participants

Referenz

Dienst:: Communication

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

Fügt einem Thread Threadteilnehmer hinzu. Wenn bereits Teilnehmer vorhanden sind, erfolgt keine Änderung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	ID des Threads, dem Teilnehmer hinzugefügt werden sollen.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufzurufenden API.

Anforderungsheader

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
participants	True	ChatParticipant[]	Teilnehmer, die einem Chatthread hinzugefügt werden sollen.

Antworten

Name	Typ	Beschreibung
201 Created	AddChatParticipantsResult	Die Teilnehmer wurden erfolgreich hinzugefügt.
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

Add participants

Beispielanforderung

HTTP

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

{
  "participants": [
    {
      "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": "Alex",
      "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": "Peter",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
        }
      },
      "displayName": "Rama",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "invalidParticipants": [
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
      "code": "403",
      "message": "Permissions check failed"
    },
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
      "code": "404",
      "message": "Not found"
    }
  ]
}

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
AddChatParticipantsRequest	Teilnehmer, die dem Thread hinzugefügt werden sollen.
AddChatParticipantsResult	Ergebnis des Vorgangs zum Hinzufügen von Chatteilnehmern.
ChatParticipant	Ein Teilnehmer des Chatthreads.

AddChatParticipantsRequest

Teilnehmer, die dem Thread hinzugefügt werden sollen.

Name	Typ	Beschreibung
participants	ChatParticipant[]	Teilnehmer, die einem Chatthread hinzugefügt werden sollen.

AddChatParticipantsResult

Ergebnis des Vorgangs zum Hinzufügen von Chatteilnehmern.

Name	Typ	Beschreibung
invalidParticipants	CommunicationError[]	Die Teilnehmer, die dem Chatthread nicht hinzugefügt werden konnten.

ChatParticipant

Ein Teilnehmer des Chatthreads.

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

Freigeben über