集成概览

通过编程的方式在业务系统中集成短信服务的能力,做到根据业务的实际需要自动化发送短信,简化运营、管理成本。本文为您介绍短信服务开放的OpenAPI及支持的集成方式。

OpenAPI介绍

为了能够让开发者快速高效地学习和使用云产品OpenAPI,阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是OpenAPI

版本说明

短信服务提供管理资质、短信模板、发送短信等多种OpenAPI,满足您在业务系统中集成的需求。

说明

阿里云OpenAPI通过版本号管控各时期云产品大版本的API列表。

例如:短信服务目前支持2017-05-25版本的API列表,2017-05-25代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2017-05-25之后就未更新。

API 版本号

说明

2017-05-25

推荐使用

在线调试

短信服务在OpenAPI门户提供API调试等功能。在调用前,您需要了解短信服务提供的版本、接入点、接口风格、调用方式等信息。

image.png

调试入口

调试API入口为:https://api.aliyun.com/api/Dysmsapi/2017-05-25/

接入点说明

根据相关资源所在地域,选择对应的服务接入点地址,以获得最低延迟。

请使用全局接入点域名dysmsapi.aliyuncs.com

更多信息,请参见服务接入点

支持的调用身份

您阿里云账号登录OpenAPI网站后,OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作权限,详情请参见使用RAM进行访问控制

用户身份

支持情况

阿里云账号

支持

RAM用户(推荐)

支持

RAM角色(推荐)

支持

更多信息

集成方式

短信服务提供SDK等多种集成方式,您可以根据业务的实际需要进行选择。

阿里云SDK

  • 阿里云为开发者提供了多种编程语言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++等)的SDK。开发者只需集成SDK,通过SDK暴露的方法直接调用OpenAPI。SDK统一封装了签名逻辑、超时机制、重试机制,并根据文档返回结构化Response对象,易于开发。更多关于阿里云SDK的介绍,请参见阿里云SDK

  • 短信服务SDK支持的语言及依赖安装方法,请参见SDK参考

阿里云CLI

  • 阿里云命令行工具可以帮助您在使用命令行终端时,通过aliyun命令与阿里云服务进行交互,管理云服务资源。有关阿里云CLI的更多详细信息,请参见什么是阿里云CLI

  • 暂不支持使用阿里云CLI调用短信服务。

资源编排ROS

  • 资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例)、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情,请参见什么是资源编排服务

  • 暂不支持使用资源编排ROS调用短信服务。

自定义封装API调用

如果以上方案均无法满足您的业务需要,可自行封装请求调用OpenAPI(不推荐),详情请参见V3版本请求体&签名机制

注意事项

  • 如果调用短信服务API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息,请参见API错误码

  • 您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。