Chat Thread - Remove Chat Participant

Referência

Serviço:: Communication

Versão da API:: 2024-03-07

Remova um participante de um thread.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
chatThreadId	path	True	string	ID do thread da qual remover o participante.
endpoint	path	True	string	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).

Corpo da solicitação

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

Nome	Tipo	Description
participantCommunicationIdentifier	CommunicationIdentifierModel	ID do participante do thread a ser removido do thread.

Respostas

Nome	Tipo	Description
204 No Content		Solicitação bem-sucedida.
401 Unauthorized	CommunicationErrorResponse	Desautorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Muitas solicitações.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Remove participant

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 204

Código de status:: 401

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

Código de status:: 403

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

Código de status:: 429

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

Código de status:: 503

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

Compartilhar via