Notification > SMS > API v2.3ガイド

v2.3 API紹介

v2.2からの変更事項

  1. 認証用SMS送信APIに対する本文の有効性チェックが追加されました。
  2. 詳細は[認証用SMS送信API]を参照してください。

[APIドメイン]

環境 ドメイン
Real https://api-sms.cloud.toast.com

[注意事項]

  • サポートする文字数は下記の通りです。
  • 最大サポート文字数は保存基準で、文字切れ防止のため、標準規格で作成してください。
  • エンコードはEUC-KR基準で送信され、サポートしていない顔文字は送信に失敗します。
分類 最大サポート 標準規格
SMS本文 255文字 90バイト(全角45文字、半角90文字)
MMSタイトル 120文字 40バイト(全角20文字、半角40文字)
MMS本文 4,000文字 2,000バイト(全角1,000文字、半角2,000文字)

短文SMS

短文SMSの送信

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/sender/sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "templateId":"TemplateId",
   "body":"本文",
   "sendNo":"15446859",
   "requestDate":"2018-08-10 10:00",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "countryCode":"82",
         "internationalRecipientNo":"821000000000",
         "templateParameter":{
            "key":"value"
         },
         "recipientGroupingKey":"recipientGroupingKey"
      }
   ],
   "userId":"UserId",
   "statsId":"statsId"
}
タイプ 最大 必須 説明
templateId String 50 X 送信テンプレートID
body String 標準:90バイト、最大:255文字(EUC-KR基準) [注意事項] O 本文内容
sendNo String 13 O 発信番号
requestDate String - X 予約日時(yyyy-MM-dd HH:mm)
senderGroupingKey String 100 X 発信者グループキー
recipientList[].recipientNo String 20 O 受信番号
countryCodeと組み合わせて使用可能
最大1,000人
recipientList[].countryCode String 8 X 国番号[デフォルト値:82(韓国)]
recipientList[].internationalRecipientNo String 20 X 国番号を含む受信番号
例)821012345678
recipientNoがある場合、この値は無視される。
recipientList[].templateParameter Object - X テンプレートパラメータ(テンプレートID入力時)
recipientList[].templateParameter.{key} String - X 置換キー(##key##)
recipientList[].templateParameter.{value} Object - X 置換キーにマッピングされるValue値
recipientList[].recipientGroupingKey String 100 X 受信者グループキー
userId String 100 X 送信セパレータex)admin,system
statsId String 10 X 統計ID(発信検索条件には含まれません)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "body": "Body",
    "sendNo": "15446859",
    "recipientList": [{
            "internationalRecipientNo": "821000000000"
        }
    ]
}'

レスポンス

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            }
         ]
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.statusCode String リクエストステータスコード(1:リクエスト中、2:リクエスト完了、3:リクエスト失敗)
body.data.senderGroupingKey String 発信者グループキー
body.data.sendResultList[].recipientNo String 受信番号
body.data.sendResultList[].resultCode Integer 結果コード
body.data.sendResultList[].resultMessage String 結果メッセージ
body.data.sendResultList[].recipientSeq Integer 受信者シーケンス(mtPr)
body.data.sendResultList[].recipientGroupingKey String 受信者グループキー

短文SMSの送信例(一般国内受信番号)

Http metho URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/sms

[Request body]

{
   "body":"本文",
   "sendNo":"15446859",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "recipientGroupingKey":"recipientGroupingKey"
      },
      {
         "recipientNo":"01000000001",
         "recipientGroupingKey":"RecipientGroupingKey2"
      }
   ]
}

[Response]

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            },
            {
               "recipientNo":"01000000001",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":2,
               "recipientGroupingKey":"RecipientGroupingKey2"
            }
         ]
      }
   }
}

短文SMS送信例(国コードが含まれている受信番号)

Http metho URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/sms

[Request body]

{
   "body":"本文",
   "sendNo":"15446859",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "internationalRecipientNo":"821000000000",
         "recipientGroupingKey":"recipientGroupingKey"
      }
   ],
   "userId":"",
   "statsId":"statsId"
}

[Response]

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            }
         ]
      }
   }
}

短文SMS送信リストの照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter] * requestIdまたはstartRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。 * 登録日時と発信日時を同時に照会する場合、発信日時は無視されます。

タイプ 最大 必須 説明
requestId String 25 必須 リクエストID
startRequestDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startCreateDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endCreateDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startResultDate String - オプション 受信日の開始値(yyyy-MM-dd HH:mm:ss)
endResultDate String - オプション 受信日の終了値(yyyy-MM-dd HH:mm:ss)
sendNo String 13 オプション 発信番号
recipientNo String 20 オプション 受信番号
templateId String 50 オプション テンプレート番号
msgStatus String 1 オプション メッセージステータスコード(0:失敗、1:リクエスト、2:処理中、3:成功、4:予約キャンセル、5:重複送信)
resultCode String 10 オプション 受信結果コード[照会コード表]
subResultCode String 10 オプション 受信結果詳細コード[照会コード表]
senderGroupingKey String 100 オプション 送信者グループキー
recipientGroupingKey String 100 オプション 受信者グループキー
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/sms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header":{
      "resultCode":0,
      "resultMessage":"SUCCESS",
      "isSuccessful":true
   },
   "body":{
      "pageNum":1,
      "pageSize":15,
      "totalCount":1,
      "data":[
         {
            "requestId":"20180810100630ReZQ6KZzAH0",
            "requestDate":"2018-08-10 10:06:30.0",
            "resultDate":"2018-08-10 10:06:42.0",
            "templateId":"TemplateId",
            "templateName":"テンプレート名",
            "categoryId":0,
            "categoryName":"カテゴリー名",
            "body":"短文テスト",
            "sendNo":"15446859",
            "countryCode":"82",
            "recipientNo":"01000000000",
            "msgStatus":"3",
            "msgStatusName":"成功",
            "resultCode":"1000",
            "resultCodeName":"成功",
            "telecomCode":10001,
            "telecomCodeName":"SKT",
            "mtPr":"1",
            "sendType":"0",
            "userId":"tester",
            "adYn":"N",
            "resultMessage": "",
            "senderGroupingKey":"SenderGroupingKey",
            "recipientGroupingKey":"RecipientGroupingKey"
         }
      ]
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].requestId String リクエストID
body.data[].requestDate String 発信日時
body.data[].resultDate String 受信日時
body.data[].templateId String テンプレートID
body.data[].templateName String テンプレート名
body.data[].categoryId String カテゴリーID
body.data[].categoryName String カテゴリー名
body.data[].body String 本文内容
body.data[].sendNo String 発信番号
body.data[].countryCode String 国番号
body.data[].recipientNo String 受信番号
body.data[].msgStatus String メッセージステータスコード
body.data[].msgStatusName String メッセージステータスコード名
body.data[].resultCode String 受信結果コード[受信結果コード表]
body.data[].resultCodeName String 受信結果コード名
body.data[].telecomCode Integer サービスプロバイダーコード
body.data[].telecomCodeName String サービスプロバイダー名
body.data[].mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].userId String 送信リクエストID
body.data[].adYn String 広告かどうか
body.data[].senderGroupingKey String 発信者グループキー
body.data[].recipientGroupingKey String 受信者グループキー

短文SMS送信の単一照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/sms/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID

[Query parameter]

タイプ 必須 説明
mtPr Integer 必須 送信詳細ID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/sms/'"${REQUEST_ID}"'?mtPr='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header":{
      "resultCode":0,
      "resultMessage":"SUCCESS",
      "isSuccessful":true
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "requestDate":"2018-08-10 10:06:30.0",
         "resultDate":"2018-08-10 10:06:42.0",
         "templateId":"TemplateId",
         "templateName":"テンプレート名",
         "categoryId":0,
         "categoryName":"カテゴリー名",
         "body":"本文",
         "sendNo":"15446859",
         "countryCode":"82",
         "recipientNo":"01000000000",
         "msgStatus":"3",
         "msgStatusName":"成功",
         "resultCode":"1000",
         "resultCodeName":"成功",
         "telecomCode":10001,
         "telecomCodeName":"SKT",
         "mtPr":"1",
         "sendType":"0",
         "userId":"tester",
         "adYn":"N",
         "resultMessage": "",
         "senderGroupingKey":"SenderGroupingKey",
         "recipientGroupingKey":"recipientGroupingKey"
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.requestDate String 発信日時
body.data.resultDate String 受信日時
body.data.templateId String テンプレートID
body.data.templateName String テンプレート名
body.data.categoryId String カテゴリーID
body.data.categoryName String カテゴリー名
body.data.body String 本文内容
body.data.sendNo String 発信番号
body.data.countryCode String 国番号
body.data.recipientNo String 受信番号
body.data.msgStatus String メッセージステータスコード
body.data.msgStatusName String メッセージステータスコード名
body.data.resultCode String 受信結果コード[受信結果コード表]
body.data.resultCodeName String 受信結果コード名
body.data.telecomCode Integer サービスプロバイダーコード
body.data.telecomCodeName String サービスプロバイダー名
body.data.mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data.sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data.userId String 送信リクエストID
body.data.adYn String 広告かどうか
body.data.senderGroupingKey String 発信者グループキー
body.data.recipientGroupingKey String 受信者グループキー

長文MMS

長文MMS送信(添付ファイルは含まない)

※ MMSは韓国外への送信はできません。

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/sender/mms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "templateId":"TemplateId",
   "title":"Title",
   "body":"Body",
   "sendNo":"15446859",
   "requestDate":"2018-08-10 10:00",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "countryCode":"82",
         "internationalRecipientNo":"821000000000",
         "templateParameter":{
            "key":"value"
         },
         "recipientGroupingKey":"recipientGroupingKey"
      }
   ],
   "userId":"UserId",
   "statsId":"statsId
}
タイプ 最大 必須 説明
templateId String 50 X 送信テンプレートID
title String 40バイト(EUC-KR基準) O タイトル
body String 2000バイト(EUC-KR基準) O 本文
sendNo String 13 O 発信番号
requestDate String - X 予約日時(yyyy-MM-dd HH:mm)
senderGroupingKey String 100 X 発信者グループキー
recipientList[].recipientNo String 20 O 受信番号
countryCodeと組み合わせて使用可能
recipientList[].countryCode String 8 X 国番号[デフォルト値:82(韓国)]
recipientList[].internationalRecipientNo String 20 X 国番号を含む受信番号
例)821012345678
recipientNoがある場合、この値は無視される。
recipientList[].templateParameter Object - X テンプレートパラメータ(テンプレートID入力時)
recipientList[].templateParameter.{key} String - X 置換キー(##key##)
recipientList[].templateParameter.{value} Object - X 置換キーにマッピングされるValue値
recipientList[].recipientGroupingKey String 1000 X 受信者グループキー
userId String 100 X 送信セパレータex)admin,system
statsId String 10 X 統計ID(発信検索条件には含まれません)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/mms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "title": "{title}}",
    "body": "{body}",
    "sendNo": "15446859",
    "attachFileIdList": [0],
    "recipientList": [{
            "recipientNo": "01000000000",
            "templateParameter": {}
        }
    ],
    "userId": ""
}'

レスポンス

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            }
         ]
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.statusCode String リクエストステータスコード(1:リクエスト中、2:リクエスト完了、3:リクエスト失敗)
body.data.senderGroupingKey String 発信者グループキー
body.data.sendResultList[].recipientNo String 受信番号
body.data.sendResultList[].resultCode Integer 結果コード
body.data.sendResultList[].resultMessage String 結果メッセージ
body.data.sendResultList[].recipientSeq Integer 受信者シーケンス(mtPr)
body.data.sendResultList[].recipientGroupingKey String 受信者グループキー

長文MMSの送信例

Http metho URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/mms

[Request body]

{
   "title": "タイトル",
   "body":"本文",
   "sendNo":"15446859",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "recipientGroupingKey":"recipientGroupingKey"
      },
      {
         "recipientNo":"01000000001",
         "recipientGroupingKey":"RecipientGroupingKey2"
      }
   ]
}

[Response]

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            },
            {
               "recipientNo":"01000000001",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":2,
               "recipientGroupingKey":"RecipientGroupingKey2"
            }
         ]
      }
   }
}

長文MMSの送信(添付ファイル含む)

添付ファイルの送信例

Http method URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/mms

[Request body]

{
    "title": "タイトル",
    "body": "本文",
    "sendNo": "15446859",
    "senderGroupingKey": "SenderGrouping",
    "attachFileIdList": [0],
    "recipientList": [{
        "recipientNo": "01010000000",
        "recipientGroupingKey":"RecipientGroupingKey"
    }],
    "statsId":"statsId"
}

