Chat Thread - Get Chat Image

Service:

Communication

API Version:

2024-03-15-preview

Get an image by view type.

GET {endpoint}/chat/threads/{chatThreadId}/images/{imageId}/view/{imageViewType}?api-version=2024-03-15-preview

URI Parameters

Name	In	Required	Type	Description
chatThreadId	path	True	string	The thread id to which the message was sent.
endpoint	path	True	string	The endpoint of the Azure Communication resource.
imageId	path	True	string	The image id.
imageViewType	path	True	ImageViewType	The view type of image.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An ACS (Azure Communication Services) user access token.

Responses

Name	Type	Description
200 OK	string	Image binary data Media Types: "application/json", "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"
Other Status Codes	ErrorResponse	Error response describing why the operation failed. Media Types: "application/json", "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"

Security

Authorization

An ACS (Azure Communication Services) user access token.

Type: apiKey
In: header

Examples

Delete message

Sample Request

HTTP

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

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{binary}"

Definitions

Name	Description
Error	Error response information.
ErrorDetail	Error detail information.
ErrorResponse	Wrapper for error response to follow ARM guidelines.
ImageViewType	The view type of image.

Error

Error response information.

Name	Type	Description
code	string	Error code.
details	ErrorDetail[]	An array of error detail objects.
message	string	Error message.

ErrorDetail

Error detail information.

Name	Type	Description
code	string	Error code.
message	string	Error message.

ErrorResponse

Wrapper for error response to follow ARM guidelines.

Name	Type	Description
error	Error	The error response.

ImageViewType

The view type of image.

Name	Type	Description
original	string
small	string