Chat Thread - Remove Chat Participant

Reference

Služba:: Communication

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

Odebrání účastníka z vlákna

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, ze které chcete účastníka odebrat.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

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

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

Text požadavku

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

Name	Typ	Description
participantCommunicationIdentifier	CommunicationIdentifierModel	ID účastníka vlákna, který má být odebrán z vlákna.

Odpovědi

Name	Typ	Description
204 No Content		Žádost byla úspěšná.
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

Remove participant

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 204

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

Sdílet prostřednictvím