Chat Thread - Update Chat Thread Properties

Tjänst:

Communication

API-version:

2025-03-15

Uppdaterar en tråds egenskaper.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatThreadId	path	True	string	ID:t för den tråd som ska uppdateras.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Begärandetext

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

Name	Typ	Description
metadata	object	Kontextuella metadata för tråden. Metadata består av namn/värde-par. Den totala storleken på alla metadatapar kan vara upp till 1 KB i storlek.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	Datakvarhållningsprincip för automatisk borttagning.
topic	string	Chatttrådsämne.

Svar

Name	Typ	Description
204 No Content		Tråden har uppdaterats.
401 Unauthorized	CommunicationErrorResponse	Otillåten.
403 Forbidden	CommunicationErrorResponse	Förbjuden.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Update chat thread topic

Exempelbegäran

HTTP

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

{
  "topic": "Updated Thread Topic"
}

Exempelsvar

Statuskod:

204

Statuskod:

401

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

Statuskod:

403

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

Statuskod:

429

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

Statuskod:

503

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

Definitioner

Name	Description
NoneRetentionPolicy	Ingen kvarhållningsprincip för tråd.
ThreadCreationDateRetentionPolicy	Trådkvarhållningsprincip baserat på datum då tråden skapades.
UpdateChatThreadRequest	Begär nyttolast för uppdatering av en chatttråd.

NoneRetentionPolicy

Objekt

Ingen kvarhållningsprincip för tråd.

Name	Typ	Description
kind	string: none	Typ av kvarhållningsprincip

ThreadCreationDateRetentionPolicy

Objekt

Trådkvarhållningsprincip baserat på datum då tråden skapades.

Name	Typ	Description
deleteThreadAfterDays	integer (int32)	Anger hur många dagar efter att tråden har skapats kommer tråden att tas bort.
kind	string: threadCreationDate	Typ av kvarhållningsprincip

UpdateChatThreadRequest

Objekt

Begär nyttolast för uppdatering av en chatttråd.

Name	Typ	Description
metadata	object	Kontextuella metadata för tråden. Metadata består av namn/värde-par. Den totala storleken på alla metadatapar kan vara upp till 1 KB i storlek.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Datakvarhållningsprincip för automatisk borttagning.
topic	string	Chatttrådsämne.