Chat Thread - Update Chat Thread Properties

Служба:

Communication

Версия API:

2025-03-15

Обновляет свойства потока.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
chatThreadId	path	True	string	Идентификатор потока для обновления.
endpoint	path	True	string	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей ACS (Службы коммуникации Azure).

Текст запроса

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

Имя	Тип	Описание
metadata	object	Контекстные метаданные для потока. Метаданные состоят из пар name/value. Общий размер всех пар метаданных может составлять до 1 КБ.
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	Политика хранения данных для автоматического удаления.
topic	string	Раздел потока чата.

Ответы

Имя	Тип	Описание
204 No Content		Поток был успешно обновлен.
401 Unauthorized	CommunicationErrorResponse	Нет разрешения.
403 Forbidden	CommunicationErrorResponse	Запретный.
429 Too Many Requests	CommunicationErrorResponse	Слишком много запросов.
Other Status Codes	CommunicationErrorResponse	Служба недоступна.

Безопасность

Authorization

Маркер доступа пользователей ACS (Службы коммуникации Azure).

Тип: apiKey
В: header

Примеры

Update chat thread topic

Образец запроса

HTTP

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

{
  "topic": "Updated Thread Topic"
}

Пример ответа

Код состояния:

204

Код состояния:

401

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

Код состояния:

403

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

Код состояния:

429

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

Код состояния:

503

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

Определения

Имя	Описание
NoneRetentionPolicy	Политика хранения потоков отсутствует.
ThreadCreationDateRetentionPolicy	Политика хранения потоков на основе даты создания потока.
UpdateChatThreadRequest	Запрос полезных данных для обновления потока чата.

NoneRetentionPolicy

Object

Политика хранения потоков отсутствует.

Имя	Тип	Описание
kind	string: none	Тип политики хранения

ThreadCreationDateRetentionPolicy

Object

Политика хранения потоков на основе даты создания потока.

Имя	Тип	Описание
deleteThreadAfterDays	integer (int32)	Указывает, сколько дней после создания потока будет удалено.
kind	string: threadCreationDate	Тип политики хранения

UpdateChatThreadRequest

Object

Запрос полезных данных для обновления потока чата.

Имя	Тип	Описание
metadata	object	Контекстные метаданные для потока. Метаданные состоят из пар name/value. Общий размер всех пар метаданных может составлять до 1 КБ.
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	Политика хранения данных для автоматического удаления.
topic	string	Раздел потока чата.