文档

Java SDK调用示例

更新时间:

本文介绍如何使用OpenAPI调用SendSms接口向指定手机号发送一条测试短信。

步骤一:查看OpenAPI文档

在调用OpenAPI前,建议您先阅读对应的接口文档SendSms,了解、学习调用该接口所需要的参数及权限等,更多信息请参见API概览

步骤二:创建RAM用户并完成授权

重要

阿里云账号拥有所有API的访问权限,建议您创建并使用RAM用户进行API访问或日常运维。

您可以使用阿里云账号(主账号)、RAM用户、RAM角色调用该接口,有关各种身份的差异请参见身份

本案例中,我们使用RAM用户进行接口调用。

  1. 创建RAM用户

    1. 登录RAM访问控制

    2. 在左侧导航栏,选择身份管理 > 用户

    3. 用户页面,单击创建用户

    4. 创建用户页面,设置登录名称显示名称访问方式控制台访问

    5. 单击确定

      创建RAM用户成功后,请记录用户登录名称和密码,您在调用OpenAPI时,需要使用该RAM用户登录阿里云OpenAPI开发者门户。

  2. 为RAM用户授权

    说明

    AliyunDysmsFullAccess:管理短信服务的权限。

    AliyunDysmsReadOnlyAccess:只读访问短信服务的权限。

    如果您需要新建自定义权限,请参见授权信息

    1. 访问RAM用户列表

    2. 单击目标RAM用户操作列的添加权限

    3. 在文本框中输入关键字dysms进行搜索,选择AliyunDysmsFullAccess 策略。

    4. 单击确定新增授权,完成授权操作。

  3. 进入到对应的RAM用户详情页,在认证管理页签,点击创建 AccessKey

    更多操作详情,请参见创建AccessKey

步骤三:调用OpenAPI

本文以Java语言SDK调用OpenAPI,其他语言SDK的用法类似,更多信息请参见短信服务SDK。您也可根据业务的实际需要选择其他调用方式,更多调用方法请参见调用方式

说明

调用接口前需配置环境变量,通过环境变量读取访问凭证。AccessKey ID和AccessKey Secret的环境变量名:SMS_ACCESS_KEY_ENV、SMS_ACCESS_KEY_SECRET_ENV。配置详情请参见在Linux、macOS和Windows系统配置环境变量

下载示例代码

  1. 访问SendSms

  2. 在左侧的参数配置页签,填写需要的参数信息。

    • PhoneNumbers 参数输入示例值: 139****0000

    • SignName 参数输入示例值:阿里云短信测试

    • TemplateCode 参数输入示例值:SMS_15495****

    • TemplateParams 参数输入示例值:{"code":"1234"}

  3. 在右侧的SDK示例页签,SDK版本选择v2.0,语言选择Java语言,单击下载完整工程按钮,下载示例代码包。

  4. 本地解压并进入alibabacloud_sample目录。

打开项目

使用IntelliJ IDEA加载项目,待相关依赖加载完毕后,打开 src/main/java/com/aliyun/sample/Sample.java。根据代码中的注释提示自行添加打印返回值的代码。

运行项目

点击IDE右上角的运行按钮,可查看输出日志。本案例中的返回内容如下:

{
  "headers": {
    "access-control-allow-origin": "*",
    "date": "Mon, 17 Jul 2023 16:21:50 GMT",
    "content-length": "110",
    "keep-alive": "timeout=25",
    "x-acs-request-id": "F59B3F78-D9CD-5D01-A9CC-AE5C921ED9C0",
    "connection": "keep-alive",
    "content-type": "application/json;charset=utf-8",
    "etag": "1MzEw7RSXKXTkIJ1thYGmCw0",
    "access-control-expose-headers": "*",
    "x-acs-trace-id": "5ecfe30b412fb6e09a86d651ccbe13db"
  },
  "statusCode": 200,
  "body": {
    "bizId": "695425589610909881^0",
    "code": "OK",
    "message": "OK",
    "requestId": "F59B3F78-D9CD-5D01-A9CC-AE5C921ED9C0"
  }
}

常见问题

视频介绍

  • 本页导读 (1)