Chat Thread - Update Chat Thread Properties

リファレンス

Service:: Communication

API Version:: 2024-03-15-preview

スレッドのプロパティをUpdatesします。

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

URI パラメーター

名前	/	必須	型	説明
chatThreadId	path	True	string	更新するスレッドの ID。
endpoint	path	True	string	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

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

名前	必須	型	説明
Authorization	True	string	ACS (Azure Communication Services) ユーザーアクセストークン。

要求本文

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

名前	型	説明
metadata	object	スレッドのコンテキストメタデータ。メタデータは、名前と値のペアで構成されます。すべてのメタデータペアの合計サイズは最大 1 KB です。
retentionPolicy	ChatRetentionPolicy: ThreadCreationDateRetentionPolicy NoneRetentionPolicy	自動削除のデータ保持ポリシー。
topic	string	チャットスレッドトピック。

応答

名前	型	説明
204 No Content		スレッドが正常に更新されました。
401 Unauthorized	CommunicationErrorResponse	権限がありません。
403 Forbidden	CommunicationErrorResponse	Forbidden.
429 Too Many Requests	CommunicationErrorResponse	要求が多すぎます。
Other Status Codes	CommunicationErrorResponse	Service unavailable. (サービス利用不可。)

セキュリティ

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

定義

名前	説明
NoneRetentionPolicy	スレッド保持ポリシーはありません。
ThreadCreationDateRetentionPolicy	スレッドの作成日に基づくスレッド保持ポリシー。
UpdateChatThreadRequest	チャットスレッドを更新するための要求ペイロード。

NoneRetentionPolicy

スレッド保持ポリシーはありません。

名前	型	説明
kind	string: none	アイテム保持ポリシーの種類

ThreadCreationDateRetentionPolicy

スレッドの作成日に基づくスレッド保持ポリシー。

名前	型	説明
deleteThreadAfterDays	integer	スレッドの作成から何日後にスレッドが削除されるかを示します。
kind	string: threadCreationDate	アイテム保持ポリシーの種類

UpdateChatThreadRequest

チャットスレッドを更新するための要求ペイロード。

名前	型	説明
metadata	object	スレッドのコンテキストメタデータ。メタデータは、名前と値のペアで構成されます。すべてのメタデータペアの合計サイズは最大 1 KB です。
retentionPolicy	ChatRetentionPolicy: NoneRetentionPolicy ThreadCreationDateRetentionPolicy	自動削除のデータ保持ポリシー。
topic	string	チャットスレッドトピック。

Share via