[Response]

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "body": {
    "data": {
      "requestId": "20180810100630ReZQ6KZzAH0",
      "statusCode": "2",
      "senderGroupingKey": "SenderGrouping",
      "sendResultList" : [
          {
              "recipientNo" : {受信番号},
              "resultCode" :  0,
              "resultMessage" : "SUCCESS"
              "recipientSeq": 1,
              "recipientGroupingKey":"RecipientGroupingKey"
          }
      ]
    }
  }
}
説明
  • 添付ファイル(フィールド名:attachFileIdList)を含む長文MMSを送信するためには、事前に添付ファイルのアップロードを行う必要があります。
  • [添付ファイルアップロード] ガイドを参照してください。
  • 付イメージ制限事項
    • サポートコーデック:.jpg
    • 添付イメージ数:2個以下
    • 添付イメージサイズ:300KB以下
    • 添付イメージ解像度:1000 x 1000以下

長文MMS送信リストの照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/mms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter] * requestIdまたはstartRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。 * 登録日時と発信日時を同時に照会する場合、発信日時は無視されます。

タイプ 最大 必須 説明
requestId String 25 必須 リクエストID
startRequestDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startCreateDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endCreateDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startResultDate String - オプション 受信日の開始値(yyyy-MM-dd HH:mm:ss)
endResultDate String - オプション 受信日の終了値(yyyy-MM-dd HH:mm:ss)
sendNo String 13 オプション 発信番号
recipientNo String 20 オプション 受信番号
templateId String 50 オプション テンプレート番号
msgStatus String 1 オプション メッセージステータスコード(0:失敗、1:リクエスト、2:処理中、3:成功、4:予約キャンセル、5:重複送信)
resultCode String 10 オプション 受信結果コード[照会コード表]
subResultCode String 10 オプション 受信結果詳細コード[照会コード表]
senderGroupingKey String 100 オプション 送信者グループキー
recipientGroupingKey String 100 オプション 受信者グループキー
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/mms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "resultCode":0,
    "resultMessage":"SUCCESS",
    "isSuccessful":true
  },
  "body":{
    "pageNum":1,
    "pageSize":15,
    "totalCount":1,
    "data":[
      {
        "requestId":"20180810100630ReZQ6KZzAH0",
        "requestDate":"2018-08-10 10:06:30.0",
        "resultDate":"2018-08-10 10:06:42.0",
        "templateId":"TemplateId",
        "templateName":"テンプレート名",
        "categoryId":0,
        "categoryName":"カテゴリー名",
        "title":"タイトル",
        "body":"本文",
        "sendNo":"15446859",
        "countryCode":"82",
        "recipientNo":"01000000000",
        "msgStatus":"3",
        "msgStatusName":"成功",
        "resultCode":"1000",
        "resultCodeName":"成功",
        "telecomCode":10001,
        "telecomCodeName":"SKT",
        "mtPr":"1",
        "sendType":"0",
        "userId":"tester",
        "adYn":"N",
        "attachFileList": [{
               fileId: Integer,
               filePath: String,
               fileName: String,
               saveFileName: String,
               uploadType: String
         }],
        "resultMessage":"",
        "senderGroupingKey":"SenderGroupingKey",
        "recipientGroupingKey":"RecipientGroupingKey"
      }
    ]
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body Object 本文領域
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].requestId String リクエストID
body.data[].requestDate String 発信日時
body.data[].resultDate String 受信日時
body.data[].templateId String テンプレートID
body.data[].templateName String テンプレート名
body.data[].categoryId String カテゴリーID
body.data[].categoryName String カテゴリー名
body.data[].body String 本文内容
body.data[].sendNo String 発信番号
body.data[].countryCode String 国番号
body.data[].recipientNo String 受信番号
body.data[].msgStatus String メッセージステータスコード
body.data[].msgStatusName String メッセージステータスコード名
body.data[].resultCode String 受信結果コード[受信結果コード表]
body.data[].resultCodeName String 受信結果コード名
body.data[].telecomCode Integer サービスプロバイダーコード
body.data[].telecomCodeName String サービスプロバイダー名
body.data[].mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].userId String 送信リクエストID
body.data[].adYn String 広告かどうか
body.data[].attachFileList[].fileId Integer ファイルID
body.data[].attachFileList[].filePath String ファイル保存パス(内部用)
body.data[].attachFileList[].fileName String ファイル名
body.data[].attachFileList[].saveFileName String 保存された添付ファイルの名前
body.data[].attachFileList[].uploadType String アップロードタイプ
body.data[].senderGroupingKey String 発信者グループキー
body.data[].recipientGroupingKey String 受信者グループキー

長文MMS送信の単一照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/mms/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID

[Query parameter]

タイプ 必須 説明
mtPr Integer 必須 送信詳細ID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/mms/'"${REQUEST_ID}"'?mtPr='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "resultCode":0,
    "resultMessage":"SUCCESS",
    "isSuccessful":true
  },
  "body":{
    "data":{
      "requestId":"20180810100630ReZQ6KZzAH0",
      "requestDate":"2018-08-10 10:06:30.0",
      "resultDate":"2018-08-10 10:06:42.0",
      "templateId":"TemplateId",
      "templateName":"テンプレート名",
      "categoryId":0,
      "categoryName":"カテゴリー名",
      "title":"タイトル",
      "body":"本文",
      "sendNo":"15446859",
      "countryCode":"82",
      "recipientNo":"01000000000",
      "msgStatus":"3",
      "msgStatusName":"成功",
      "resultCode":"1000",
      "resultCodeName":"成功",
      "telecomCode":10001,
      "telecomCodeName":"SKT",
      "mtPr":"1",
      "sendType":"0",
      "userId":"tester",
      "adYn":"N",
      "attachFileList": [{
               fileId: Integer,
               filePath: String,
               fileName: String,
               saveFileName: String,
               uploadType: String
      }],
      "resultMessage":"",
      "senderGroupingKey":"SenderGroupingKey",
      "recipientGroupingKey":"RecipientGroupingKey"
    }
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body Object 本文領域
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].requestId String リクエストID
body.data[].requestDate String 発信日時
body.data[].resultDate String 受信日時
body.data[].templateId String テンプレートID
body.data[].templateName String テンプレート名
body.data[].categoryId String カテゴリーID
body.data[].categoryName String カテゴリー名
body.data[].body String 本文内容
body.data[].sendNo String 発信番号
body.data[].countryCode String 国番号
body.data[].recipientNo String 受信番号
body.data[].msgStatus String メッセージステータスコード
body.data[].msgStatusName String メッセージステータスコード名
body.data[].resultCode String 受信結果コード[受信結果コード表]
body.data[].resultCodeName String 受信結果コード名
body.data[].telecomCode Integer サービスプロバイダーコード
body.data[].telecomCodeName String サービスプロバイダー名
body.data[].mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].userId String 送信リクエストID
body.data[].adYn String 広告かどうか
body.data[].attachFileList[].fileId Integer ファイルID
body.data[].attachFileList[].filePath String ファイル保存パス(内部用)
body.data[].attachFileList[].fileName String ファイル名
body.data[].attachFileList[].saveFileName String 保存された添付ファイルの名前
body.data[].attachFileList[].uploadType String アップロードタイプ
body.data[].senderGroupingKey String 発信者グループキー
body.data[].recipientGroupingKey String 受信者グループキー

認証用SMS(緊急)

認証用SMSの送信

1. 認証用SMSの送信時、含まれる必要がある認証文言案内

区分 認証文言
認証用SMS(緊急) auth、password、verif、にんしょう、認証、パスワード、認証
  • 例1)認証用SMS(緊急) API送信リクエストした時、全文(テンプレート日本語識別子含む)に認証文言が含まれていない場合は、送信に失敗します。
  • 例2)認証文言が英文の場合、大文字/小文字の区別なしで有効性チェックが行われます。

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/sender/auth/sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "templateId":"TemplateId",
   "body":"本文",
   "sendNo":"15446859",
   "requestDate":"2018-08-10 10:00",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "countryCode":"82",
         "internationalRecipientNo":"821000000000",
         "templateParameter":{
            "key":"value"
         },
         "recipientGroupingKey":"recipientGroupingKey"
      }
   ],
   "userId":"UserId",
   "statsId":"statsId
}
タイプ 最大 必須 説明
templateId String 50 X 送信テンプレートID
body String 標準:90バイト、最大:255文字(EUC-KR基準) [注意事項] O 本文内容[注意事項]
sendNo String 13 O 発信番号
requestDate String - X 予約日時(yyyy-MM-dd HH:mm)
senderGroupingKey String 100 X 発信者グループキー
recipientList[].recipientNo String 20 O 受信番号
countryCodeと組み合わせて使用可能
recipientList[].countryCode String 8 X 国番号[デフォルト値:82(韓国)]
recipientList[].internationalRecipientNo String 20 X 国番号を含む受信番号
例)821012345678
recipientNoがある場合、この値は無視
recipientList[].templateParameter Object - X テンプレートパラメータ(テンプレートID入力時)
recipientList[].templateParameter.{key} String - X 置換キー(##key##)
recipientList[].templateParameter.{value} Object - X 置換キーにマッピングされるValue値
recipientList[].recipientGroupingKey String 100 X 受信者グループキー
userId String 100 X 送信セパレータex)admin,system
statsId String 10 X 統計ID(発信検索条件には含まれません)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/auth/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "body": "Auth Test",
    "sendNo": "15446859",
    "recipientList": [{
            "recipientNo": "01000000000",
            "templateParameter": {}
        }
    ],
    "userId": ""
}'

レスポンス

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            }
         ]
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.statusCode String リクエストステータスコード(1:リクエスト中、2:リクエスト完了、3:リクエスト失敗)
body.data.senderGroupingKey String 発信者グループキー
body.data.sendResultList[].recipientNo String 受信番号
body.data.sendResultList[].resultCode Integer 結果コード
body.data.sendResultList[].resultMessage String 結果メッセージ
body.data.sendResultList[].recipientSeq Integer 受信者シーケンス(mtPr)
body.data.sendResultList[].recipientGroupingKey String 受信者グループキー

Http metho URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/auth/sms

[Request body]

{
   "body":"本文",
   "sendNo":"15446859",
   "senderGroupingKey":"SenderGroupingKey",
   "recipientList":[
      {
         "recipientNo":"01000000000",
         "recipientGroupingKey":"recipientGroupingKey"
      },
      {
         "recipientNo":"01000000001",
         "recipientGroupingKey":"RecipientGroupingKey2"
      }
   ]
}

[Response]

{
   "header":{
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "statusCode":"2",
         "senderGroupingKey":"SenderGroupingKey",
         "sendResultList":[
            {
               "recipientNo":"01000000000",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":1,
               "recipientGroupingKey":"RecipientGroupingKey"
            },
            {
               "recipientNo":"01000000001",
               "resultCode":0,
               "resultMessage":"SUCCESS",
               "recipientSeq":2,
               "recipientGroupingKey":"RecipientGroupingKey2"
            }
         ]
      }
   }
}

認証用SMS送信リストの照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/auth/sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter] * requestIdまたはstartRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。 * 登録日時と発信日時を同時に照会する場合、発信日時は無視されます。

タイプ 最大 必須 説明
requestId String 25 必須 リクエストID
startRequestDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startCreateDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endCreateDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startResultDate String - オプション 受信日の開始値(yyyy-MM-dd HH:mm:ss)
endResultDate String - オプション 受信日の終了値(yyyy-MM-dd HH:mm:ss)
sendNo String 13 オプション 発信番号
recipientNo String 20 オプション 受信番号
templateId String 50 オプション テンプレート番号
msgStatus String 1 オプション メッセージステータスコード(0:失敗、1:リクエスト、2:処理中、3:成功、4:送信取消、5:重複送信)
resultCode String 10 オプション 受信結果コード[照会コード表]
subResultCode String 10 オプション 受信結果詳細コード[照会コード表]
senderGroupingKey String 100 オプション 送信者グループキー
recipientGroupingKey String 100 オプション 受信者グループキー
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/auth/sms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header":{
      "resultCode":0,
      "resultMessage":"SUCCESS",
      "isSuccessful":true
   },
   "body":{
      "pageNum":1,
      "pageSize":15,
      "totalCount":1,
      "data":[
         {
            "requestId":"20180810100630ReZQ6KZzAH0",
            "requestDate":"2018-08-10 10:06:30.0",
            "resultDate":"2018-08-10 10:06:42.0",
            "templateId":"TemplateId",
            "templateName":"テンプレート名",
            "categoryId":0,
            "categoryName":"カテゴリー名",
            "body":"短文テスト",
            "sendNo":"15446859",
            "countryCode":"82",
            "recipientNo":"01000000000",
            "msgStatus":"3",
            "msgStatusName":"成功",
            "resultCode":"1000",
            "resultCodeName":"成功",
            "telecomCode":10001,
            "telecomCodeName":"SKT",
            "mtPr":"1",
            "sendType":"0",
            "userId":"tester",
            "adYn":"N",
            "resultMessage": "",
            "senderGroupingKey":"SenderGroupingKey",
            "recipientGroupingKey":"RecipientGroupingKey"
         }
      ]
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].requestId String リクエストID
body.data[].requestDate String 発信日時
body.data[].resultDate String 受信日時
body.data[].templateId String テンプレートID
body.data[].templateName String テンプレート名
body.data[].categoryId String カテゴリーID
body.data[].categoryName String カテゴリー名
body.data[].body String 本文内容
body.data[].sendNo String 発信番号
body.data[].countryCode String 国番号
body.data[].recipientNo String 受信番号
body.data[].msgStatus String メッセージステータスコード
body.data[].msgStatusName String メッセージステータスコード名
body.data[].resultCode String 受信結果コード[受信結果コード表]
body.data[].resultCodeName String 受信結果コード名
body.data[].telecomCode Integer サービスプロバイダーコード
body.data[].telecomCodeName String サービスプロバイダー名
body.data[].mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].userId String 送信リクエストID
body.data[].adYn String 広告かどうか
body.data[].senderGroupingKey String 発信者グループキー
body.data[].recipientGroupingKey String 受信者グループキー

