SMSを一斉送信するAPI

1回のリクエストで1人から数千人の受信者にカスタマイズされたSMSを一斉送信することができます。ここでは一斉送信APIを使用したシンプルなSMS送信方法と送信結果の確認方法をご紹介します。

プロセスワークフロー

サービス
NTT CPaaS NTT CPaaS

▶ アカウントをお持ちでない方へ|60日間無料トライアルを開始

チュートリアルの内容は、トライアル環境ですぐにお試しいただけます。クレジットカード情報の登録は不要、自動で課金されることもありません。送信テストや動作確認に、ぜひ無料トライアルをご活用ください。

事前準備・前提条件

このチュートリアルを始めるには、NTT CPaaSアカウントが必要です。 こちらからログインをお願いします。
API キーとベース URL も必要になります。詳細についてはAPIリファレンスを参照してください。
SMS APIの利用には発信元番号の登録が必要です。本申し込みから電話番号をご登録ください。また、無料トライアルの利用では、送信先の電話番号の認証が必要です。

実装手順

ステップ1 - SMSの送信

『メッセージSMS送信』を利用して、SMSを送信します。予約送信などカスタマイズもできますが、ここではシンプルな2件の即時送信を説明します。

  • Method: POST
  • End Point : {baseUrl}/sms/3/messages
  • Content-Type: application/json

リクエスト例:

{
    "messages": [
        {
            "sender": "TR_IB00000",
            "destinations": [
                {
                    "to": "+818888888888"
                },
                {
                    "to": "+819999999999"
                }
            ],
            "content": {
                "text": "test message"
            }
        }
    ]
}

レスポンス例:

{
  "bulkId": "17361306109844335855800",
  "messages": [
    {
      "messageId": "17361306109844335855801",
      "status": {
        "groupId": 1,
        "groupName": "PENDING",
        "id": 26,
        "name": "PENDING_ACCEPTED",
        "description": "Message sent to next instance"
      },
      "destination": "+818888888888"
    },
    {
      "messageId": "17361306109844335855802",
      "status": {
        "groupId": 1,
        "groupName": "PENDING",
        "id": 26,
        "name": "PENDING_ACCEPTED",
        "description": "Message sent to next instance"
      },
      "destination": "+819999999999"
    }
  ]
}

ステップ2 - SMSの送信・着信結果の確認

『アウトバウンドSMSメッセージ配信レポートを取得する』を利用して、SMSの処理結果を確認します。
これは、エンドユーザーに送信される メッセージ本文です。1 つのアプリケーションごとに多数のメッセージ テンプレートを作成できるため、同じアプリケーションをさまざまなユース ケースやさまざまな言語でご利用頂けます。
メッセージ テンプレートを作成すると、後で PIN を送信するときに使用するメッセージ テンプレート ID が提供されます。メッセージ テンプレート ID を参照することで、システムは PIN を生成し、その PIN をメッセージ テンプレートに配置し、最後に PIN を含むメッセージをエンド ユーザーに送信します。

ここでは以下の条件でAPIを利用します。

  • Method: GET
  • End Point : {baseUrl}/sms/3/reports
  • Content-Type: application/json

リクエスト例:

GET https://{baseUrl}/sms/3/reports?bulkId=17361306109844335855800

レスポンス例:

{
  "results": [
    {
      "bulkId": "17361306109844335855800",
      "price": {
        "pricePerMessage": 0.0,
        "currency": "JPY"
      },
      "status": {
        "groupId": 3,
        "groupName": "DELIVERED",
        "id": 5,
        "name": "DELIVERED_TO_HANDSET",
        "description": "Message delivered to handset"
      },
      "error": {
        "groupId": 0,
        "groupName": "OK",
        "id": 0,
        "name": "NO_ERROR",
        "description": "No Error",
        "permanent": false
      },
      "messageId": "17361306109844335855801",
      "to": "818888888888",
      "sender": "TR_IB00000",
      "sentAt": "2025-01-06T02:30:12.013+0000",
      "doneAt": "2025-01-06T02:30:18.977+0000",
      "messageCount": 1,
      "mccMnc": "null"
    },
    {
      "bulkId": "17361306109844335855800",
      "price": {
        "pricePerMessage": 0.0,
        "currency": "JPY"
      },
      "status": {
        "groupId": 2,
        "groupName": "UNDELIVERABLE",
        "id": 9,
        "name": "UNDELIVERABLE_NOT_DELIVERED",
        "description": "Message sent not delivered"
      },
      "error": {
        "groupId": 1,
        "groupName": "HANDSET_ERRORS",
        "id": 32,
        "name": "EC_SM_DELIVERY_FAILURE",
        "description": "SM Delivery Failure",
        "permanent": false
      },
      "messageId": "17361306109844335855802",
      "to": "819999999999",
      "sender": "TR_IB00000",
      "sentAt": "2025-01-06T02:30:11.488+0000",
      "doneAt": "2025-01-06T02:30:34.007+0000",
      "messageCount": 1,
      "mccMnc": "null"
    }
  ]
}

NTT CPaaSを、
60日間無料でお試しください

・SMS・Voice・メールを本番同様に無料で検証
・全API機能に即日アクセス / 有料プランと同一環境
・国内開発者向けに最適化された日本語ガイド

無料トライアル

目次
  1. プロセスワークフロー
  2. 事前準備・前提条件
  3. 実装手順
    1. ステップ1 - SMSの送信
    2. ステップ2 - SMSの送信・着信結果の確認

2025.01.21