Chat Thread - Upload Chat Image

リファレンス

サービス:: Communication

API バージョン:: 2024-03-15-preview

ユーザーの代わりに、スレッドにイメージをアップロードします。

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

URI パラメーター

名前	/	必須	型	説明
chatThreadId	path	True	string	アップロードされたイメージが属するスレッド ID。 (Teams 会議のみ)
endpoint	path	True	string	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

Media Types: "application/octet-stream"

名前	必須	型	説明
Authorization	True	string	ACS (Azure Communication Services) ユーザーアクセストークン。
image-filename		string	イメージのファイル名。

要求本文

Media Types: "application/octet-stream"

名前	型	説明
chatImageFile	string	画像バイナリデータ、許可される画像形式: jpeg、png、gif、heic、webp

応答

名前	型	説明
201 Created	UploadChatImageResult	正常にアップロードされました。 `Location` ヘッダーには、新しくアップロードされたイメージの URL が含まれています。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

Authorization

ACS (Azure Communication Services) ユーザーアクセストークン。

型: apiKey
/: header

例

Upload Image

要求のサンプル

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images?api-version=2024-03-15-preview


"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVQYV2P4DwABAQEAWk1v8QAAAABJRU5ErkJggg=="

応答のサンプル

状態コード:: 201

Location: /chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433

{
  "id": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433",
  "attachmentType": "inlineImage",
  "name": "sample.png"
}

定義

名前	説明
ChatAttachmentType	添付ファイルの種類。
Error	エラー応答情報。
ErrorDetail	エラーの詳細情報。
ErrorResponse	ARM ガイドラインに従うエラー応答のラッパー。
UploadChatImageResult	画像をアップロードするための結果ペイロード。

ChatAttachmentType

添付ファイルの種類。

名前	型	説明
file	string
image	string

Error

エラー応答情報。

名前	型	説明
code	string	エラーコード。
details	ErrorDetail[]	エラー詳細オブジェクトの配列
message	string	エラーメッセージ。

ErrorDetail

エラーの詳細情報。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。

ErrorResponse

ARM ガイドラインに従うエラー応答のラッパー。

名前	型	説明
error	Error	エラー応答。

UploadChatImageResult

画像をアップロードするための結果ペイロード。

名前	型	説明
attachmentType	ChatAttachmentType	添付ファイルの種類。
id	string	サーバーによって生成されたイメージ ID。
name	string	添付ファイルのファイル拡張子の種類を含む名前。

次の方法で共有