認証用SMS送信の単一照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/sender/auth/sms/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID

[Query parameter]

タイプ 必須 説明
mtPr Integer 必須 送信詳細ID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/auth/sms/'"${REQUEST_ID}"'?mtPr='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header":{
      "resultCode":0,
      "resultMessage":"SUCCESS",
      "isSuccessful":true
   },
   "body":{
      "data":{
         "requestId":"20180810100630ReZQ6KZzAH0",
         "requestDate":"2018-08-10 10:06:30.0",
         "resultDate":"2018-08-10 10:06:42.0",
         "templateId":"TemplateId",
         "templateName":"テンプレート名",
         "categoryId":0,
         "categoryName":"カテゴリー名",
         "body":"本文",
         "sendNo":"15446859",
         "countryCode":"82",
         "recipientNo":"01000000000",
         "msgStatus":"3",
         "msgStatusName":"成功",
         "resultCode":"1000",
         "resultCodeName":"成功",
         "telecomCode":10001,
         "telecomCodeName":"SKT",
         "mtPr":"1",
         "sendType":"0",
         "userId":"tester",
         "adYn":"N",
         "resultMessage": "",
         "senderGroupingKey":"SenderGroupingKey",
         "recipientGroupingKey":"recipientGroupingKey"
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.requestDate String 発信日時
body.data.resultDate String 受信日時
body.data.templateId String テンプレートID
body.data.templateName String テンプレート名
body.data.categoryId String カテゴリーID
body.data.categoryName String カテゴリー名
body.data.body String 本文内容
body.data.sendNo String 発信番号
body.data.countryCode String 国番号
body.data.recipientNo String 受信番号
body.data.msgStatus String メッセージステータスコード
body.data.msgStatusName String メッセージステータスコード名
body.data.resultCode String 受信結果コード[受信結果コード表]
body.data.resultCodeName String 受信結果コード名
body.data.telecomCode Integer サービスプロバイダーコード
body.data.telecomCodeName String サービスプロバイダー名
body.data.mtPr Integer 送信詳細ID(詳細照会時は必須)
body.data.sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data.userId String 送信リクエストID
body.data.adYn String 広告かどうか
body.data.senderGroupingKey String 発信者グループキー
body.data.recipientGroupingKey String 受信者グループキー

広告文字

広告性SMS送信

[URL]

POST  /sms/v2.3/appKeys/{appKey}/sender/ad-sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body] 上のSMS送信と同じ。 [Request Body参考]

ただし、本文に下記の文言を入れる必要があります。 080番号はコンソールの080受信拒否設定タブで確認できます。

(広告)

[無料受信拒否]080XXXXXXX

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/ad-sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "body": "(광고) Test\n [무료 수신 거부]0808880327",
    "sendNo": "15446859",
    "recipientList": [{
            "recipientNo": "01000000000",
            "templateParameter": {}
        }
    ],
    "userId": ""
}'

広告性MMS送信

※ MMSは韓国外への送信はできません。

[URL]

POST  /sms/v2.3/appKeys/{appKey}/sender/ad-mms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body] 上のMMS送信と同じ。 [Request Body参考]

ただし、本文に下記の文言を入れる必要があります。 080番号はコンソールの080受信拒否設定タブで確認できます。

(広告)

[無料受信拒否]080XXXXXXX

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/ad-mms' \
-H 'Content-Type: application/json;charset=UTF-8'
-d '{
    "title": "{Title}",
    "body": "(광고) Test\n [무료 수신 거부]0808880327",
    "sendNo": "15446859",
    "recipientList": [{
            "recipientNo": "01000000000",
            "templateParameter": {}
        }
    ],
    "userId": ""
}'

結果アップデート基準メッセージ照会

  • 該当APIは、メッセージ送信結果アップデート時間基準で照会されます。
  • 端末送信結果をサービスの外で使用する場合、このAPIを使用してください。

メッセージ照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/message-results?startUpdateDate={startUpdateDate}&endUpdateDate={endUpdateDate}&messageType={messageType}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 必須 説明
startUpdateDate String 必須 結果アップデート照会の開始時間
yyyy-MM-dd HH:mm:ss
endUpdateDate String 必須 結果アップデート照会の終了時間
yyyy-MM-dd HH:mm:ss
messageType String オプション メッセージタイプ(SMS/LMS/MMS/AUTH)
pageNum Integer オプション ページ番号(デフォルト値:1)
pageSize Integer オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/message-results?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "isSuccessful":true,
    "resultCode":0,
    "resultMessage":"Success."
  },
  "body":{
    "pageNum":1,
    "pageSize":15,
    "totalCount":1,
    "data":[
        {
          "messageType":"SMS",
          "requestId":"",
          "recipientSeq":0,
          "resultCode":"1000",
          "resultCodeName":"成功",
          "requestDate":"2018-10-04 16:16:00.0",
          "resultDate":"2018-10-04 16:17:10.0",
          "updateDate":"2018-10-04 16:17:15.0",
          "telecomCode": "10003",
          "telecomCodeName": "LGU",
          "senderGroupingKey":"senderGroupingKey",
          "recipientGroupingKey":"recipientGroupingKey"
        }
    ]
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.resultUpdateList[].messageType String メッセージタイプ(SMS/LMS/MMS/AUTH)
body.data.resultUpdateList[].requestId String リクエストID
body.data.resultUpdateList[].recipientSeq Integer 受信者シーケンス
body.data.resultUpdateList[].resultCode String 結果コード
body.data.resultUpdateList[].resultCodeName String 結果コード名
body.data.resultUpdateList[].requestDate String リクエスト日時(yyyy-MM-dd HH:mm:ss.S)
body.data.resultUpdateList[].resultDate String 受信日時(yyyy-MM-dd HH:mm:ss.S)
body.data.resultUpdateList[].updateDate String 結果アップデート日時(yyyy-MM-dd HH:mm:ss.S)
body.data.resultUpdateList[].telecomCode String サービスプロバイダーコード
body.data.resultUpdateList[].telecomCodeName String サービスプロバイダーコード名
body.data.resultUpdateList[].senderGroupingKey String 発信者グループキー
body.data.resultUpdateList[].recipientGroupingKey String 受信者グループキー

タグ送信

タグSMS送信

リクエスト

[URL]

POST /sms/v2.3/appKeys/{appKey}/tag-sender/sms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
    "body":"本文",
    "sendNo":"15446859",
    "requestDate":"2018-03-22 10:00",
    "templateId":"TemplateId",
    "templateParameter" : {
      "key" : "value"
    },
    "tagExpression":[
        "tag1",
        "AND",
        "tag2"
     ],
    "userId":"user_id",
    "adYn":"N",
    "autoSendYn":"N",
    "statsId":"statsId"
}
タイプ 最大 必須 説明
body String 標準:90バイト、最大:255文字(EUC-KR基準) [注意事項] O 本文内容
sendNo String 13 O 発信番号
requestDate String - X 予約日時(yyyy-MM-dd HH:mm)
templateId String 50 X テンプレートID
templateParameter Map - X テンプレートパラメータ
tagExpression List - O タグ表現式
ex) ["tagA","AND","tabB"]
userId String 100 X リクエストしたユーザーID
adYn String 1 X 広告かどうか(デフォルト値:N)
autoSendYn String 1 X 自動送信(即時送信)するかどうか(デフォルト値:Y)
statsId String 10 X 統計ID(発信検索条件には含まれません)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tag-sender/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "body": "Body",
    "sendNo": "15446859",
    "templateParameter": {
        "key": "value"
    },
    "tagExpression": ["TsNuyRPF"],
    "userId": "user_id",
    "adYn": "N",
    "autoSendYn": "N",
    "statsId": "statsId"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "201808130914102Y94ABMNF30"
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID

タグLMS送信

※ MMSは韓国外への送信はできません。

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/tag-sender/mms
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
    "body":"本文",
    "sendNo":"15446859",
    "requestDate":"2018-03-22 10:00",
    "templateId":"TemplateId",
    "templateParameter" : {
        "key" : "value"
    },
    "attachFileIdList" : [
     1,
     2,
3
    ],
    "tagExpression":[
        "tag1",
        "AND",
        "tag2"
     ],
    "userId":"user_id",
    "adYn":"N",
    "autoSendYn":"N",
    "statsId":"statsId"
}
タイプ 最大 必須 説明
title String 40バイト(EUC-KR基準) O タイトル
body String 2000バイト(EUC-KR基準) O 内容
sendNo String 13 O 発信番号
requestDate String - X 予約日時(yyyy-MM-dd HH:mm)
templateId String 50 X テンプレートID
templateParameter Map - X テンプレートパラメータ
tagExpression List - O タグ表現式
ex) ["tagA","AND","tabB"]
attachFileIdList List - X 添付ファイルID(fileId)
userId String 100 X リクエストしたユーザーID
adYn String 1 X 広告かどうか(デフォルト値:N)
autoSendYn String 1 X 自動送信(即時送信)するかどうか(基本Y)
statsId String 10 X 統計ID(発信検索条件には含まれません)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tag-sender/mms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "title": "Title",
    "body": "Body",
    "sendNo": "15446859",
    "templateParameter": {
        "key": "value"
    },
    "tagExpression": ["TsNuyRPF"],
    "userId": "user_id",
    "adYn": "N",
    "autoSendYn": "Y"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "201808130914102Y94ABMNF30"
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID

タグ送信リストの照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/tag-sender

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter] * requestIdまたはstartRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。

