Chat Thread - Upload Chat Image

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-15-preview

Przekaż obraz w wątku w imieniu użytkownika.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku, do którego należy przekazany obraz. (Tylko spotkanie w aplikacji Teams)
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Media Types: "application/octet-stream"

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika acS (Azure Communication Services).
image-filename		string	Nazwa pliku obrazu.

Treść żądania

Media Types: "application/octet-stream"

Nazwa	Typ	Opis
chatImageFile	string	Dane binarne obrazu, dozwolone formaty obrazów: jpeg, png, gif, heic, webp

Odpowiedzi

Nazwa	Typ	Opis
201 Created	UploadChatImageResult	Pomyślnie przekazano `Location` nagłówek zawiera adres URL nowo przekazanego obrazu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

Authorization

Token dostępu użytkownika acS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Upload Image

Przykładowe żądanie

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=="

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ChatAttachmentType	Typ załącznika.
Error	Informacje o odpowiedzi na błędy.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Otoka pod kątem odpowiedzi na błąd, aby postępować zgodnie z wytycznymi usługi ARM.
UploadChatImageResult	Ładunek wyniku do przekazywania obrazu.

ChatAttachmentType

Typ załącznika.

Nazwa	Typ	Opis
file	string
image	string

Error

Informacje o odpowiedzi na błędy.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorDetail[]	Tablica obiektów szczegółów błędów.
message	string	Komunikat o błędzie.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.

ErrorResponse

Otoka pod kątem odpowiedzi na błąd, aby postępować zgodnie z wytycznymi usługi ARM.

Nazwa	Typ	Opis
error	Error	Odpowiedź na błąd.

UploadChatImageResult

Ładunek wyniku do przekazywania obrazu.

Nazwa	Typ	Opis
attachmentType	ChatAttachmentType	Typ załącznika.
id	string	Identyfikator obrazu wygenerowanego przez serwer.
name	string	Nazwa zawierająca typ rozszerzenia pliku załącznika.

Udostępnij za pośrednictwem