Chat Thread - Update Chat Thread Properties

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-15-preview

Aktualizace vlastnosti vlákna.

PATCH {endpoint}/chat/threads/{chatThreadId}?api-version=2024-03-15-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, které se má aktualizovat.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby ACS (Azure Communication Services).

Text požadavku

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

Name	Typ	Description
metadata	object	Kontextová metadata pro vlákno. Metadata se skládají z párů název/hodnota. Celková velikost všech dvojic metadat může být až 1 kB.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	Zásady uchovávání dat pro automatické odstranění.
topic	string	Téma vlákna chatu.

Odpovědi

Name	Typ	Description
204 No Content		Vlákno bylo úspěšně aktualizováno.
401 Unauthorized	CommunicationErrorResponse	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Typ: apiKey
V: header

Příklady

Update chat thread topic

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 204

Stavový kód:: 401

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

Stavový kód:: 403

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

Stavový kód:: 429

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

Stavový kód:: 503

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

Definice

Name	Description
NoneRetentionPolicy	Žádné zásady uchovávání vláken.
ThreadCreationDateRetentionPolicy	Zásady uchovávání vláken založené na datu vytvoření vlákna
UpdateChatThreadRequest	Žádost o datovou část pro aktualizaci vlákna chatu

NoneRetentionPolicy

Žádné zásady uchovávání vláken.

Name	Typ	Description
kind	string: none	Typ zásad uchovávání informací

ThreadCreationDateRetentionPolicy

Zásady uchovávání vláken založené na datu vytvoření vlákna

Name	Typ	Description
deleteThreadAfterDays	integer	Určuje, kolik dní po vytvoření vlákna bude vlákno odstraněno.
kind	string: threadCreationDate	Typ zásad uchovávání informací

UpdateChatThreadRequest

Žádost o datovou část pro aktualizaci vlákna chatu

Name	Typ	Description
metadata	object	Kontextová metadata pro vlákno. Metadata se skládají z párů název/hodnota. Celková velikost všech dvojic metadat může být až 1 kB.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Zásady uchovávání dat pro automatické odstranění.
topic	string	Téma vlákna chatu.

Sdílet prostřednictvím