タイプ 最大 必須 説明
appKey String - O アプリケーションキー
sendType required, String 1 O 送信タイプ
SMS:"0",
MMS:"1"
requestId String - O リクエストID
startRequestDate String - O 送信日の開始
endRequestDate String - O 送信日の終了
startCreateDate String - O 送信日の開始値
endCreateDate String - O 送信日の終了値
statusCode String 10 X 送信ステータスコード
WAIT:"MAS00"
READY:"MAS01"
SENDREADY:"MAS09"
SENDWAIT:"MAS10"
SENDING:"MAS11"
COMPLETE:"MAS19"
CANCEL:"MAS91"
FAIL:"MAS99"
pageNum optional, Integer - X ページ番号
pageSize optional, Integer 1000 X 照会数

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tag-sender?requestId='"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header" : {
    "isSuccessful" :  true,
    "resultCode" :  0,
    "resultMessage" :  "."
    },
    "body":{
        "pageNum":0,
        "pageSize":0,
        "totalCount":0,
        "data" :[{
                "requestId": "20171220141558eonMsyDI6P0",
                "requestIp": "127.0.0.1",
                "sendType": "0",
                "templateId": "TemplateId",
                "templateName": "テンプレート名",
                "masterStatusCode": "READY",
                "sendNo": "15446859",
                "requestDate": "2017-12-20 14:15:58",
                "tagExpression": [
                    "Kb6BjCY1"
                ],
                "title": "タイトル",
                "body": "本文",
                "adYn": "N",
                "autoSendYn": "Y",
                "sendErrorCount": 0,
                "createUser": "CreateUser",
                "createDate": "2017-12-20 14:15:58.0",
                "updateUser": "UpdateUser",
                "updateDate": "2017-12-20 14:15:58.0"
            }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data[].requestId String リクエストID
body.data[].requestIp String リクエストIP
body.data[].requestDate String リクエスト時間
body.data[].tagSendStatus String タグ送信ステータス
body.data[].tagExpression[] List タグ表現式
body.data[].templateId String テンプレートID
body.data[].templateName String テンプレート名
body.data[].senderName String 発信者名
body.data[].senderMail String 発信者アドレス
body.data[].title String タイトル
body.data[].body String 内容
body.data[].adYn String 広告かどうか
body.data[].autoSendYn String 自動送信するかどうか
body.data[].sendErrorCount Integer エラー受信者件数
body.data[].createUser String 作成者
body.data[].createDate String 作成日時
body.data[].updateUser String 修正したユーザー
body.data[].updateDate String 修正日

タグ送信受信者リストの照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/tag-sender/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID

[Query parameter] * requestIdまたはstartRequestDate + endRequestDateは必須です。

タイプ 最大 必須 説明
recipientNum String 20 X 受信者番号
startRequestDate String - O 送信リクエストの開始日
endRequestDate String - O 送信リクエストの終了日
startResultDate String - X 受信開始日
endResultDate String - X 受信終了日
msgStatusName String 10 X メッセージステータスコード
- READY:準備
- SENDING:送信リクエスト中
- COMPLETED:送信リクエスト完了
- FAILED:送信失敗
resultCode String 10 X 受信結果コード
pageNum Integer - X ページ番号
pageSize Integer 1000 X 照会数

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tag-sender/'"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header" : {
    "isSuccessful" :  true,
    "resultCode" :  0,
    "resultMessage" :  "."
    },
    "body":{
        "pageNum":0,
        "pageSize":0,
        "totalCount":0,
        "data" :[
        {
            "requestId": "20180813022044Jps2xJ1qsv0",
            "recipientSeq": 99,
            "countryCode": "82",
            "recipientNo": "01000000000",
            "requestDate": "2018-08-13 02:20:44.0",
            "msgStatus": "3",
            "msgStatusName": "COMPLETED",
            "resultCode": "3015",
            "receiveDate": "2018-08-13 02:20:53.0",
            "createDate": "2018-08-13 02:20:46.0",
            "updateDate": "2018-08-13 02:27:00.0"
        }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.recipientSeq Integer 受信者シーケンス
body.data.countryCode String 受信者国コード
body.data.recipientNo String 受信者番号
body.data.requestDate String リクエスト日時
body.data.msgStatus String メッセージステータスコード
body.data.msgStatusName String メッセージステータスコード名
body.data.resultCode String 受信結果コード[受信結果コード表]
body.data.receiveDate String 受信日時
body.data.createDate String 登録日時
body.data.updateDate String 修正日

タグ送信受信者リストの詳細照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/tag-sender/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID
recipientSeq String シーケンス

[Request body]

X

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tag-sender/'"${REQUEST_ID}"'/'"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "20180813022044Jps2xJ1qsv0",
            "recipientSeq": 14,
            "sendType": "0",
            "messageType": "SMS",
            "templateId": "TemplateId",
            "templateName": "テンプレート名",
            "sendNo": "15446859",
            "recipientNum": "01000000000",
            "countryCode": "82",
            "title": "タイトル",
            "body": "本文",
            "requestDate": "2018-08-13 02:20:44.0",
            "msgStatusName": "COMPLETED",
            "msgStatus": "3",
            "resultCode": "3015",
            "receiveDate": "2018-08-13 02:20:48.0",
            "attachFileList": []
        }
    }
}
タイプ 説明
header Object ヘッダ領域
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestId String リクエストID
body.data.recipientSeq Integer 受信者シーケンス
body.data.sendType String 送信タイプ
body.data.messageType String メッセージタイプ
body.data.templateId String テンプレートID
body.data.templateName String テンプレート名
body.data.sendNo String 発信番号
body.data.title String タイトル
body.data.body String 内容
body.data.recipientNum String 受信者番号
body.data.requestDate String リクエスト日時
body.data.msgStatusName String メッセージのステータス名
body.data.resultCode String 受信結果コード[受信結果コード表]
body.data.receiveDate String 受信日時
body.data.attachFileList[].filePath String 添付ファイル - パス
body.data.attachFileList[].fileName String 添付ファイル - ファイル名
body.data.attachFileList[].fileSize Long 添付ファイル - サイズ
body.data.attachFileList[].fileSequence Integer 添付ファイル - ファイル番号
body.data.attachFileList[].createDate String 添付ファイル - 作成日時
body.data.attachFileList[].updateDate String 添付ファイル - 修正日

添付ファイル

添付ファイルのアップロード

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/attachfile/binaryUpload
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
    "fileName": "attachment.jpg",
    "createUser": "CreateUser",
    // "fileBody": [0,10,16]
    "fileBody": "{byte[] -> Base64エンコードした値}"
}
タイプ 最大 必須 説明
fileName String 45 必須 ファイル名(拡張子はjpg、jpeg(小文字)のみ可能)
fileBody Byte[] 300KB 必須 ファイルbyte[]をBase64でエンコードした値。
* またはバイト配列値
createUser String 100 必須 ファイルアップロードユーザー情報

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/attachfile/binaryUpload' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "fileName": "attachement.jpg",
    "createUser": "API Guide",
    "fileBody": "1234567890"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "fileId": 0,
            "fileName": "attachment.jpg",
            "filePath": "0/toast-mt-2018-08-10/1609/178576"
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.fileId Integer ファイルID
body.data.fileName String ファイル名
body.data.filePath String 添付ファイルの基本パス
(https://domain/attachFile/filePath/fileName)

添付ファイルのアップロード例

Http method URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/attachfile/binaryUpload

[Request body]

{
  "fileName": "attachement.jpg",
  "createUser": "CreateUser",
  "fileBody": "/9j/4AAQSkZJRgABAQEAYABgAAD/4RDSRXhpZgAATU0AKgAAAAgABAE7AAIAAAAESkdHAIdpAAQAAAABAAAISpydAAEAAAAIAAAQwuocAAcAAAgMAAAAPgAAAAAc6gAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFkAMAAgAAABQAABCYkAQAAgAAABQAABCskpEAAgAAAAM1MgAAkpIAAgAAAAM1MgAA6hwABwAACAwAAAiMAAAAABzqAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMjAxODowMjowOCAxNjoyOTo0MQAyMDE4OjAyOjA4IDE2OjI5OjQxAAAASgBHAEcAAAD/4QsWaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49J++7vycgaWQ9J1c1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCc/Pg0KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyI+PHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj48cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0idXVpZDpmYWY1YmRkNS1iYTNkLTExZGEtYWQzMS1kMzNkNzUxODJmMWIiIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIvPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIj48eG1wOkNyZWF0ZURhdGU+MjAxOC0wMi0wOFQxNjoyOTo0MS41MTc8L3htcDpDcmVhdGVEYXRlPjwvcmRmOkRlc2NyaXB0aW9uPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj48ZGM6Y3JlYXRvcj48cmRmOlNlcSB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6bGk+SkdHPC9yZGY6bGk+PC9yZGY6U2VxPg0KCQkJPC9kYzpjcmVhdG9yPjwvcmRmOkRlc2NyaXB0aW9uPjwvcmRmOlJERj48L3g6eG1wbWV0YT4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgPD94cGFja2V0IGVuZD0ndyc/Pv/bAEMABwUFBgUEBwYFBggHBwgKEQsKCQkKFQ8QDBEYFRoZGBUYFxseJyEbHSUdFxgiLiIlKCkrLCsaIC8zLyoyJyorKv/bAEMBBwgICgkKFAsLFCocGBwqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKv/AABEIABoAHQMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APD6K6e88IxWemTamdQaSx+zW8trJ5GDPJLkGMjd8u0pKCcn7nTmq/jDTbHSvH2qadao1vY2940aqmZGRAe24/MQPU8+tVs7ev4f8OT0uYFFdvrmhWmo/Ee30wXVpp9rcWlvIs0FmIAQbZXX90ZCPMbgY34LHqM1zes6bbaXq81mHv18rAK3tiLeZWxyGj3tt/M5HpTWrsGyv/Wpb1bXIp/DekaLYzXEsFj5kztcRhP3shGVUBmyq44ORksxwM1JrfiyLXtSa/u/DmkpdSXHnzyRPdDz/VWBmIAPfaFPoRXO0UgOk1Pxemq6vb3914d0jMMAgeFftBjmRYxGgbMpYFVUYKlTnqTWfruuz69dQSTW8FrFa26W1vb24bZFGucKC7Mx5JOWYnn0wKy6KAP/2Q=="
}

[Response]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "fileId": 0,
            "fileName": "attachment.jpg",
            "filePath": "0/toast-mt-2018-08-10/1609/178576"
        }
    }
}

カテゴリー

カテゴリーの登録

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/categories
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "categoryParentId" : 0,
   "categoryName" : "",
   "categoryDesc" : "",
   "useYn" : "",
   "createUser" : ""
}
タイプ 最大文字数 必須 説明
categoryParentId Integer - オプション 親カテゴリーID [デフォルト値:最上位カテゴリー]
categoryName String 50 必須 カテゴリーID
categoryDesc String 100 オプション カテゴリー名
useYn String 1 必須 使用有無(Y/N)
createUser String 100 オプション 登録したユーザー

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/categories' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "categoryParentId": 0,
    "categoryName": "API Guide",
    "categoryDesc": "API Guide Test",
    "useYn": "Y",
    "createUser": "API Guide"
}'
説明
  • categoryParentId値が空の場合、最上位カテゴリーのすぐ下に登録されます。

レスポンス

{  
   "header":{  
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{  
      "data":{  
         "categoryId":0,
         "categoryParentId":0,
         "depth":0,
         "sort":0,
         "categoryName":"",
         "categoryDesc":"",
         "useYn":"",
         "createUser":""
      }
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data[].categoryId Integer カテゴリーID
body.data[].categoryParentId Integer 親カテゴリーID
body.data[].depth Integer カテゴリーの深さ
body.data[].sort Integer カテゴリーソート順序
body.data[].categoryName String カテゴリー名
body.data[].categorycategoryDescame String カテゴリーの説明
body.data[].useYn String 使用有無
body.data[].createUser String 登録したユーザー

カテゴリーリストの照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/categories
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大文字数 必須 説明
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/categories' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{  
   "header":{  
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{  
      "pageNum":1,
      "pageSize":15,
      "totalCount":1,
      "data":[  
         {  
            "categoryId":137612,
            "categoryParentId":0,
            "depth":0,
            "sort" :0,
            "categoryName":"カテゴリー",
            "categoryDesc":"最上位カテゴリー",
            "useYn":"Y",
            "createDate":"2018-04-17 15:39:56.0",
            "createUser":"bb076dc0-ef5e-11e7-9ede-005056ac7022",
            "updateDate":"2018-04-17 15:39:56.0",
            "updateUser":"bb076dc0-ef5e-11e7-9ede-005056ac7022"
         }
      ]
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer データ総数
body.data[].categoryId Integer カテゴリーID
body.data[].categoryParentId Integer 親カテゴリーID
body.data[].depth Integer カテゴリーの深さ
body.data[].sort Integer カテゴリーソート順序
body.data[].categoryName String カテゴリー名
body.data[].categorycategoryDescame String カテゴリーの説明
body.data[].useYn String 使用有無
body.data[].createDate String 登録日
body.data[].createUser String 登録したユーザー
body.data[].updateDate String 修正日
body.data[].updateUser String 修正したユーザー

カテゴリーの単件照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
categoryId String カテゴリーID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{  
   "header":{  
      "isSuccessful":true,
      "resultCode":0,
      "resultMessage":"SUCCESS"
   },
   "body":{  
      "data":[  
         {  
            "categoryId":137612,
            "categoryParentId":0,
            "depth":0,
            "sort":0,
            "categoryName":"カテゴリー",
            "categoryDesc":"最上位カテゴリー",
            "useYn":"Y",
            "createDate":"2018-04-17 15:39:56.0",
            "createUser":"bb076dc0-ef5e-11e7-9ede-005056ac7022",
            "updateDate":"2018-04-17 15:39:56.0",
            "updateUser":"bb076dc0-ef5e-11e7-9ede-005056ac7022"
         }
      ]
   }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data[].categoryId Integer カテゴリーID
body.data[].categoryParentId Integer 親カテゴリーID
body.data[].depth Integer カテゴリーの深さ
body.data[].sort Integer カテゴリーソート順序
body.data[].categoryName String カテゴリー名
body.data[].categorycategoryDescame String カテゴリーの説明
body.data[].useYn String 使用有無
body.data[].createDate String 登録日
body.data[].createUser String 登録したユーザー
body.data[].updateDate String 修正日
body.data[].updateUser String 修正したユーザー

カテゴリーの修正

リクエスト

[URL]

PUT  /sms/v2.3/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
categoryId String カテゴリーID

[Request body]

{
   "categoryName" : "",
   "categoryDesc" : "",
   "useYn" : "",
   "updateUser" : ""
}
タイプ 最大文字数 必須 説明
categoryName String 50 必須 カテゴリーID
categoryDesc String 100 オプション カテゴリー名
useYn String 1 必須 使用有無(Y/N)
updateUser String 100 オプション 修正したユーザー

cURL

curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/categories/'"${C_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "categoryParentId": 788,
    "categoryName": "secondMMS",
    "categoryDesc": "second category MMS",
    "useYn": "Y",
    "createUser": "467d9790-ea74-11e5-9ad3-005056ac76e8"
}'

レスポンス

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}

カテゴリーの削除

リクエスト

[URL]

DELETE  /sms/v2.3/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
categoryId String カテゴリーID

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}

テンプレート

テンプレートの登録

リクエスト

[URL]

POST  /sms/v2.3/appKeys/{appKey}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "categoryId" : 0,
   "templateId" : "",
   "templateName" : "",
   "templateDesc" : "",
   "sendNo" : "",
   "sendType" : "",
   "title" : "",
   "body" : "",
   "useYn" : "",
   "attachFileIdList" : [
      0,
1
   ]
}
タイプ 最大文字数 必須 説明
categoryId Integer - 必須 カテゴリーID
templateId String 50 必須 テンプレートID
templateName String 50 必須 テンプレート名
templateDesc String 100 オプション テンプレートの説明
sendNo String 13 必須 発信番号
sendType String 1 必須 送信タイプ(0:Sms、1:Lms/Mms)
title String 120 オプション メッセージのタイトル(送信タイプがLms/MmSの場合は必須)
body String 4000 必須 メッセージの内容
useYn String 1 必須 使用有無(Y/N)
attachFileIdList List - X 添付ファイルID(fileId)

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "categoryId": 199376,
    "templateId": "TemplateId",
    "templateName": "Template Name",
    "templateDesc": "Temaplte Description",
    "sendNo": "01012341234",
    "sendType": "1",
    "title": "example",
    "body": "Test\r\n##key1## Test\r\n##key2## Test",
    "useYn": "Y"
}'

レスポンス

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}

