Chat Thread - Remove Chat Participant

Ссылка

Служба:: Communication

Версия API:: 2024-03-07

Удалите участника из потока.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
chatThreadId	path	True	string	Идентификатор потока, из который удаляется участник.
endpoint	path	True	string	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей ACS (Службы коммуникации Azure).

Текст запроса

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

Имя	Тип	Описание
participantCommunicationIdentifier	CommunicationIdentifierModel	Идентификатор участника потока для удаления из потока.

Ответы

Имя	Тип	Описание
204 No Content		Запрос успешно выполнен.
401 Unauthorized	CommunicationErrorResponse	Несанкционированный.
403 Forbidden	CommunicationErrorResponse	Запретный.
429 Too Many Requests	CommunicationErrorResponse	Слишком много запросов.
Other Status Codes	CommunicationErrorResponse	Служба недоступна.

Безопасность

Authorization

Маркер доступа пользователей ACS (Службы коммуникации Azure).

Тип: apiKey
В: header

Примеры

Remove participant

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:: 204

Код состояния:: 401

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

Код состояния:: 403

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

Код состояния:: 429

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

Код состояния:: 503

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

Поделиться через