Chat Thread - Update Chat Message

リファレンス

Service:: Communication

API Version:: 2024-03-15-preview

メッセージを更新します。

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

URI パラメーター

名前	/	必須	型	説明
chatMessageId	path	True	string	メッセージ ID。
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"

名前	型	説明
attachments	ChatAttachment[]	添付ファイルの配列
content	string	チャットメッセージの内容。
metadata	object	メッセージメタデータ。

応答

名前	型	説明
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 message content

Sample Request

HTTP

PATCH https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1591768249318?api-version=2024-03-15-preview

{
  "content": "Updated message content",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

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

定義

名前	説明
ChatAttachment	チャットメッセージの添付ファイル。現在、Teams 相互運用シナリオでのみサポートされています。
ChatAttachmentType	添付ファイルの種類。
UpdateChatMessageRequest	チャットメッセージを更新するためのペイロードを要求します。

ChatAttachment

チャットメッセージの添付ファイル。現在、Teams 相互運用シナリオでのみサポートされています。

名前	型	説明
attachmentType	ChatAttachmentType	添付ファイルの種類。
id	string	添付ファイルの ID
name	string	添付ファイルの内容の名前。
previewUrl	string	添付ファイルのプレビューをダウンロードできる URL
url	string	添付ファイルをダウンロードできる URL

ChatAttachmentType

添付ファイルの種類。

名前	型	説明
file	string
image	string

UpdateChatMessageRequest

チャットメッセージを更新するためのペイロードを要求します。

名前	型	説明
attachments	ChatAttachment[]	添付ファイルの配列
content	string	チャットメッセージの内容。
metadata	object	メッセージメタデータ。

Share via