テンプレートの登録例

Http method URL
POST https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/templates

[Request body]

{
   "categoryId" : 199376 ,
   "templateId" : "TemplateId",
   "templateName" : "テンプレート送信例",
   "templateDesc" : "テンプレート送信例",
   "sendNo" : "01012341234",
   "sendType" : "1",
   "title" : "example",
   "body" : "一般送信テスト用です。\r\n##key1##さん。\r\n##key2## です。",
   "useYn" : "Y",
   "attachFileIdList" : [
     123123,
456456
   ]
}

[Response]

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}
説明
  • 添付ファイル(フィールド名:attachFileIdList)を含むテンプレートの登録するためには、事前に添付ファイルのアップロードを行う必要があります。
  • [添付ファイルアップロード] ガイドを参照してください。
  • 付イメージ制限事項
    • サポートコーデック:.jpg
    • 添付イメージ数:2個以下
    • 添付イメージサイズ:300KB以下
    • 添付イメージ解像度:1000 x 1000以下

テンプレート送信(本文修正が必要ない場合)

Http method 種類 URL
POST SMS https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/sms
POST MMS https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/mms

Request URLは、テンプレート登録時に選択した送信タイプに選択して送信します。

Request parameter body内の値が空欄の場合、該当templateIdのbody内容に置換します。

[Request body]置換するキーと値をkey、valueに代入。

{
    "templateId": "TemplateId",
    "senderGroupingKey": "SenderGroupingKey",
    "recipientList": [{
        "recipientNo": "01000000000",
        "templateParameter": {
          "key1" : "Toast Cloud",
          "key2" : "SMS"
        },
        "recipientGroupingKey": "RecipientGroupingKey"
    }]
}

[Response]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "requestId": "20180813095534I4VcVuPBpd0",
            "statusCode": "2",
            "senderGroupingKey": "SenderGroupingKey",
            "sendResultList": [
                {
                    "recipientNo": "01000000000",
                    "resultCode": 0,
                    "resultMessage": "SUCCESS",
                    "recipientSeq": 1,
                    "recipientGroupingKey": "RecipientGroupingKey"
                }
            ]
        }
    }
}

[図1]テンプレート送信に成功

テンプレート送信(本文修正が必要な場合)

テンプレート送信例

Http method 種類 URL
POST SMS https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/sms
POST MMS https://api-sms.cloud.toast.com/sms/v2.3/appKeys/{appKey}/sender/mms

Request URLは、テンプレート登録時に選択した送信タイプに選択して送信します。

テンプレートIDとRequest parameter body内の値がある場合、発信番号と発信内容がテンプレート内容に置換されません。

ただし、テンプレートIDを入力した場合、該当テンプレートで照会できます。

上記のような場合は、テンプレートを照会した後、テンプレートの内容を修正したい時に使用できます。

[Request body]

{
    "templateId": "TemplateId",
    "body":"本文",
    "sendNo":"15446859",
    "senderGroupingKey": "SenderGroupingKey",
    "recipientList": [{
        "recipientNo": "01000000000",
        "templateParameter": {
          "key1" : "Toast Cloud",
          "key2" : "SMS"
        },
        "recipientGroupingKey": "RecipientGroupingKey"
    }]
}

[Response]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "requestId": "20180813095534I4VcVuPBpd0",
            "statusCode": "2",
            "senderGroupingKey": "SenderGroupingKey",
            "sendResultList": [
                {
                    "recipientNo": "01000000000",
                    "resultCode": 0,
                    "resultMessage": "SUCCESS",
                    "recipientSeq": 1,
                    "recipientGroupingKey": "RecipientGroupingKey"
                }
            ]
        }
    }
}

テンプレートリストの照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 必須 説明
categoryId Integer オプション カテゴリーID
useYn String オプション 使用(Y/N)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": {
        "pageNum": Integer,
        "pageSize": Integer,
        "totalCount": Integer,
        "data": [{
            "templateId": "TemplateId",
            "serviceId": 0,
            "categoryId": 0,
            "categoryName": "カテゴリー名",
            "sort": 0,
            "templateName": "テンプレート名",
            "templateDesc": "テンプレートの説明",
            "useYn": "Y",
            "priority": "S",
            "sendNo": ""15446859String"",
            "sendType": "0",
            "sendTypeName": "SMS送信",
            "title": "タイトル",
            "body": "本文",
            "attachFileYn": "N",
            "delYn": "N",
            "createDate": "2018-01-28 17:50:55.0,
            "createUser": "CreateUser",
            "updateDate": "2018-01-28 17:50:55.0",
            "updateUser": "UpdateUser",
            "attachFileList": [{
                "fileId": 0,
                "serviceId": 0,
                "attachType": 0,
                "templateId": "TemplateId",
                "filePath": "26606/toast-mt-2018-01-29/1427/105316",
                "fileName": "attachment.jpg",
                "fileSize": 0,
                "createDate": "2018-01-28 17:50:55.0",
                "createUser": "CreateUser"
            }]
        }]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].templateId String テンプレートID
body.data[].serviceId Integer サービスID(内部用、未使用値)
body.data[].categoryId Integer カテゴリーID
body.data[].categoryName String カテゴリー名
body.data[].sort Integer ソート値
body.data[].templateName String テンプレート名
body.data[].templateDesc String テンプレートの説明
body.data[].useYn String 使用するかどうか
body.data[].priority String 優先順位値(未使用値)
body.data[].sendNo String 発信番号
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].sendTypeName String 送信タイプ名
body.data[].title String タイトル
body.data[].body String 本文内容
body.data[].attachFileYn String 添付ファイルの有無(Y/N)
body.data[].delYn String 削除されているかどうか(Y/N)、現在ステータスの表記用にのみ使用
body.data[].createDate String 登録日
body.data[].createUser String 登録したユーザー
body.data[].updateDate String 修正日
body.data[].updateUser String 修正したユーザー
body.data[].attachFileList[].fileId Integer 添付ファイルID
body.data[].attachFileList[].serviceId Integer サービスID(内部用、未使用値)
body.data[].attachFileList[].attachType Integer 添付ファイルのアップロードタイプ(0:臨時、1:アップロード、2:テンプレート)
body.data[].attachFileList[].templateId String テンプレートID
body.data[].attachFileList[].filePath String 添付ファイルのパス
body.data[].attachFileList[].fileName String 添付ファイル名
body.data[].attachFileList[].fileSize Integer ファイルサイズ
body.data[].attachFileList[].createDate String 添付ファイルの登録日
body.data[].attachFileList[].createUser String 添付ファイルの登録ユーザー

テンプレートの単一照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
templateId String テンプレートID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": {
        "pageNum": Integer,
        "pageSize": Integer,
        "totalCount": Integer,
        "data": {
            "templateId": "TemplateId",
            "serviceId": 0,
            "categoryId": 0,
            "categoryName": "カテゴリー名",
            "sort": 0,
            "templateName": "テンプレート名",
            "templateDesc": "テンプレートの説明",
            "useYn": "Y",
            "priority": "S",
            "sendNo": ""15446859String"",
            "sendType": "0",
            "sendTypeName": "SMS送信",
            "title": "タイトル",
            "body": "本文",
            "attachFileYn": "N",
            "delYn": "N",
            "createDate": "2018-01-28 17:50:55.0,
            "createUser": "CreateUser",
            "updateDate": "2018-01-28 17:50:55.0",
            "updateUser": "UpdateUser",
            "attachFileList": [{
                "fileId": 0,
                "serviceId": 0,
                "attachType": 0,
                "templateId": "TemplateId",
                "filePath": "26606/toast-mt-2018-01-29/1427/105316",
                "fileName": "attachment.jpg",
                "fileSize": 0,
                "createDate": "2018-01-28 17:50:55.0",
                "createUser": "CreateUser"
            }]
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data.templateId String テンプレートID
body.data.serviceId Integer サービスID(内部用、未使用値)
body.data.categoryId Integer カテゴリーID
body.data.categoryName String カテゴリー名
body.data.sort Integer ソート値
body.data.templateName String テンプレート名
body.data.templateDesc String テンプレートの説明
body.data.useYn String 使用するかどうか
body.data.priority String 優先順位値(未使用値)
body.data.sendNo String 発信番号
body.data.sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data.sendTypeName String 送信タイプ名
body.data.title String タイトル
body.data.body String 本文内容
body.data.attachFileYn String 添付ファイル有無(Y/N)
body.data.delYn String 削除されているかどうか(Y/N)、現在ステータスの表記用にのみ使用
body.data.createDate String 登録日
body.data.createUser String 登録したユーザー
body.data.updateDate String 修正日
body.data.updateUser String 修正したユーザー
body.data.attachFileList[].fileId Integer 添付ファイルID
body.data.attachFileList[].serviceId Integer サービスID(内部用、未使用値)
body.data.attachFileList[].attachType Integer 添付ファイルのアップロードタイプ(0:臨時、1:アップロード、2:テンプレート)
body.data.attachFileList[].templateId String テンプレートID
body.data.attachFileList[].filePath String 添付ファイルのパス
body.data.attachFileList[].fileName String 添付ファイル名
body.data.attachFileList[].fileSize Integer ファイルサイズ
body.data.attachFileList[].createDate String 添付ファイルの登録日
body.data.attachFileList[].createUser String 添付ファイル登録ユーザー

テンプレートの修正

リクエスト

[URL]

PUT  /sms/v2.3/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
   "templateName" : "",
   "templateDesc" : "",
   "sendNo" : "",
   "sendType" : "",
   "title" : "",
   "body" : "",
   "useYn" : "",
   "attachFileIdList" : [
      0,
1
   ]
}
タイプ 最大文字数 必須 説明
templateName String 50 必須 テンプレート名
templateDesc String 100 オプション テンプレートの説明
sendNo String 13 必須 発信番号
sendType String 1 必須 送信タイプ(0:Sms、1:Lms/Mms)
title String 120 オプション メッセージのタイトル(送信タイプがLms/MmSの場合は必須)
body String 4000 必須 メッセージの内容
useYn String 1 必須 使用有無(Y/N)
attachFileIdList List - X 添付ファイルID(fileId)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}

テンプレートの削除

リクエスト

[URL]

DELETE  /sms/v2.3/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
templateId String テンプレートID

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
   "header" : {
      "isSuccessful" : true,
      "resultCode" : "",
      "resultMessage" : ""
   }
}

080受信拒否サービス

受信拒否対象者を登録

リクエスト

