Chat Thread - Update Chat Thread Properties

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-15-preview

Aktualizacje właściwości wątku.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku do zaktualizowania.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usługi ACS (Azure Communication Services).

Treść żądania

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

Nazwa	Typ	Opis
metadata	object	Kontekstowe metadane wątku. Metadane składają się z par nazwa/wartość. Całkowity rozmiar wszystkich par metadanych może wynosić do 1 KB.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	Zasady przechowywania danych do automatycznego usuwania.
topic	string	Temat wątku czatu.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Wątek został pomyślnie zaktualizowany.
401 Unauthorized	CommunicationErrorResponse	Brak autoryzacji.
403 Forbidden	CommunicationErrorResponse	Zakazane.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usługi ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Update chat thread topic

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 204

Kod stanu:: 401

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

Kod stanu:: 403

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

Kod stanu:: 429

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

Kod stanu:: 503

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

Definicje

Nazwa	Opis
NoneRetentionPolicy	Brak zasad przechowywania wątków.
ThreadCreationDateRetentionPolicy	Zasady przechowywania wątków oparte na dacie utworzenia wątku.
UpdateChatThreadRequest	Zażądaj ładunku w celu zaktualizowania wątku czatu.

NoneRetentionPolicy

Brak zasad przechowywania wątków.

Nazwa	Typ	Opis
kind	string: none	Typ zasad przechowywania

ThreadCreationDateRetentionPolicy

Zasady przechowywania wątków oparte na dacie utworzenia wątku.

Nazwa	Typ	Opis
deleteThreadAfterDays	integer	Wskazuje, ile dni po utworzeniu wątku wątku zostanie usunięty.
kind	string: threadCreationDate	Typ zasad przechowywania

UpdateChatThreadRequest

Zażądaj ładunku w celu zaktualizowania wątku czatu.

Nazwa	Typ	Opis
metadata	object	Kontekstowe metadane wątku. Metadane składają się z par nazwa/wartość. Całkowity rozmiar wszystkich par metadanych może wynosić do 1 KB.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Zasady przechowywania danych do automatycznego usuwania.
topic	string	Temat wątku czatu.

Udostępnij za pośrednictwem