Skip to content

Microsoft: Get attachments from users — users Message messages Get Attachments

Microsoft usersMessage.messagesGetAttachments: arguments, response, policy and SDK examples.

← Users message operations · Get started

Operation microsoft.users_messages_getattachments

Provider route: GET /users/{user-id}/messages/{message-id}/attachments/{attachment-id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";
async function execute(input: Parameters<MicrosoftIntegration["usersMessage"]["messagesGetAttachments"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.usersMessage.messagesGetAttachments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.users_message.messages_get_attachments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.user-idstringRequired within parent
path.message-idstringRequired within parent
path.attachment-idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.$selectarrayOptionalUnique items: true
query.$select[]stringEach item
query.$expandarrayOptionalUnique items: true
query.$expand[]stringEach item

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get attachment — response body

Referenced models: Get attachment — response body

1 more schema is linked from the tables above, on the schema pages.

Get attachment — response body
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants applydiscriminator: {"mapping": {}, "propertyName": "@odata.type"}
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).contentTypeJSONOptional
$ (allOf 2).contentType (anyOf 1)stringAlternativeThe MIME type.
$ (allOf 2).contentType (anyOf 2)nullAlternative
$ (allOf 2).isInlinebooleanOptionaltrue if the attachment is an inline attachment; otherwise, false.
$ (allOf 2).lastModifiedDateTimeJSONOptional
$ (allOf 2).lastModifiedDateTime (anyOf 1)stringAlternativeThe Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
Format: date-time
Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
$ (allOf 2).lastModifiedDateTime (anyOf 2)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe attachment's file name.
$ (allOf 2).name (anyOf 2)nullAlternative
$ (allOf 2).sizeJSONOptional
$ (allOf 2).size (anyOf 1)numberAlternativeThe length of the attachment in bytes.
Format: int32
Maximum: 2147483647
Minimum: -2147483648
$ (allOf 2).size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get rule — response body — @odata type, id

SDK function policy ID: microsoft.users_messages_getattachments. Catalog operation: users_messages_getattachments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.