[URL]

POST /sms/v2.3/appKeys/{appKey}/blockservice/recipients
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
    "unsubscribeNo":"0800000000",
    "recipientNoList":["0100000000", "0100000001"]
}
タイプ 最大文字数 必須 説明
unsubscribeNo String 25 O 080受信拒否番号
recipientNoList List 10 O 追加する受信拒否対象者番号

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/blockservice/recipients' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "unsubscribeNo": "0800000000",
    "recipientNoList": ["0100000000", "0100000001"]
}'

レスポンス

{
   "header":{
       "isSuccessful":true,
       "resultCode":0,
       "resultMessage":"Success"
   }
}

受信拒否対象者の照会

リクエスト

[URL]

GET  /sms/v2.3/appKeys/{appKey}/blockservice/recipients
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大 必須 説明
unsubscribeNo String 25 必須 080受信拒否番号
startRequestDate String - オプション 受信拒否リクエストの開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - オプション 受信拒否リクエストの終了値(yyyy-MM-dd HH:mm:ss)
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/blockservice/recipients' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 1,
        "data": [
            {
              "unsubscribeNo": "0808888888",
              "recipientNo": "01000000000",
              "requestDate": "2018-05-14 17:07:29.0"
            }
        ]
    }
}

受信拒否対象者の削除

リクエスト

[URL]

DELETE  /sms/v2.3/appKeys/{appKey}/blockservice/recipients/removes?unsubscribeNo={unsubscribeNo}&updateUser={updateUser}&recipientNoList={recipientNo},{recipientNo}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大 必須 説明
unsubscribeNo String 20 必須 080受信拒否番号
updateUser String 100 必須 受信拒否削除者
recipientNo String 20 必須 削除する受信拒否番号

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/blockservice/recipients/removes?unsubscribeNo='"${UNSUB_NO}"'&updateUser='"${UPDATE_USER}"'&recipientNoList='"${RECIPIENT_NO}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": boolean,
        "resultCode": Integer,
        "resultMessage": String
    },
    "body": null
}

発信番号

発信番号登録リクエスト

リクエスト

[URL]

POST /sms/v2.3/appKeys/{appKey}/requests/sendNos|
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
  "sendNos" : [
    String,
    String
  ],
  "fileIds" : [
    Integer
  ],
  "comment" :  String
}

タイプ 最大 必須 説明
sendNos[] List - 必須 発信番号
fileIds[] List - オプション アップロードした書類のファイルID
comment String 4000 オプション 発信番号承認者へのコメント

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reqeusts/sendNos' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "sendNos": ["1588"],
    "fileIds": [1],
    "comment": "Test"
}'

レスポンス

{
  "header" : {
    "isSuccessful" :  Boolean,
    "resultCode" :  Integer,
    "resultMessage" :  String
  }
}

発信番号書類のアップロード

リクエスト

[URL]

POST /sms/v2.3/appKeys/{appKey}/requests/attachFiles/authDocuments
Content-Type : multipart/form-data;

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

タイプ 説明
attachFile MultiPartFile MultiPartFileで受け取れないファイルデータ

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/requests/attachFiles/authDocuments' \
-H 'Content-Type: multipart/form-data' \
-F 'attachFile=@/home/doc.dpf'

レスポンス

{
  "header" : {
    "isSuccessful" :  Boolean,
    "resultCode" :  Integer,
    "resultMessage" :  String
    },
    "file" : {
      "fileId" :  Integer,
      "fileName" : String,
      "filePath" : String
    }
  }

発信番号認証リクエスト履歴の照会API

リクエスト

[URL]

Http method URI
GET /sms/v2.3/appKeys/{appKey}/requests/sendNos?sendNo={sendNo}&status={status}&pageNum={pageNum}&pageSize={pageSize}

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 説明
sendNo String 登録リクエストした発信番号
status String 書類認証ステータス
- SRS01 発信番号の登録リクエスト
- SRS02 審査中
- SRS03 登録完了
- SRS04 登録不可
- SRS05 携帯電話認証の待機
- SRS06 携帯電話認証の失敗
- SRS07 手動登録の完了
pageNum Integer ページ番号(デフォルト値:1)
pageSize Integer 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/requests/sendNos' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "isSuccessful":true,
    "resultCode":0,
    "resultMessage":"SUCCESS"
  },
  "body":{
    "pageNum":1,
    "pageSize":15,
    "totalCount":1,
    "data":[
      {
        "authType":"{SMS_AUTH|DOCUMENT_AUTH|MANUAL_REGIST_AUTH}",
        "sendNos":[
          "01000000000",
          "01011111111"
        ],
        "comment":"{comment}",
        "fileIds":null,
        "status":"{REGIST_REQUEST|EXAMINE|COMPLETE|REJECT|CERTIFYING|CERTIFY_FAILED|MANUAL_REGIST}",
        "createDate":"2018-08-14 16:34:54",
        "updateDate":"2018-08-14 16:34:54",
        "confirmDate":"2018-08-14 16:34:54"
      }
    ]
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].authType String リクエスト認証タイプ
- SMS_AUTH:SMS認証
- DOCUMENT_AUTH:書類認証
- REGIST_AUTH:手動認証
body.data[].sendNos[] List 登録リクエスト発信番号リスト
body.data[].comment String コメント項目
body.data[].fileIds[] List 書類認証時にアップロードしたファイルID(内部用)
body.data[].status String リクエストステータス
- REGIST_REQUEST(SRS01)
- EXAMINE(SRS02)
- COMPLETE(SRS03)
- REJECT(SRS04)
- CERTIFYING(SRS05)
- CERTIFY_FAILED(SRS06)
- MANUAL_REGIST(SRS07)
body.data[].createDate String 登録日時
body.data[].updateDate String 修正日
body.data[].confirmDate String 承認/拒否日時

登録された発信番号リストの照会API

リクエスト

[URL]

