Chat Thread - Update Chat Thread Properties

참조

Service:: Communication

API Version:: 2024-03-15-preview

스레드의 속성을 업데이트.

PATCH {endpoint}/chat/threads/{chatThreadId}?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/merge-patch+json"

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

요청 본문

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

Name	형식	Description
metadata	object	스레드에 대한 컨텍스트 메타데이터입니다. 메타데이터는 이름/값 쌍으로 구성됩니다. 모든 메타데이터 쌍의 총 크기는 최대 1KB일 수 있습니다.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	자동 삭제를 위한 데이터 보존 정책입니다.
topic	string	채팅 스레드 항목.

응답

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

예제

Update chat thread topic

Sample Request

HTTP

PATCH https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-15-preview

{
  "topic": "Updated Thread Topic"
}

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

정의

Name	Description
NoneRetentionPolicy	스레드 보존 정책이 없습니다.
ThreadCreationDateRetentionPolicy	스레드 생성 날짜를 기반으로 하는 스레드 보존 정책입니다.
UpdateChatThreadRequest	채팅 스레드를 업데이트하기 위한 페이로드를 요청합니다.

NoneRetentionPolicy

스레드 보존 정책이 없습니다.

Name	형식	Description
kind	string: none	보존 정책 유형

ThreadCreationDateRetentionPolicy

스레드 생성 날짜를 기반으로 하는 스레드 보존 정책입니다.

Name	형식	Description
deleteThreadAfterDays	integer	스레드를 만든 후 스레드가 삭제될 일 수를 나타냅니다.
kind	string: threadCreationDate	보존 정책 유형

UpdateChatThreadRequest

채팅 스레드를 업데이트하기 위한 페이로드를 요청합니다.

Name	형식	Description
metadata	object	스레드에 대한 컨텍스트 메타데이터입니다. 메타데이터는 이름/값 쌍으로 구성됩니다. 모든 메타데이터 쌍의 총 크기는 최대 1KB일 수 있습니다.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	자동 삭제를 위한 데이터 보존 정책입니다.
topic	string	채팅 스레드 항목.

다음을 통해 공유