Stream Operations - Get Media

Service:

Communication

API Version:

2024-02-01

Download the Media payload from a User to Business message.

GET {endpoint}/messages/streams/{id}?api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The communication resource, for example https://my-resource.communication.azure.com
id	path	True	string	The stream ID.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	file	The request has succeeded. Media Types: "application/octet-stream", "application/json" Headers x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Media Types: "application/octet-stream", "application/json" Headers x-ms-error-code: string

Security

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://communication.azure.com/.default

Authorization

Type: apiKey
In: header

Examples

Download media

Sample Request

HTTP

GET https://my-resource.communication.azure.com/messages/streams/d19e68ec-bdd6-4a50-8dfb-cbb1642df6ab?api-version=2024-02-01

Sample Response

Status code:

200

"<binary_media_data>"

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Azure.Core.Foundations.Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.