Http method URI
GET /sms/v2.3/appKeys/{appKey}/sendNos?sendNo={sendNo}&useYn={useYn}&blockYn={blockYn}&pageNum={pageNum}&pageSize={pageSize}

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 説明
sendNo String 発信番号
useYn String 使用するかどうか
blockYn String 遮断するかどうか
pageNum Integer ページ番号(デフォルト値:1)
pageSize Integer 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sendNos' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header" : {
        "isSuccessful" :  true,
        "resultCode" :  0,
        "resultMessage" :  ""
    },
    "body" : {
        "pageNum" :  0,
        "pageSize" :  0,
        "totalCount" :  0,
        "data" : [
        {
            "serviceId" :  0,
            "sendNo" :  "",
            "useYn" :  "",
            "blockYn" :  "",
            "blockReason" :  "",
            "createDate" :  "",
            "createUser" :  "",
            "updateDate" :  "",
            "updateUser" :  ""
        }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer ページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].serviceId Integer サービスID
body.data[].sendNo String 発信番号
body.data[].useYn String 使用するかどうか
body.data[].blockYn String 遮断するかどうか
body.data[].blockReason String 遮断理由
body.data[].createDate String 作成日時
body.data[].createUser String 作成者
body.data[].updateDate String 修正日
body.data[].updateUser String 修正したユーザー

統計照会

統計検索 - イベントベース

  • イベント発生時間を基準に収集された統計です。
  • 次の時間を基準に統計が収集されます。
    • リクエスト数(requested):送信リクエスト時間
    • 送信数(sent):通信事業者(ベンダー)に送信リクエストした時間
    • 成功数(received):実際の端末受信時間
    • 失敗数(sentFailed):失敗レスポンスが発生した時間

リクエスト

[URL]

Http method URI
GET /sms/v2.3/appKeys/{appKey}/stats

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長 必須 説明
statisticsType String - 必須 統計区分
NORMAL:基本、 MINUTELY:分別、HOURLY:時間別、DAILY:日別、BY_DAY:時間別、DAY:曜日別
from String - 必須 統計検索開始日
yyyy-MM-dd HH:mm:ss
to String - 必須 統計検索終了日
yyyy-MM-dd HH:mm:ss
statsIds List - オプション 統計IDリスト
messageType String - オプション メッセージタイプ
SMS、LMS、MMS、AUTH
isAd Boolean - オプション 広告かどうか
true/false
templateIds List - オプション テンプレートIDリスト
requestIds List 5 オプション リクエストIDリスト

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/stats?statisticsType='"${STATISTICS_TYPE}"'&from='"${FROM}"'&to='"${TO}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header" : {
        "isSuccessful" : true,
        "resultCode" : 0,
        "resultMessage" : "SUCCESS""
    },
    "body" : {
        "data" :
        [
          {
            "eventDateTime" : "",
            "events" :
            {
              "requested" : 10,
              "sent" : 10,
              "sentFailed" : 0,
              "received" : 0
            }
          }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.eventDateTime String 表示名
分別、時間別、曜日別、月別
body.data.events[].requested Integer リクエスト数
body.data.events[].sent Integer 送信数
body.data.events[].sentFailed Integer 失敗数
body.data.events[].received Integer 成功数

統計検索 - リクエスト時間ベース

  • 送信リクエスト時間を基準に収集された統計です。
  • 次の時間を基準に統計が収集されます。
    • リクエスト数(requested):送信リクエスト時間
    • 送信数(sent):送信リクエスト時間です。数が増加するタイミングは、通信事業者(ベンダー)に送信リクエストした時間です。
    • 成功数(received):送信リクエスト時間です。数が増加するタイミングは実際の端末受信時間です。
    • 失敗数(sentFailed):送信リクエスト時間です。数が増加するタイミングは失敗レスポンスが発生した時間です。

リクエスト

[URL]

Http method URI
GET /sms/v2.3/appKeys/{appKey}/stats/legacy

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長 必須 説明
statisticsType String - 必須 統計区分
NORMAL:基本、 MINUTELY:分別、HOURLY:時間別、DAILY:日別、BY_DAY:時間別、DAY:曜日別
from String - 必須 統計検索開始日
yyyy-MM-dd HH:mm:ss
to String - 必須 統計検索終了日
yyyy-MM-dd HH:mm:ss
statsIds List - オプション 統計IDリスト
messageType String - オプション メッセージタイプ
SMS、LMS、MMS、AUTH
isAd Boolean - オプション 広告かどうか
true/false
templateIds List - オプション テンプレートIDリスト
requestIds List 5 オプション リクエストIDリスト

レスポンス

{
    "header" : {
        "isSuccessful" : true,
        "resultCode" : 0,
        "resultMessage" : "SUCCESS""
    },
    "body" : {
        "data" :
        [
          {
            "eventDateTime" : "",
            "events" :
            {
              "requested" : 10,
              "sent" : 10,
              "sentFailed" : 0,
              "received" : 0,
              "pending" : 0
            }
          }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.eventDateTime String 表示名
分別、時間別、曜日別、月別
body.data.events[].requested Integer リクエスト数
body.data.events[].sent Integer 送信数
body.data.events[].sentFailed Integer 失敗数
body.data.events[].received Integer 成功数
body.data.events[].pending Integer 送信中の数

(旧)統合統計照会

リクエスト

[URL]

Http method URI
GET /sms/v2.3/appKeys/{appKey}/statistics/view?searchType={searchType}&from={from}&to={to}&messageTypes={messageType}&contentTypes={contentType}&templateId={templateId}

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大 必須 説明
searchType String 10 O 統計区分
DATE:日付別、TIME:時間別、DAY:曜日別
from String - O 統計照会開始日時
yyyy-MM-dd HH:mm
to String - O 統計照会の終了日時
yyyy-MM-dd HH:mm
messageType String 10 X メッセージタイプ
SMS:短文、LMS:長文、MMS:添付ファイル、AUTH:認証用
contentType String 10 X コンテンツタイプ
NORMAL:一般、AD:広告
templateId String 50 X テンプレートID

レスポンス

{
    "header" : {
        "isSuccessful" : true,
        "resultCode" : 0,
        "resultMessage" : "SUCCESS""
    },
    "body" : {
        "data" :
        [
          {
            "divisionName" : "2018-06-01",
            "statisticsView" :
            {
              "requestedCount" : 10,
              "succeedCount" : 10,
              "failedCount" : 0,
              "pendingCount" : 0,
              "succeedRate" : "100.00",
              "failedRate" : "0.00",
              "pendingRate" : "0.00"
            }
          }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data[].divisionName String 表示名
日付、時間、曜日
body.data[].statisticsView Object
body.data[].requestedCount Integer リクエスト数
body.data[].succeedCount Integer 成功数
body.data[].failedCount Integer 失敗数
body.data[].pendingCount Integer 送信中の数
body.data[].succeedRate String 成功比率
body.data[].failedRate String 失敗比率
body.data[].pendingRate String 送信中の比率

予約送信

予約送信リストの照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/reservations
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大 必須 説明
sendType String 1 オプション 送信タイプ
(0:SMS、1:LMS/MMS、2:AUTH)
requestId String 25 オプション リクエストID
startRequestDate String - オプション 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - オプション 送信日の終了値(yyyy-MM-dd HH:mm:ss)
startCreateDate String - オプション 送信日の開始値(yyyy-MM-dd HH:mm:ss)
endCreateDate String - オプション 送信日の終了値(yyyy-MM-dd HH:mm:ss)
sendNo String 13 オプション 発信番号
recipientNo String 20 オプション 受信番号
templateId String 50 オプション テンプレート番号
messageStatus String 10 オプション メッセージのステータス
(RESERVED:予約待機、SENDING:送信中、COMPLETED:送信完了、FAILED:送信失敗、CANCEL:予約キャンセル、DUPLICATED:重複送信)
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reservations' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "resultCode":0,
    "resultMessage":"SUCCESS",
    "isSuccessful":true
  },
  "body":{
    "pageNum":1,
    "pageSize":15,
    "totalCount":15,
    "data":[
      {
        "requestId":"{リクエストID}",
        "recipientSeq":1,
        "requestDate":"{予約日}",
        "sendNo":"{発信番号}",
        "recipientNo":"{受信番号}",
        "countryCode":"{国コード}",
        "sendType":"{送信タイプ}",
        "messageType":"{メッセージタイプ}",
        "adYn":"{広告かどうか}",
        "templateId":"{テンプレートID}",
        "templateParameter":"{テンプレートパラメータ}",
        "templateName":"{テンプレート名}",
        "title":"{タイトル}",
        "body":"{内容}",
        "messageStatus":"{メッセージのステータス}",
        "createUser":"{登録したユーザー}",
        "createDate":"{登録日時}",
        "updateDate":"{修正日}"
      }
    ]
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data[].requestId String リクエストID
body.data[].recipientSeq Integer 受信者シーケンス
body.data[].requestDate String 発信日時
body.data[].sendNo String 発信番号
body.data[].recipientNo String 受信番号
body.data[].countryCode String 国番号
body.data[].sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data[].messageType String メッセージタイプ
(SMS,LMS,MMS,AUTH)
body.data[].adYn String 広告かどうか
body.data[].templateId String テンプレートID
body.data[].templateParameter String(json) テンプレートパラメータ
body.data[].templateName String テンプレート名
body.data[].title String タイトル
body.data[].body String 本文内容
body.data[].messageStatus String メッセージのステータス
(RESERVED:予約待機、SENDING:送信中、COMPLETED:送信完了、FAILED:送信失敗、CANCEL:予約キャンセル、DUPLICATED:重複送信)
body.data[].createUser String 登録したユーザー
body.data[].createDate String 登録日
body.data[].updateDate String 修正日

予約送信の詳細照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/reservations/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
requestId String リクエストID
recipientSeq Integer 受信者シーケンス

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reservations/'"${R_ID}"'/'"${R_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "resultCode":0,
    "resultMessage":"SUCCESS",
    "isSuccessful":true
  },
  "body":{
    "data":{
      "requestId":"{リクエストID}",
      "recipientSeq":1,
      "requestDate":"{予約日}",
      "sendNo":"{発信番号}",
      "recipientNo":"{受信番号}",
      "countryCode":"{国コード}",
      "sendType":"{送信タイプ}",
      "messageType":"{メッセージタイプ}",
      "adYn":"{広告かどうか}",
      "templateId":"{テンプレートID}",
      "templateParameter":"{テンプレートパラメータ}",
      "templateName":"{テンプレート名}",
      "title":"{タイトル}",
      "body":"{内容}",
      "messageStatus":"{メッセージのステータス}",
      "createUser":"{登録したユーザー}",
      "createDate":"{登録日時}",
      "updateDate":"{修正日}",
      "attachFileList":[
        {
          "fileId":0,
          "filePath":"26606/toast-mt-2018-02-07/1555/105887/",
          "fileName":"file_attach_test.jpg"
        }
      ]
    }
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer 現在のページ番号
body.pageSize Integer 照会されたデータ数
body.totalCount Integer 総データ数
body.data.requestId String リクエストID
body.data.recipientSeq Integer 受信者シーケンス
body.data.requestDate String 発信日時
body.data.sendNo String 発信番号
body.data.recipientNo String 受信番号
body.data.countryCode String 国番号
body.data.sendType String 送信タイプ(0:Sms、1:Mms、2:Auth)
body.data.messageType String メッセージタイプ
(SMS、LMS、MMS、AUTH)
body.data.adYn String 広告かどうか
body.data.templateId String テンプレートID
body.data.templateParameter String(json) テンプレートパラメータ
body.data.templateName String テンプレート名
body.data.title String タイトル
body.data.body String 本文内容
body.data.messageStatus String メッセージのステータス
(RESERVED:予約待機、SENDING:送信中、COMPLETED:送信完了、FAILED:送信失敗、CANCEL:予約キャンセル、DUPLICATED:重複送信)
body.data.createUser String 登録したユーザー
body.data.createDate String 登録日
body.data.attachFileList[].fileId Integer ファイルID
body.data.attachFileList[].filePath String ファイルパス(内部用)
body.data.attachFileList[].fileName String ファイル名

予約送信の取消

リクエスト

[URL]

PUT /sms/v2.3/appKeys/{appKey}/reservations/cancel
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
  "reservationList":[
    {
      "requestId":"{requestId}",
      "recipientSeq":1
    }
  ],
  "updateUser":"{updateUser}"
}
タイプ 最大 必須 説明
reservationList[].requestId String 25 O リクエストID
reservationList[].recipientSeq Integer - O 受信者シーケンス
updateUser String 100 O キャンセルリクエスト者

cURL

curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reservations/cancel' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "reservationList": [{
            "requestId": "1",
            "recipientSeq": 1
        }
    ],
    "updateUser": "API Guide"
}'

[Response body]

{
  "header":{
    "resultCode":0,
    "resultMessage":"SUCCESS",
    "isSuccessful":true
  },
  "body":{
    "data":{
      "requestedCount":1,
      "canceledCount":1
    }
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.requestedCount Integer キャンセルリクエスト件数
body.data.canceledCount Integer キャンセル成功件数

予約送信キャンセル - 多重フィルタ

リクエスト

  • 予約キャンセルリクエストは、状態が「予約中(RESERVED)」の場合にのみ行うことができます。
  • 送信済のメッセージはキャンセルできません。

[URL]

PUT /sms/v2.3/appKeys/{appKey}/reservations/search-cancels
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
  "searchParameter" : {
      "sendType" : "0",
      "startRequestDate" : "2020-02-01 00:00",
      "endRequestDate" : "2020-02-01 10:00",
      "startCreateDate" : "2020-02-01 00:00",
      "endCreateDate" : "2020-02-01 10:00",
      "sendNo" : "15880000",
      "recipientNo" : "0100000000",
      "templateId" : "TemplateId",
      "requestId" : "20200201010630ReZQ6KZzAH0",
      "createUser" : "CreateUser",
      "senderGroupingKey" : "SenderGroupingKey"
  },
  "updateUser" : "UpdateUser"
}
  • startRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。
  • 登録日時と予約日時を同時に照会する場合、予約日時は無視されます。
タイプ 最大 必須 説明
searchParameter.sendType String 1 必須 送信タイプ(0:Sms、1:LMS/Mms、2:Auth)
searchParameter.startRequestDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm)
searchParameter.endRequestDate String - 必須 送信日の終了値(yyyy-MM-dd HH:mm)
searchParameter.startCreateDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm)
searchParameter.endCreateDate String - 必須 送信日の開始値(yyyy-MM-dd HH:mm:ss)
searchParameter.sendNo String 20 オプション 発信番号
searchParameter.recipientNo String 20 オプション 受信番号
searchParameter.templateId String 50 オプション テンプレートID
searchParameter.requestId String 25 オプション リクエストID
searchParameter.createUser String 100 オプション 登録したユーザー
searchParameter.senderGroupingKey String 100 オプション 発信者グループキー
searchParameter.recipientGroupingKey String 100 オプション 受信者グループキー
updateUser String 100 必須 予約キャンセルリクエスト者

cURL

curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "searchParameter": {
        "sendType": "0",
        "startRequestDate": "2020-02-01 00:00",
        "endRequestDate": "2020-02-01 10:00",
        "startCreateDate": "2020-02-01 00:00",
        "endCreateDate": "2020-02-01 10:00",
        "sendNo": "15880000",
        "recipientNo": "0100000000",
        "templateId": "TemplateId",
        "requestId": "20200201010630ReZQ6KZzAH0",
        "createUser": "CreateUser",
        "senderGroupingKey": "SenderGroupingKey"
    },
    "updateUser": "API Guide"
}'

レスポンス

{
  "header":{
    "resultCode":0,
    "resultMessage":"success",
    "isSuccessful":true
  },
  "body":{
    "data":{
      "reservationCancelId":"20200210113330OepQ1sAzSDa",
      "requestedDateTime":"2020-02-10 11:33:30",
      "reservationCancelStatus":"READY"
    }
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.reservationCancelId Integer 予約キャンセルID
body.data.requestedDateTime String 予約キャンセルリクエスト時間(yyyy-MM-dd HH:mm:ss)
body.data.reservationCancelStatus String 予約キャンセル状態
- READY :予約準備
- PROCESSING :予約キャンセル中
- COMPLETED :予約キャンセル完了
- FAILED :予約キャンセル失敗

予約送信キャンセルリクエストリスト照会 - 多重フィルタ

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/reservations/search-cancels?startRequestedDateTime={startRequestedDateTime}&endRequestedDateTime={endRequestedDateTime}&reservationCancelId={reservationCancelId}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長さ 必須 説明
startRequestedDateTime String - オプション 予約キャンセルリクエスト開始時間(yyyy-MM-dd HH:mm:ss)
endRequestedDateTime String - オプション 予約キャンセルリクエスト終了時間(yyyy-MM-dd HH:mm:ss)
reservationCancelId String 25 オプション 予約キャンセルID
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header":{
        "resultCode":0,
        "resultMessage":"success",
        "isSuccessful":true
    },
    "body":{
        "data":[
            {
                "reservationCancelId":"",
                "searchParameter":{

                },
                "requestedDateTime":"",
                "completedDateTime":"",
                "reservationCancelStatus":"",
                "totalCount":0,
                "successCount":0,
                "createUser":"",
                "createdDateTime":"",
                "updatedDateTime":""
            }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data[].reservationCancelId String 予約キャンセルID
body.data[].searchParameter Map 予約キャンセルリクエストパラメータ
body.data[].requestedDateTime String 予約キャンセルリクエスト時間
body.data[].completedDateTime String 予約キャンセル完了時間
body.data[].reservationCancelStatus String 予約キャンセル状態
- READY :予約準備
- PROCESSING :予約キャンセル中
- COMPLETED :予約キャンセル完了
- FAILED :予約キャンセル失敗
body.data[].totalCount Integer 予約キャンセル対象件数
body.data[].successCount Integer 予約キャンセル成功件数
body.data[].createUser String 予約キャンセルリクエスト者
body.data[].createdDateTime String 予約キャンセルリクエスト作成時間
body.data[].updatedDateTime String 予約キャンセル修正時間

送信結果ファイルのダウンロード

照会ファイル作成リクエスト

リクエスト

[URL]

POST /sms/v2.3/appKeys/{appKey}/sender/download-reservations
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body] * requestIdまたはstartRequestDate + endRequestDateまたはstartCreateDate + endCreateDateは必須です。 * 登録日時と発信日時を同時に照会する場合、発信日時は無視されます。

{
  "sendType":"1",
  "requestId":"20190601100630ReZQ6KZzAH0",
  "startRequestDate":"2019-06-01 00:00:00",
  "endRequestDate":"2019-06-08 00:00:00",
  "startCreateDate":"2019-06-01 00:00:00",
  "endCreateDate":"2019-06-08 00:00:00",
  "startResultDate":"2019-06-01 00:00:00",
  "endResultDate":"2019-06-08 00:00:00",
  "sendNo":"15446859",
  "recipientNo":"01000000000",
  "templateId":"TemplateId",
  "msgStatus":"3",
  "resultCode":"MTR2",
  "subResultCode":"MTR2_3",
  "senderGroupingKey":"{送信者グループキー}",
  "recipientGroupingKey":"{受信者グループキー}",
  "isIncludeTitleAndBody":true
}
タイプ 最大長さ 必須 説明
sendType String 1 必須 送信タイプ(0:Sms、1:Mms、2:Auth)
requestId String 25 必須条件(1番) リクエストID
startRequestDate String - 必須条件(2番) 送信日開始値(yyyy-MM-dd HH:mm:ss)
endRequestDate String - 必須条件(2番) 送信日終了値(yyyy-MM-dd HH:mm:ss)
startResultDate String - オプション 受信日開始値(yyyy-MM-dd HH:mm:ss)
endResultDate String - オプション 受信日終了値(yyyy-MM-dd HH:mm:ss)
sendNo String 13 オプション 発信番号
recipientNo String 20 オプション 受信番号
templateId String 50 オプション テンプレート番号
msgStatus String 1 オプション メッセージステータスコード(0:失敗、1:リクエスト、2:処理中、3:成功、4:予約キャンセル、5:重複送信)
resultCode String 10 オプション 受信結果コード[照会コード表]
subResultCode String 10 オプション 受信結果詳細コード[照会コード表]
senderGroupingKey String 100 オプション 送信者グループキー
recipientGroupingKey String 100 オプション 受信者グループキー
isIncludeTitleAndBody Boolean - オプション タイトル、本文を含めるかどうか

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/sender/download-reservations' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "sendType": "1",
    "startRequestDate": "2020-08-01T00:00:00",
    "endRequestDate": "2020-08-08T00:00:00"
}'

レスポンス

{
  "header":{
    "isSuccessful":true,
    "resultCode":0,
    "resultMessage":"SUCCESS"
  },
  "body":{
    "data":{
      "donwloadId":"20190610100630ReZQ6KZzAH0",
      "downloadType":"NORMAL",
      "fileType":"CSV",
      "downloadStatusCode":"COMPLETED",
      "expiredDate":"2019-07-09 10:06:00.0"
    }
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.donwloadId String ダウンロードID
body.data.downloadType String ダウンロードタイプ
- BLOCK:受信拒否
- NORMAL:一般送信
- MASS:大量送信
- TAG:タグ送信
body.data.fileType String ファイルタイプ(現在csvのみサポート)
body.data.downloadStatusCode String ファイル作成状態
- READY:作成準備
- MAKING:作成中
- COMPLETED:作成完了
- FAILED:作成失敗
- EXPIRED:ダウンロード期間終了
body.data.expiredDate String ダウンロード期間終了日時

送信結果ファイル作成リクエストの履歴照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/download-reservations?downloadId={downloadId}&downloadStatusCode={downloadStatusCode}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長さ 必須 説明
downloadId String 25 オプション ダウンロードID
downloadStatusCode String 10 オプション ダウンロードファイルのステータスコード
pageNum Integer - オプション ページ番号(デフォルト値:1)
pageSize Integer 1000 オプション 照会数(デフォルト値:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/download-reservations' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
  "header":{
    "isSuccessful":true,
    "resultCode":0,
    "resultMessage":"SUCCESS"
  },
  "body":{
    "totalCount":0,
    "data":[
      {
        "downloadId":"",
        "downloadType":"",
        "fileType":"",
        "parameter":"",
        "size":0,
        "downloadStatusCode":"",
        "resultMessage":"",
        "expiredDate":"",
        "createUser":"",
        "createDate":"",
        "updateDate":""
      }
    ]
  }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.totalCount Integer 総件数
body.data[].downloadId String ダウンロードID
body.data[].downloadType String ダウンロードタイプ
- BLOCK:受信拒否
- NORMAL:一般送信
- MASS:大量送信
- TAG:タグ送信
body.data[].fileType String ファイルタイプ
body.data[].parameter String リクエストパラメータ
body.data[].size Integer 照会データサイズ
body.data[].downloadStatusCode String ファイル作成状態
- READY:作成準備
- MAKING:作成中
- COMPLETED:作成完了
- FAILED:作成失敗
- EXPIRED:ダウンロード期間終了
body.data[].resultMessage String 結果メッセージ(失敗時のレスポンス)
body.data[].expiredDate String ファイル有効期限
body.data[].createUser String ファイル作成リクエスト者
body.data[].createDate String ファイル作成リクエスト日時
body.data[].updateDate String ファイル作成完了、失敗日時

送信結果ファイルのダウンロードリクエスト

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/download-reservations/{downloadId}/download
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
downloadId String ダウンロードID

レスポンス

file byte

タグ管理

タグ照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/tags?pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長さ 必須 説明
pageNum Integer - オプション オプション
pageSize Integer 1000 オプション オプション

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 1,
        "totalCount": 1,
        "data": [
            {
                "tagId": "ABCD1234",
                "tagName": "TAG",
                "createdDate": "2019-01-01 00:00:00",
                "updatedDate": "2019-01-01 00:00:00"
            }
        ]
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.pageNum Integer ページ番号
body.pageSize Integer 照会数
body.totalCount Integer 総件数
body.data[].tagId String タグID
body.data[].tagName String タグ名
body.data[].createdDate String 作成日時
body.data[].tagId String 修正日時

タグ登録

[URL]

POST /sms/v2.3/appKeys/{appKey}/tags
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
  "tagName": "TAG"
}
タイプ 最大長さ 必須 説明
tagName String 30 必須 タグ名

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "tagName": "API-Guide"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "tagId": "ABCD1234"
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.tagId String タグID

タグ修正

[URL]

PUT /sms/v2.3/appKeys/{appKey}/tags/{tagId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
tagId String タグID

[Request body]

{
  "tagName": "TAG"
}
タイプ 最大長さ 必須 説明
tagName String 30 必須 タグ名

cURL

curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "tagName": "API-Guide2"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

タグ削除

[URL]

DELETE /sms/v2.3/appKeys/{appKey}/tags/{tagId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
tagId String タグID

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

UIDの管理

UIDの照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/uids?wheres={wheres}&offsetUid={offsetUid}&offset={offset}&limit={limit}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Query parameter]

タイプ 最大長さ 必須 説明
wheres List - オプション 照会条件。
英数字、括弧で構成された文字列。
括弧は1個、AND、ORは3個まで使用できる。
(例) tagId1,AND,tagId2
offsetUid String - オプション offset UID
offset Integer - オプション offset(Default : 0)
limit Integer 1000 オプション 照会件数(Default:15)

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids' \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "uids": [
                {
                    "uid": "UID",
                    "tags": [
                        {
                            "tagId": "ABCD1234",
                            "tagName": "TAG",
                            "createdDate": "2019-01-01 00:00:00",
                            "updatedDate": "2019-01-01 00:00:00"
                        }
                    ],
                    "contacts": [
                        {
                            "contactType": "PHONE_NUMBER",
                            "contact": "test@nhn.com",
                            "createdDate": "2019-01-01 00:00:00"
                        }
                    ]
                }
            ],
            "isLast": false,
            "totalCount": 5
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.uids[].uid String UID
body.data.uids[].tags[].tagId String タグID
body.data.uids[].tags[].tagName String タグ名
body.data.uids[].tags[].createdDate String タグ作成日時
body.data.uids[].tags[].updatedDate String タグ修正日時
body.data.uids[].contacts[].contactType String 連絡先タイプ
body.data.uids[].contacts[].contact String 連絡先(携帯電話番号)
body.data.uids[].contacts[].createdDate String 連絡先作成日時
body.data.uids[].isLast Boolean 最後のリストかどうか
body.data.uids[].totalCount Integer 総データ件数

UID単件照会

リクエスト

[URL]

GET /sms/v2.3/appKeys/{appKey}/uids/{uid}

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
uid String UID

cURL

curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "uid": "UID",
            "tags": [
                {
                    "tagId": "ABCD1234",
                    "tagName": "TAG",
                    "createdDate": "2019-01-01 00:00:00",
                    "updatedDate": "2019-01-01 00:00:00"
                }
            ],
            "contacts": [
                {
                    "contactType": "PHONE_NUMBER",
                    "contact": "0100000000",
                    "createdDate": "2019-01-01 00:00:00"
                }
            ]
        }
    }
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ
body.data.uid String UID
body.data.tags[].tagId String タグID
body.data.tags[].tagName String タグ名
body.data.tags[].createdDate String タグ作成日時
body.data.tags[].updatedDate String タグ修正日時
body.data.contacts[].contactType String 連絡先タイプ
body.data.contacts[].contact String 連絡先(携帯電話番号)
body.data.contacts[].createdDate String 連絡先作成日時

UIDの登録

[URL]

POST /sms/v2.3/appKeys/{appKey}/uids
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー

[Request body]

{
  "uids": [
  {
      "uid": "UID",
      "tagIds": ["ABCD1234"],
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "0100000000"
        }
      ]
  }]
}
タイプ 最大長さ 必須 説明
uid String - 必須 UID
tagIds[] String - 必須 タグIDリスト
contacts[].contactType String - 必須 連絡先タイプ(PHONE_NUMBER)
contacts[].contact String - 必須 連絡先(携帯電話番号)

[注意] * tagIdsが与えられている場合、contactsは必須値ではない。 * contactsが与えられている場合、tagIdsは必須値ではない。 * 本サービスの場合、contactTypeは必ず"PHONE_NUMBER"値でリクエストする必要がある。

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids/' \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "uids": [{
            "uid": "USER ID",
            "contacts": [{
                    "contactType": "PHONE_NUMBER",
                    "contact": "0100000000"
                }
            ]
        }
    ]
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

