このトピックでは、ソフトウェア開発キット (SDK) を使用して OpenAPI を呼び出し、指定された携帯電話番号にショートメッセージを送信する方法について説明します。
ステップ 1:OpenAPI ドキュメントの表示
OpenAPI を呼び出す前に、 または SendMessageToGlobe の API ドキュメントをお読みになり、必須パラメーターと権限を理解することを推奨します。詳細については、「API の概要」をご参照ください。
ステップ 2:RAM ユーザーの作成と権限付与
Alibaba Cloud アカウントは高いレベルの権限を持っています。API 操作の呼び出しや日常の運用保守 (O&M) には、Resource Access Management (RAM) ユーザーを使用することを推奨します。RAM ユーザーの詳細については、「RAM ユーザーとは」をご参照ください。
RAM ユーザーの作成
RAM ユーザーへの権限付与
ステップ 3:OpenAPI 操作の呼び出し
SDK は、お使いのアプリケーションに簡単に統合でき、幅広い操作をサポートします。API 操作を呼び出すには、SDK を使用することを推奨します。本トピックでは、Java SDK を例として、API 操作を呼び出す方法を説明します。他の言語の SDK も同様の方法で使用できます。詳細については、「Short Message Service SDK」をご参照ください。
前提条件
Java 8 以降のバージョンを使用していることを確認してください。Java 環境の設定方法の詳細については、「Windows で Java 開発環境を構築する」をご参照ください。
Maven 依存関係を設定して SDK をインストールします。
<dependency> <groupId>com.aliyun</groupId> <artifactId>dysmsapi20180501</artifactId> <!-- 'the-latest-version' を最新のバージョン番号に置き換えます。https://mvnrepository.com/artifact/com.aliyun/dysmsapi20180501 で確認できます --> <version>the-latest-version</version> </dependency>AccessKey ペアを読み取るために環境変数を設定します。環境変数の設定方法の詳細については、「Linux、macOS、Windows で環境変数を設定する」をご参照ください。
説明AccessKey ペアがコードにハードコーディングされて漏洩するのを防ぐために、環境変数を設定して AccessKey ペアを取得してください。
このトピックでは、
ALIBABA_CLOUD_ACCESS_KEY_IDおよびALIBABA_CLOUD_ACCESS_KEY_SECRET環境変数を例として使用します。
サンプルコード
次のサンプルコードは、SDK を使用して API 操作を呼び出し、ショートメッセージを送信する方法を示しています。コメントに基づいて、パラメーターのプレースホルダーの値を実際の値に置き換えてください。
package com.aliyun.sample;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20180501.Client;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeRequest;
import com.aliyun.dysmsapi20180501.models.SendMessageToGlobeResponse;
import static com.aliyun.teautil.Common.toJSONString;
public class Sample {
public static Client createClient() throws Exception {
Config config = new Config()
// AccessKey ID を設定します。実行環境で環境変数 ALIBABA_CLOUD_ACCESS_KEY_ID が設定されていることを確認してください。
.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
// AccessKey Secret を設定します。実行環境で環境変数 ALIBABA_CLOUD_ACCESS_KEY_SECRET が設定されていることを確認してください。
.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
// エンドポイントを設定します。
config.endpoint = "dysmsapi.ap-southeast-1.aliyuncs.com";
return new Client(config);
}
public static void main(String[] args) throws Exception {
// クライアントを初期化します。
Client client = Sample.createClient();
// リクエストオブジェクトを作成し、パラメーター値を指定します。
SendMessageToGlobeRequest sendSmsRequest = new SendMessageToGlobeRequest()
.setTo("<YOUR_VALUE>")
.setMessage("<YOUR_VALUE>");
// レスポンスオブジェクトを取得します。
SendMessageToGlobeResponse sendSmsResponse = client.sendMessageToGlobe(sendSmsRequest);
// レスポンスには、サーバーからの本文とヘッダーが含まれます。
System.out.println(toJSONString(sendSmsResponse));
}
}サンプルコードをダウンロードして直接実行することもできます。
サンプルコードのダウンロード
プロジェクトの実行
プロジェクトを実行すると、出力を確認できます。次のサンプル出力が返されます:
{
"headers": {
"date": "Tue, 24 Oct 2023 07:47:17 GMT",
"content-type": "application/json;charset=utf-8",
"content-length": "263",
"connection": "keep-alive",
"keep-alive": "timeout=25",
"access-control-allow-origin": "*",
"access-control-expose-headers": "*",
"x-acs-request-id": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F",
"x-acs-trace-id": "29c11fe4c778b74774d5f5602f0e7975",
"etag": "2a+mcDRTDkXqx9VF7b6U57Q3"
},
"statusCode": 200,
"body": {
"ResponseCode": "OK",
"NumberDetail": {
"Region": "Taiwan",
"Country": "Taiwan, Province of China",
"Carrier": "FarEasTone"
},
"RequestId": "97B1D7B6-F2F6-3A50-97BC-A90B43EC962F",
"Segments": "1",
"ResponseDescription": "OK",
"To": "88691567****",
"MessageId": "191921698133637273"
}
}