> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/documentation/en/framework/externals/projects/aliyun.md).

# Aliyun (aliyun)

The Aliyun project's capability scope, deployment products, integration entrance and usage boundaries.

Integrate Alibaba Cloud OSS, messaging, SMS and voice, mobile push and other capabilities. Different services have independent resources, templates and permission conditions, and are configured according to the actual capabilities used.

| Item                  | value                                                                          |
| --------------------- | ------------------------------------------------------------------------------ |
| source code directory | `externals/aliyun`                                                             |
| main bag              | `Zongsoft.Externals.Aliyun`                                                    |
| Companion theme       | [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) |

## Deployment and Usage Portal

Append the main package to the existing host's [Deployment checklist](/documentation/en/references/deploy-files.md), and retain the plugin list, assembly and ancillary running resources in the package:

{% code title="Application.deploy (append fragment)" %}

```ini
[plugins zongsoft externals aliyun]
nuget:Zongsoft.Externals.Aliyun
```

{% endcode %}

The configuration is located at `/Externals/Aliyun`. General settings select Service Center and Network, named Certificate holds access credentials; here Certificate is the credential model of the adapter. OSS integrates through `zfs.oss` file system.

The callback needs to be deployed separately `Zongsoft.Externals.Aliyun.Gateway`, and the main package will not automatically provide an HTTP callback entry.

## Integration Steps

1. Select a service, configure dedicated resources and corresponding credentials; the object storage first verifies that the information of the existing object is read.
2. SMS, voice and push notifications need to check the template, application and target type, and then verify the platform return value and business receipt.
3. Registers the target handler when receiving a callback and verifies the original request's signature, duplicate notifications, and protocol-required responses.

For specific configuration, calling examples and related basic concepts, see [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md).

## Project Boundaries

{% hint style="info" %}
💡 The name in the default callback path is the handler dispatch key. The gateway does not automatically complete signature verification, decryption and replay protection for all services; Aliyun's handler collection assembly also needs to expose the Handlers attribute according to the actual plugin node.
{% endhint %}

## Further Reading

[Browse extensions by project](/documentation/en/framework/externals/projects.md) · [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) · [source code and project description](https://github.com/Zongsoft/framework/tree/main/externals/aliyun)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/framework/externals/projects/aliyun.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.