UIDの削除

[URL]

DELETE /sms/v2.3/appKeys/{appKey}/uids/{uid}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
uid String UID

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

携帯電話番号登録

[URL]

POST /sms/v2.3/appKeys/{appKey}/uids/{uid}/phone-numbers
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
uid String UID

[Request body]

{
  "phoneNumber": "0100000000"
}
タイプ 最大長さ 必須 説明
phoneNumber String - 必須 携帯電話番号

cURL

curl -X POST \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}/phone-numbers" \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
    "phoneNumber": "0100000000"
}'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

携帯電話番号削除

[URL]

DELETE /sms/v2.3/appKeys/{appKey}/uids/{uid}/phone-numbers/{phoneNumber}
Content-Type: application/json;charset=UTF-8

[Path parameter]

タイプ 説明
appKey String 固有のアプリケーションキー
uid String UID
phoneNumber String 携帯電話番号

cURL

curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v2.3/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}"'/phone-numbers/'"${P_NO}" \
-H 'Content-Type: application/json;charset=UTF-8'

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード
header.resultMessage String 失敗メッセージ

Webフック

SMSサービス内で特定イベントが発生すると、Webフック設定に定義されたURLへPOSTリクエストを作成します。
作成されたPOSTリクエストについてのAPI文書です。

Webフック送信

[URL]

Http method URI
POST Webフック設定に定義した対象URL

[Header]

タイプ 説明
X-Toast-Webhook-Signature String Webフック設定時に入力した署名

[Request body]

|値| タイプ| 説明| |---|---|---|---| |hooksId| String| Webフック設定に定義されたURLへPOSTリクエストを行うたびに作成される固有のID| |webhookConfigId| String|Webフック設定ID| |productName| String| Webフックイベントが発生したサービス名 | |appKey| String| Webフックイベントが発生したサービスアプリケーションキー| |event| String| Webフックイベント名
UNSUBSCRIBE:広告文字受信番号登録| |hooks| List\ | Webフックイベント発生時のデータ
詳細な明細はイベントタイプ別hooks定義を参照してください。|

cURL

curl -X POST \
    '{TargetUrl}' \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-Toast-Webhook-Signature: application/json;charset=UTF-8' \
    -d '{
        "hooksId":"202007271010101010sadasdavas",
        "webhookConfigId":"String",
        "productName":"Sms",
        "appKey":"akb3dukdmdjsdSvgk",
        "event":"UNSUBSCRIBE",
        "hooks":[
            {
                ...
            }
        ]
    }

イベントタイプ別hooks定義

Webフック設定に定義されたURLへPOSTリクエスト作成時、イベントタイプごとに異なるhooksデータ明細です。

広告メール受信アドレス登録

|値| タイプ| 説明| |---|---|---|---| |hooks| List\ | Webフックイベント発生時のデータ| |- hookId| String| サービスでイベント発生時に作成される固有のID | |- recipientNo| String| 受信拒否された携帯電話番号 | |- unsubscribeNo| String| 受信拒否サービスに登録された080番号 | |- enterpriseName| String| 受信拒否サービスに登録された業者名 | |- createdDateTime| String| 受信拒否リクエスト日時
* yyyy-MM-dd'T'HH:mm:ss.SSSXXX|

"hooks":[
    {
        "hookId" : "202007271010101010sadasdavas",
        "recipientNo" : "01012341234",
        "unsubscribeNo" : "08012341234",
        "enterpriseName" : "NHN",
        "createdDateTime" : "2020-09-09T11:25:10.000+09:00"
    }
]
目次
TOP