Compartir a través de

Chat Thread - Remove Chat Participant

  • Referencia
Servicio:
Communication
Versión de la API:
2024-03-07

Quite un participante de un subproceso.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
chatThreadId
 path True

string

Identificador de subproceso del que se va a quitar el participante.
endpoint
 path True

string

Punto de conexión del recurso de Comunicación de Azure.
api-version
 query True

string

Versión de la API que se va a invocar.

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
Authorization True

string

Un token de acceso de usuario de ACS (Azure Communication Services).

Cuerpo de la solicitud

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

Nombre Tipo Description
participantCommunicationIdentifier

CommunicationIdentifierModel

Identificador del participante del subproceso que se va a quitar del subproceso.

Respuestas

Nombre Tipo Description
204 No Content

Solicitud correcta.
401 Unauthorized

CommunicationErrorResponse

Desautorizado.
403 Forbidden

CommunicationErrorResponse

Prohibido.
429 Too Many Requests

CommunicationErrorResponse

Demasiadas solicitudes.
Other Status Codes

CommunicationErrorResponse

Servicio no disponible.

Seguridad

Authorization

Un token de acceso de usuario de ACS (Azure Communication Services).

Tipo: apiKey
En: header

Ejemplos

Remove participant

Solicitud de ejemplo

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

Respuesta de muestra

status code:
204
status code:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
status code:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
status code:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
status code:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}