Chat Thread - Remove Chat Participant

Referenz

Dienst:: Communication

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

Entfernen Sie einen Teilnehmer aus einem Thread.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	Thread-ID, aus der der Teilnehmer entfernt werden soll.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufgerufenen API.

Anforderungsheader

Media Types: "application/json", "application/merge-patch+json"

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

Anforderungstext

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Beschreibung
participantCommunicationIdentifier	CommunicationIdentifierModel	Id des Threadteilnehmers, der aus dem Thread entfernt werden soll.

Antworten

Name	Typ	Beschreibung
204 No Content		Anforderung erfolgreich.
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

Remove participant

Beispielanforderung

HTTP

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

{
  "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"
  }
}

Beispiel für eine Antwort

Statuscode:: 204

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."
  }
}

Freigeben über