SDK を使用した SMS API の呼び出し - Short Message Service - Alibaba Cloud ドキュメントセンター

このガイドでは、OpenAPI Explorer または SDK を使用して Short Message Service (SMS) API を呼び出し、メッセージの送信や配信ステータスのクエリなどのコア操作を実行する方法について説明します。

始める前に

SMS API を呼び出す前に、次の準備を完了してください:

アカウントの作成と企業 ID 検証の完了: SMS はエンタープライズアカウントでのみ利用可能です。企業 ID 検証を完了する必要があります。
SMS の有効化: SMS コンソールにログインし、プロンプトに従ってサービスを有効化します。
リソースパッケージの購入: デフォルトでは、SMS は前払いのリソースパッケージを介して請求されます。サービスを使用する前にリソースパッケージを購入してください。
- クレジットカードまたは PayPal アカウントが Alibaba Cloud アカウントにリンクされていることを確認してください。
- 送信先とパッケージ仕様に基づいて適切なパッケージを購入してください。従量課金モデルをご希望の場合は、営業担当者にお問い合わせの上、有効化してください。
開発環境のセットアップ: これには、RAM ユーザーの作成、権限の付与、AccessKey ペアの取得が含まれます。詳細については、「認証情報の設定」をご参照ください。
メッセージを送信するための通信事業者のコンプライアンス要件は、国やリージョンによって異なります。配信性を確保するために、送信先のすべての必須プロシージャを完了してください:
- 中国本土 (Go China) にメッセージを送信するには、SMS 署名とメッセージテンプレートを作成します。これらは使用前に承認される必要があります。
- 中国本土以外のリージョン (Go Globe) にメッセージを送信するには、送信先の国またはリージョンで送信者 ID の登録が必要かどうかを確認してください。

OpenAPI Explorer の使用

OpenAPI Explorer は、API 呼び出しをデバッグするためのインタラクティブなツールです。Alibaba Cloud を初めて使用する開発者や、ビジュアルインターフェイスを好む開発者に最適です。OpenAPI Explorer は、リアルタイムの応答プレビュー、自動パラメーター検証を提供し、統合を効率化するための多言語サンプルコードを生成します。

API リファレンスページの [Test] ボタンをクリックして OpenAPI Explorer を開くことができます。

Go Globe

SendMessageToGlobe: 香港 (中国)、マカオ (中国)、台湾 (中国) を含む中国本土以外のリージョンにメッセージを送信します。
BatchSendMessageToGlobe: 香港 (中国)、マカオ (中国)、台湾 (中国) を含む中国本土以外のリージョンにメッセージをバッチで送信します。
QueryMessage: 送信されたメッセージのステータスをクエリします。

Go China

SendMessageWithTemplate: 中国本土にメッセージを送信します。
QueryMessage: 送信されたメッセージのステータスをクエリします。

SMS SDK の統合

SMS API を呼び出す最も簡単で信頼性の高い方法は、公式 SDK を使用することです。この例では、Java SDK を使用して SendMessageToGlobe 操作を呼び出します。他の言語については、「SDK リファレンス」をご参照ください。

Java 環境の確認: Java 8 以降がインストールされている必要があります。手順については、「Windows で Java 開発環境を構築する」をご参照ください。
SDK のインストール: Maven の依存関係を設定して SDK をインストールします。
Maven プロジェクトの pom.xml ファイルで、<dependencies> タグ内に次の依存関係を追加します。the-latest-version を最新のバージョン番号に置き換えます。ファイルを保存した後、Maven の依存関係を再読み込みします。
```
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20180501</artifactId>
    
    <version>the-latest-version</version>
</dependency>
```

サンプルコードの表示: 次の例は、Java SDK を使用して SendMessageToGlobe 操作を呼び出す方法を示しています。コメントで示されているようにパラメーター値を入力します。

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 シークレットを設定します。環境変数 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));
    }
}

サンプルコードをダウンロードして直接実行することもできます。
1. [パラメーター] タブで、必須パラメーター値を入力します。
2. 右側の[SDK サンプルコード]タブで、SDK バージョンとしてV2.0を、言語として[Java]を選択し、[プロジェクトをダウンロード]をクリックしてサンプルコードパッケージをダウンロードします。
3. パッケージを解凍した後、IDE でプロジェクトを開きます。依存関係が読み込まれた後、src/main/java/com/aliyun/sample/Sample.java を開きます。

応答の確認: プロジェクトを実行すると、次のサンプル応答のような出力が表示されます。

{
  "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"
  }
}

配信レシート

配信レポートとユーザーの返信を受信するには、Simple Message Queue (旧称：MNS) のコンシューマーを設定するか、バッチ処理された HTTP プッシュを受信するための Webhook エンドポイントを提供します。これにより、配信成功率をモニターし、アプリケーションでの双方向通信を有効にすることができます。

詳細については、「配信レシートの設定」をご参照ください。

リファレンス

API 概要: 使用上の注意、パラメーターの詳細、制限など、API 操作について説明します。
エラーコード: API の呼び出し時または配信レシートの受信時に返される可能性のあるエラーコードを一覧表示し、ソリューションを提供します。
SMS API の使用開始: 環境構成、呼び出しを行うためのプロセス、および関連するサンプルコードに関する詳細情報を提供します。

ビデオチュートリアル

SMS を有効化する方法に関するビデオチュートリアル。