Chat Thread - Remove Chat Participant

참조

Service:: Communication

API Version:: 2024-03-15-preview

스레드에서 참가자를 제거합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
chatThreadId	path	True	string	참가자를 제거할 스레드 ID입니다.
endpoint	path	True	string	Azure Communication 리소스의 엔드포인트입니다.
api-version	query	True	string	호출할 API의 버전입니다.

요청 헤더

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

Name	필수	형식	Description
Authorization	True	string	ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

요청 본문

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

Name	형식	Description
participantCommunicationIdentifier	CommunicationIdentifierModel	스레드에서 제거할 스레드 참가자의 ID입니다.

응답

Name	형식	Description
204 No Content		요청이 성공했습니다.
401 Unauthorized	CommunicationErrorResponse	권한이 없습니다.
403 Forbidden	CommunicationErrorResponse	사용할 수 없습니다.
429 Too Many Requests	CommunicationErrorResponse	요청이 너무 많습니다.
Other Status Codes	CommunicationErrorResponse	서비스를 사용할 수 없습니다.

보안

Authorization

ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

Type: apiKey
In: header

예제

Remove participant

Sample Request

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

Sample Response

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

다음을 통해 공유