『絶対リーチ！® SMS communicationPlatform』
API 仕様書
Version 1.47

本ドキュメントは 2024 年 3 月末をもって更新を終了しております。
最新の API 仕様につきましては下記をご参照ください。

https://doc.aossms.com/zettai-reach/openapi.html

2023 年 12 月 27 日
AI CROSS 株式会社

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

改版履歴
版数
1.40

日付
2022/08/18

1.41

2022/08/25

1.42
1.43

2022/10/28
2022/12/6

1.44
1.45

2023/06/26
2023/11/21

1.46
1.47

2023/12/7
2023/12/27

内容
最新の API(P5)に統一
・全キャリア長文対応に合わせ、最新の API のみを記載しております。
・わかりづらい箇所等一部記述を見直しました。
・一部構成を変更しました。
2.4. ステータス取得(Common)で一部パラメータ名の表記を修正しました（先頭大文字→小文字）
パラメータ名の誤記を修正しました（先頭大文字→小文字）
1.3. TPS の表現を修正しました。
2.6.1 domain パラメータを追記しました。
2.9. 通数取得 API を新規追加しました。
2.4.2 ステータス取得(Common)のレスポンスに「separatedSuccessCount」項目を追加しました。
smsCode の文字数を 5 桁または 6 桁に修正しました。
CommonMT 送信、予約送信確認、予約送信一括キャンセルのパラメータに「groupTag」項目を追加しました。

© AI CROSS,Inc. All Rights Reserved.

- 2 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

目次
1. はじめに ........................................................................................................................................................................ 5
1.1. 接続方式 ............................................................................................................................................................... 5
1.2. 接続元 IP アドレスの制限 ...................................................................................................................................... 5
1.3. TPS（Transactions Per Second） ........................................................................................................................... 5
1.4. 推奨 API ................................................................................................................................................................ 5
1.5. 配信プラットフォーム刷新にともなう API URL の変更 ............................................................................................... 5
2. API 仕様 ....................................................................................................................................................................... 6
2.1. CommonMT 送信 ....................................................................................................................................................... 6
2.1.1. リクエスト .................................................................................................................... 6
2.1.2. レスポンス ................................................................................................................ 14
2.1.3. 結果コード ................................................................................................................ 15
2.2. CommonMT 予約送信確認 ....................................................................................................................................... 16
2.2.1. リクエスト .................................................................................................................. 16
2.2.2. レスポンス ................................................................................................................ 17
2.2.3. 結果コード ................................................................................................................ 19
2.3. CommonMT 予約送信キャンセル ............................................................................................................................. 20
2.3.1. リクエスト .................................................................................................................. 20
2.3.2. レスポンス ................................................................................................................ 21
2.3.3. 結果コード ................................................................................................................ 22
2.3.4. リクエスト（一括キャンセル） ....................................................................................... 23
2.3.5. レスポンス（一括キャンセル） ..................................................................................... 24
2.3.6. 結果コード（一括キャンセル） ..................................................................................... 25
2.4. ステータス取得(Common) ...................................................................................................................................... 26
2.4.1. リクエスト .................................................................................................................. 26
2.4.2. レスポンス ................................................................................................................ 27
2.4.3. 結果コード ................................................................................................................ 31
2.5. DLR 通知(Common) ................................................................................................................................................ 32
2.5.1. 通知パラメータ .......................................................................................................... 32
2.5.2. レスポンス ................................................................................................................ 42
2.6. ショート URL 登録 .................................................................................................................................................. 43
2.6.1. リクエスト .................................................................................................................. 43
2.6.2. レスポンス ................................................................................................................ 44
2.6.3. 結果コード ................................................................................................................ 45
2.7. 登録済み定型文取得 ........................................................................................................................................... 46
2.7.1. リクエスト .................................................................................................................. 46
2.7.2. レスポンス ................................................................................................................ 47
2.7.3. 結果コード ................................................................................................................ 49
2.8. 電話番号クリーニング .......................................................................................................................................... 50
2.8.1. リクエスト .................................................................................................................. 50
2.8.2. レスポンス ................................................................................................................ 51
2.8.3. 結果コード ................................................................................................................ 52
2.9. 通数集計 ............................................................................................................................................................. 53
2.9.1. リクエスト .................................................................................................................. 53© AI CROSS,Inc. All Rights Reserved.

- 3 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.9.2. レスポンス ................................................................................................................ 54
2.9.3. 結果コード ................................................................................................................ 55
3. 別記事項..................................................................................................................................................................... 56
3.1. 国際電話番号形式について ................................................................................................................................. 56
3.2. ステータス ID について ......................................................................................................................................... 56
3.3. レスポンスの rawdata について ............................................................................................................................ 56
3.4. 詳細内部コード（detailedStatusId）について ....................................................................................................... 57
3.5. Y!Mobile （旧 Willcom、PHS 回線）について ...................................................................................................... 57© AI CROSS,Inc. All Rights Reserved.

- 4 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

1. はじめに
本書では「絶対リーチ！® SMS communicationPlatform」（以下、「本サービス」といいます）の外部 API 仕様を定義します。

1.1. 接続方式
API 接続は、HTTPS の GET/POST メソッドを用いて接続します。
※SSL/TLS の方式は TLS1.2 に限定しております。TLS1.0、1.1 では接続できません。

1.2. 接続元 IP アドレスの制限
セキュリティを強化するため API を使用するアクセス元 IP アドレスを制限することが可能です。管理画面の API
限定 IP 設定により設定できます。

1.3. TPS（Transactions Per Second）
CommonMT 送信 API リクエストは全体で 600TPS（1 秒間あたりのリクエスト件数）での受け付けが可能です。
※上限を超過した場合は一時的に流量制限を実施する場合があります。

1.4. 推奨 API
最新の「CommonMT 送信」をご利用下さい。
既に旧送信 API をご利用のお客様も「CommonMT 送信」に変更をお勧めいたします。

1.5. 配信プラットフォーム刷新にともなう API URL の変更
2022 年 3 月に配信プラットフォームを刷新し、API URL も変更となりました。
この仕様書では、各 API の新 URL を記載しております。

© AI CROSS,Inc. All Rights Reserved.

- 5 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2. API 仕様
本サービスが提供する外部向け API 仕様を記載します。

2.1. CommonMT 送信※KDDI は送信失敗となった場合に KDDI からの失敗ステータスの通知に 20 分程度時間を要する場合があります。

2.1.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/mt.json※

以下のパラメータを URL エンコードにて追加し、POST メソッドにて呼び出します。

No

項目名

データ型

必須

String○概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値につ

1

token

きましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。

2

clientId

String○

割り当てられている契約クライアント ID につきましては、管理画面のクライ
アント情報をご確認ください。
・半角数字
送信元 SMS コードを指定します。

3

smsCodeString○

割り当てられている SMS コードにつきましては、管理画面のクライアント情報をご確認ください。
・5 桁または 6 桁の半角数字
送信メッセージを指定します。

4

message

String○・最大 660 文字(全角/半角問わず文字数でカウントされます)
送信先電話番号を指定します。
日本国内形式(070xxxxxxxx/080xxxxxxxx/090xxxxxxxx)、国際電話番号形式の5

phoneNumber

String○

どちらも指定することが可能です。
※国際電話番号形式については『別記事項・国際電話番号形式について』をご参照ください。
キャリア ID を指定します。指定しない場合は本サービスにて電話番号より送信先キャリアを自動判定します。

6

carrierId

String

101:AU
103:Docomo
105:Softbank
106:楽天モバイル© AI CROSS,Inc. All Rights Reserved.

- 6 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

送信ステータス確認用の任意の識別文字列を指定します。必ずユニークな値を7

clientTag

String

指定してください。値の重複があるとエラーになります。
・お客様側で設定可能な文字数は最大 200 文字になります。

8scheduleTime

String9groupTag

String

予約送信時間を指定します。
フォーマットは「YYYY-mm-dd HH:MM」となります
予約確認・一括キャンセル用の任意識別文字列を指定します。
・最大 200 文字© AI CROSS,Inc. All Rights Reserved.

- 7 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

リクエストサンプル➢

CommonMt_sample.ps1[System.String] $logDir = Split-Path -Parent $MyInvocation.MyCommand.Path[System.String] $url = "https://sms-api.aossms.com/p5/api/mt.json" #接続先URL[System.String] $token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"#トークンを設定[System.String] $clientId = "xxxx"#クライアントIDを設定[System.String] $smsCode = "xxxxx"#SMSコードを設定[System.String] $message = "sample message (powershell)"#送信したいメッセージを設定[System.String] $phoneNumber = "09001234567"#送信したい宛先電話番号を設定[System.String] $clientTag="uniqueTag"#一意となるタグを設定#SMS送信をリクエスト$response = Invoke-WebRequest -Method Post -Body @{token="${token}"; clientId="${clientId}"; smsCode="${smsCode}";message="${message}"; phoneNumber="${phoneNumber}"; clientTag="${clientTag}"} ${url}#レスポンス結果を出力$response.content |Out-File ${logDir}\${clientTag}.txt➢

CommonMt_sample.py

import requests
url = "https://sms-api.aossms.com/p5/api/mt.json" #接続先URL
data = {"token" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" #トークンを設定, "clientId" : "xxxx"#クライアントIDを設定, "smsCode" : "xxxxx"#SMSコードを設定, "message" : "sample message (python)", "phoneNumber" :"09001234567", "clientTag" :"uniqueTag"#送信したいメッセージを設定#送信したい宛先電話番号を設定#一意となるタグを設定}
req = requests.post(url, data=data)
print(req.text)#SMS送信をリクエスト#レスポンス結果を出力© AI CROSS,Inc. All Rights Reserved.

- 8 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

CommonMt_sample.bat@echo off
rem 接続先URL
set url=https://sms-api.aossms.com/p5/api/mt.json
rem トークンを設定
set token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
rem クライアントIDを設定
set clientId=xxxx
rem SMSコードを設定
set smsCode=xxxxx
rem 送信したいメッセージを設定
set message=sample+message(curl)
rem 送信したい宛先電話番号を設定
set phoneNumber=09001234567
rem 一意となるタグを設定
set clientTag=uniqueTag
rem SMS送信をリクエスト、レスポンス結果を出力
curl -s -X POST -d"token=%token%&clientId=%clientId%&smsCode=%smsCode%&message=%message%&phoneNumber=%phoneNumber%&clientTag=%clientTag%" "%url%" > result.txt© AI CROSS,Inc. All Rights Reserved.

- 9 -CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

CommonMt_sample.php<?php$url = 'https://sms-api.aossms.com/p5/api/mt.json';$data = array('token' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' //トークンを設定, 'clientId' => 'xxxx'//クライアントIDを設定, 'smsCode' => 'xxxxx'// SMSコードを設定, 'message' => 'sample message (php)'//送信したいメッセージを設定, 'phoneNumber' => '09001234567'//送信したい宛先電話番号を設定, 'clientTag' => 'uniqueTag'//一意となるタグを設定);$content = http_build_query($data);// URLエンコードされたクエリ文字列を生成$header = array(//リクエストヘッダを設定"Content-Type: application/x-www-form-urlencoded", "Content-Length: ".strlen($content));$options = array(// HTTPコンテキストオプションを設定"http" => array('method' => 'POST', 'header' => implode("\r\n", $header), 'content' => $content));$contents = file_get_contents($url, false, stream_context_create($options)); //SMS送信をリクエスト
file_put_contents('result.txt', $contents);//レスポンス結果を出力© AI CROSS,Inc. All Rights Reserved.

- 10 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

CommonMt_sample.java

package com.aicross.sms;
import java.io.BufferedReader;import java.io.InputStream;
import java.io.InputStreamReader;import java.io.OutputStreamWriter;
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SmsService {
private static final Logger logger = LoggerFactory.getLogger(SmsService.class);
public static void main(String[] args) throws Exception {HttpsURLConnection conn = null;
StringBuffer result = new StringBuffer();try {URL url = new URL("https://sms-api.aossms.com/p5/api/mt.json"); //接続先URL
String token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; //トークンを設定
String clientId = "xxxx";//クライアントIDを設定

String smsCode = "xxxxx";//SMSコードを設定

String message = "sample message(java)";//送信したいメッセージを設定

String phoneNumber = "09001234567";//送信したい宛先電話番号を設定

String clientTag = "uniqueTag";//一意となるタグを設定//リクエストパラメータを生成
StringBuilder param = new StringBuilder();param.append("token="+token);param.append("&clientId="+clientId);
param.append("&smsCode="+smsCode);param.append("&message="+message);param.append("&phoneNumber="+phoneNumber);param.append("&clientTag="+clientTag);//SMS送信をリクエスト
conn = (HttpsURLConnection)url.openConnection();conn.setDoOutput(true);conn.setRequestMethod("POST");
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded;");OutputStreamWriter out = new OutputStreamWriter(conn.getOutputStream());
out.write(param.toString());
out.close();conn.connect();=====次ページ=====© AI CROSS,Inc. All Rights Reserved.

- 11 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書=====前ページ=====//レスポンスコードを取得
int status = conn.getResponseCode();if (status == HttpsURLConnection.HTTP_OK) {//レスポンスコードOKの場合、レスポンス結果を取得
final InputStream input = conn.getInputStream();
String encoding = conn.getContentEncoding();
if (null == encoding) {encoding = "UTF-8";}
final InputStreamReader inReader = new InputStreamReader(input, encoding);
final BufferedReader bufReader = new BufferedReader(inReader);String line = null;
while ((line = bufReader.readLine()) != null) {result.append(line);}
bufReader.close();inReader.close();input.close();} else {//レスポンスコードOKでない場合、レスポンスコードを出力
logger.error(String.valueOf(status));}} catch (Exception ex) {logger.error(ex.getLocalizedMessage());} finally {if (conn != null) {conn.disconnect();}}//レスポンス結果を出力
logger.info(result.toString());}}© AI CROSS,Inc. All Rights Reserved.

- 12 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

CommonMt_sample.jsconst axios = require('axios')
const qs = require('qs')
const instance = axios.create({
baseURL: 'https://sms-api.aossms.com', // 接続先URL
headers: {'Content-Type': 'application/x-www-form-urlencoded'}, // リクエストヘッダを設定})
const data = {token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // トークンを設定
clientId: 'xxxx',// クライアントIDを設定

smsCode: 'xxxxx',// SMSコードを設定

phoneNumber: '09001234567',// 送信したい宛先電話番号を設定

message: 'sample message (nodejs)',// 送信したいメッセージを設定

clientTag: 'uniqueTag'// 一意となるタグを設定}
const content = qs.stringify(data) // URLエンコードされたクエリ文字列を生成
instance.post('/p5/api/mt.json', content) // SMS送信をリクエスト.then(function (response) {console.log(response.data) // レスポンス結果を出力})© AI CROSS,Inc. All Rights Reserved.

- 13 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.1.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

項目名

データ型

1

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

responseMessage

String

応答結果を示すメッセージです。
※結果コードの項を参照してください。
リクエスト時に指定した送信先電話番号です。

3

phoneNumber

String

国際電話番号形式で返却されます。
※国際電話番号形式については『別記事項・国際電話番号形式について』をご参照ください。

4smsMessage

String

送信時に指定した message 項目の内容です。

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","phoneNumber": "+819012345678","smsMessage": "test"}➢

失敗時（1～）：{"responseCode": 300,
"responseMessage": "Exceed sending count.","phoneNumber": "+819012345678","smsMessage": "test"}© AI CROSS,Inc. All Rights Reserved.

- 14 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.1.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

説明

responseMessage

0

Success

リクエストの受付が成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目の内容が不正です。

120{項目名} too long.

{項目名}の長さが上限を超過しています。

300

Exceed sending count.

契約プランで定められた送信可能な件数の上限を超過しています。

400

Duplicate client tag.

500

System error.

クライアントタグが以前にリクエストした際のクライアントタグと重複しています。
上記で定義外のエラーが発生しています。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 15 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.2. CommonMT 予約送信確認
2.2.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/checkreservation.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。
No

項目名

データ
型

必須

概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値に

1

token

String○

つきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。割り当てられている契約クライアント

2clientId

String○

ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字
送信元 SMS コードを指定します。

3

smsCodeString○

割り当てられている SMS コードにつきましては、管理画面のクライアント情報をご確認ください。
・5 桁または 6 桁の半角数字
送信ステータス確認用の任意の識別文字列を指定します。
・最大 200 文字※本項目または scheduleTime, scheduleDate のいずれかが必須。

4clientTag

String△※優先度は clientTag＞scheduleTime＞scheduleDate になります。
※本項目を指定した場合、指定文字列を保持する SMS のステータスを返却します。本項目を指定しない場合、SMS 送信日のデータを検索して返却します。
予約送信時間を文字列で指定します。
フォーマットは「YYYY-mm-dd HH:MM」となります。

5scheduleTime

String△※本項目または clientTag, scheduleDate のいずれかが必須。
※優先度は clientTag＞scheduleTime＞scheduleDate になります。
groupTag も指定されている場合は組み合わせ条件になります。
予約送信日を半角数字で指定します。
フォーマットはで「YYYYMMDD」となります。

6scheduleDate

String△※本項目または clientTag, scheduleTime のいずれかが必須。
※優先度は clientTag＞scheduleTime＞scheduleDate になります。
groupTag も指定されている場合は組み合わせ条件になります。

7

groupTag

String△

予約リクエスト時に指定した任意識別文字列を指定します。

© AI CROSS,Inc. All Rights Reserved.

- 16 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.2.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

項目名

データ型

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。

1

1

responseCode

Integer2

1

responseMessage

String

3

1

count

Integer

4

1

statusList

52scheduleTime

String62

phoneNumber

String7

2

message

String82

smsCodeInteger

送信元 SMS コードです。5 桁または 6 桁の数字となります。

92

clientTag

String

SMS 送信のリクエスト時にパラメータとして指定した clientTag です。

※結果コードの項を参照してください。

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。
予約中のジョブの件数です。
階層 2 の項目を配列で保持します。
予約送信時間です。
フォーマットは「YYYY-mm-dd HH:MM」となります。
送信先の電話番号です。
国際電話番号形式で返却されます。
送信時に指定した message 項目の内容です。
(que_schedule_job.contents)© AI CROSS,Inc. All Rights Reserved.

- 17 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","count": 1,"status": [{"scheduleTime": "2019-01-31 08:00","phoneNumber": "+818012345678","message": "yoyaku","smsCode": 80013,"clientTag": "abcedfg"
}
]
}

➢

失敗時（1～）：{"responseCode":110,“responseMessage”:“Invalid token.”,“count":“0",“status”:[]}© AI CROSS,Inc. All Rights Reserved.

- 18 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.2.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

120{項目名} too long.

{項目名}の長さが上限を超過しています。

130

Already send.

確認対象のクライアントタグは既に送信されています。

140

Past {項目名}.

{項目名}は過去日時です。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 19 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3. CommonMT 予約送信キャンセル
2.3.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/cancelreservation.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ
型

必須

概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値に

1

token

String○

つきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。割り当てられている契約クライアント

2clientId

Integer○ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字

3

clientTag

String〇

送信ステータス確認用の任意の識別文字列を指定します。
・最大 200 文字© AI CROSS,Inc. All Rights Reserved.

- 20 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

1

responseMessage

String3

1

clientTag

List

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。
SMS 送信のリクエスト時にパラメータとして指定した clientTag です。

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.",“clientTag": “abcdefg"}➢

失敗時（1～）：{"responseCode": 110,
“responseMessage”: “Invalid clientTag.”,“clientTag": “abcdefg"}© AI CROSS,Inc. All Rights Reserved.

- 21 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

120{項目名} too long.

{項目名}の長さが上限を超過しています。

130

Already send.

キャンセル対象は既に送信されています。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 22 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3.4. リクエスト（一括キャンセル）
接続先 URL

https://sms-api.aossms.com/p5/api/cancelreservationall.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ
型

必須

概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値に

1

token

String○

つきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。割り当てられている契約クライアント

2clientId

String○

ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字

3

startDate

String△4

endDateString△5groupTag

String△

キャンセルする日付範囲の開始日付を指定します。（※1）
・YYYYMMDD
キャンセルする日付範囲の終了日付を指定します。（※1）
・YYYYMMDD
キャンセルするグループタグを指定します。（※1）（※1）startDate を指定し endDate を指定しない場合、startDate 以降の予約がキャンセルされます。
endDate を指定し startDate を指定しない場合、endDate 以前の予約がキャンセルされます。
startDate、endDate を共に指定しない場合はすべての予約がキャンセルされます。
groupTag を指定し、startDate、endDate を指定しない場合、groupTag が一致する予約がキャンセルされます。
groupTag を指定し、かつ startDate、endDate のいずれかまたは両方が指定されている場合、groupTag と日付範囲が一致する予約がキャンセルされます。
startDate、endDate、groupTag をすべて指定しない場合はすべての予約がキャンセルされます。

© AI CROSS,Inc. All Rights Reserved.

- 23 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3.5. レスポンス（一括キャンセル）※API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

1

responseMessage

String

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success."}➢

失敗時（1～）：{"responseCode": 110,
“responseMessage”: “Invalid clientTag.”}© AI CROSS,Inc. All Rights Reserved.

- 24 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.3.6. 結果コード（一括キャンセル）※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 25 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.4. ステータス取得(Common)
2.4.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/status.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ
型

必須

概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値に

1

token

String○

つきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。割り当てられている契約クライアント

2clientId

String○

ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字
SMS 送信日を指定します。
・半角数字

3

date

String△・YYYYMMDD 形式※本項目または clientTag のいずれかが必須。
※優先度は clientTag＞date になります。
送信ステータス確認用の任意の識別文字列を指定します。
・最大 200 文字

4clientTag

String△※本項目または date のいずれかが必須。
※優先度は clientTag＞date になります。
※本項目を指定した場合、指定文字列を保持する SMS のステータスを返却します。本項目を指定しない場合、SMS 送信日のデータを検索して返却します。

© AI CROSS,Inc. All Rights Reserved.

- 26 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.4.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

1

responseMessage

String3

1

statusList

42

dateTime

String

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。
階層 2 の項目を配列で保持します。
本サービスがキャリアよりステータスを取得した時間です。
フォーマットは「YYYYMMDD HHMMSSsss」(sss はミリ秒)となります。
送信先の電話番号です。

52

phoneNumber

String

国際電話番号形式で返却されます。
※国際電話番号形式については『別記事項・国際電話番号形式について』をご参照ください。

62

message

String72

smsCodeInteger

送信先に送信された SMS 本文です。
送信元 SMS コードです。
5 桁または 6 桁の数字となります。
キャリア ID です。以下のいずれかの ID になります。
101:AU
103:NTT Docomo

82carrierId

String105:Softbank
106:楽天モバイル※statusId が 0,1 の場合本項目の値は不定です※該当キャリアが判別できない場合、null または 999 となります。
送信先のキャリア名です。

92carrierName

String

上記のキャリア ID に応じたキャリア名が出力されます。
※statusId が 0,1 の場合本項目の値は不定です
ステータス ID です。下記いずれかの値が出力されます。
0: 状態不明

102statusId

Integer

1: 配信中
2: 送達
3: 配信失敗

112

clientTag

String122

detailedStatusId

String13

2

separatedSuccessCou
nt

SMS 送信のリクエスト時にパラメータとして指定した clientTag です。SMS 送
信のリクエスト時に指定しなかった場合は空となります。
ステータスに関する詳細内部コードです。
※statusId が 0,1 の場合本項目の値は不定です
課金通数です。

Integer※statusId が 2,3 の場合のみ有効値が出力されます※statusId が 0,1 の場合本項目の値は不定です© AI CROSS,Inc. All Rights Reserved.

- 27 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

キャリアより得られた詳細エラーデータです。階層 3 の項目を配列で保持し
142

rawdata

List

ます。
※statusId が 0,1 の場合本項目の値は不定です※本項目は将来廃止予定です
キャリア ID です。以下のいずれかの ID になります。
101:AU
102:Y!mobile

15

3

carrierString103:NTT Docomo
105:Softbank
106:楽天モバイル※statusId が 0,1 の場合本項目の値は不定です※該当キャリアが判別できない場合、null または 999 となります。
詳細エラーデータのタイプを示します。
※statusId が 3 の場合に値が出力されます。出力される値は下記のいずれかになります。その他の場合は null となります。

16

3

type

String

1:本サービスからキャリアへの SMS 送信リクエストが失敗した際のレスポン
ス
2: キャリアから端末への SMS 送信が失敗した際にキャリアから受信した DLR※statusId が 3 以外の場合は null となります。
階層 4 の項目をオブジェクトで保持します。

17

3

data

Object※statusId が 3 の場合に出力されます。
※statusId が 3 以外の場合は null となります。
Docomo に SMS 送信した際の 70 文字毎の分割数を示します。

18

4

sepmaxnum

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Docomo への SMS 送信が失敗した際に、送信が失敗した SMS が 70 文字毎に分割された SMS の中で何番目に送信されたかの順番を示します。

19

4

sepseqnum

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Docomo から端末への SMS 送信が失敗した際に Docomo から返されるエラーコードです。
2 桁の数字が出力されます。

20

4

code

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※submission_status が出力されている場合は null となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
本サービスから Docomo への SMS 送信リクエストが失敗した際に Docomo から返されるエラーコードです。
5 桁の数字が出力されます。

21

4

submission_status

Integer※statusId が 3 かつ carrier が 103 の場合に出力されます。
※code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。

© AI CROSS,Inc. All Rights Reserved.

- 28 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

Softbank から端末への SMS 送信が失敗した際に Softbank から返される配信結果です。
8 桁までの英数字が出力されます。
22

4

msgState

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
本サービスから Softbank への SMS 送信リクエストが失敗した際に Softbank
から返されるエラーコードです。
5 桁の数字が出力されます。

23

4

submission_err_code

Integer※statusId が 3 かつ carrier が 105 の場合に出力されます。
※msgState と ntwkErr が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Softbank から端末への SMS 送信が失敗した際に Softbank から返されるエラーコードです。
8 桁までの英数字が出力されます。

24

4

ntwkErr

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。

25

4

statusString常に null となります。

26

4commandStatus

String常に null となります。

27

4

networkErrorCode

String常に null となります。

© AI CROSS,Inc. All Rights Reserved.

- 29 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","status": [{"dateTime": "20170208 175417155","phoneNumber": "+818012345678","message": "test","smsCode": 80079,"carrierId": "101","carrierName": "AU","statusId": 2,"clientTag": "001180079_20170208175402","detailedStatusId": “2”,"separatedSuccessCount": 3,"rawdata": [{"carrier": "101","type": null,"data": null,
}
]
}
]
}

➢

失敗時（1～）：{"responseCode":110,"responseMessage":"Invalid date.","status":[]}© AI CROSS,Inc. All Rights Reserved.

- 30 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.4.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

120{項目名} too long.

{項目名}の項目の文字長が上限を超えています。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 31 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.5. DLR 通知(Common)
DLR のプッシュ型通知をお申込みいただいた場合、XML もしくは JSON 形式にて、弊社サーバより SMS 送信ステー
タスをお客様サーバに対する HTTPS コールを行って通知します(XML/JSON 形式のどちらで DLR 通知を行うかはお申し込み時にお選びいただく形となります)
DLR のプッシュ型通知は、MT 送信のリクエスト時に clientTag を指定することにより DLR 通知を受信できます。
clientTag を指定しなかった場合は DLR 通知を受信できません。

2.5.1. 通知パラメータ※

XML 形式の場合、お客様よりご指定いただいた URL に対し、下記の XML を POST メソッドにて通知します。

No

階層

項目名

データ型

概要

1

1

xml

---

xml を記載するパラメータです。

2

1

eventNotifications---

ルート要素です。
DLR 毎に提供される要素です。

3

2

eventNotification---

1 通の DLR 通知で 1 つの<eventNotification/>が通知されます。
階層 3 の項目をタグで保持します。

43

dateTime

String5

3

messageId

String63phoneNumber

String73

smsCodeInteger

本サービスがキャリアより DLR を取得した時間です。
フォーマットは「YYYY/mm/dd HH:MM:SS」となります。
本サービス内部で生成/使用されるメッセージ ID です。
32 桁の文字列となります。
送信先電話番号です。国際電話番号形式で通知されます。
※詳細は『別記事項・国際電話番号形式について』をご参照ください。
送信元 SMS 用コードです。
5 桁または 6 桁の数字となります。
キャリア ID です。
101: AU103: NTT Docomo

83carrierId

Integer

105: Softbank
106:楽天モバイル※statusId が 0,1 の場合本項目の値は不定です※該当キャリアが判別できない場合、null または 999 となります。
キャリア名です。

93

carrierName

String

上記のキャリア ID に応じたキャリア名が出力されます。
※statusId が 0,1 の場合本項目の値は不定です

103messageText

String

送信先に送信された SMS 本文です。

113

clientId

Integer

お客様毎に割り当てられた本サービスのクライアント ID です。

123

clientTag

String

SMS 送信時に指定したクライアントタグです。

© AI CROSS,Inc. All Rights Reserved.

- 32 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

ステータス ID です。下記いずれかの値が出力されます。
0: 状態不明
13

3

statusId

Integer

1: 配信中
2: 送達
3: 配信失敗
ステータス概要です。ステータス ID に応じて下記のステータス概要が出力されます。

14

3

statusDescription

String0: Unknown
1: Message is Sending
2: Message delivered
3: Message delivery failed

15

3detailedStatusId

String16

3

separatedSuccessCount

Integer

ステータスに関する詳細内部コードです。
※statusId が 0,1 の場合本項目の値は不定です
課金通数です。
※statusId が 2 の場合のみ有効値が出力されます。
詳細エラーデータの要素です。
階層 4 の要素をタグで保持します。

173

rawdata---※statusId が 2,3 の場合に出力されます。
※statusId が 0,1 の場合は出力されません。
※本項目は将来廃止予定です
SMS 送信先のキャリア ID です。下記のいずれかになります。
101: AU18

4carrier

Integer

103: NTT Docomo
105: Softbank
106: 楽天モバイル※該当キャリアが判別できない場合、null または 999 となります。
詳細エラーデータのタイプを示します。
※statusId が 3 の場合に値が出力されます。出力される値は下記のいず
れかになります。

19

4

type

Integer

1: 本サービスからキャリアへの SMS 送信リクエストが失敗した際のレスポンス
2: キャリアから端末への SMS 送信が失敗した際にキャリアから受信した DLR※statusId が 2 の場合は空となります。
キャリアから取得したエラーデータの要素です。

20

4

data

---

階層 5 の要素をタグで保持します。
※statusId が 2,3 の場合に出力されます。
Docomo に SMS 送信した際の 70 文字毎の分割数を示します。

21

5

sepmaxnum

Integer※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Docomo への SMS 送信が失敗した際に、送信が失敗した SMS が 70 文字毎に分割された SMS の中で何番目に送信されたかの順番を示します。

22

5

sepseqnum

Integer※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。

© AI CROSS,Inc. All Rights Reserved.

- 33 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

Docomo から端末への SMS 送信が失敗した際に Docomo から返されるエラーコードです。
2 桁の数字が出力されます。
23

5

code

Integer※statusId が 3 かつ carrier が 103 の場合に出力されます。
※submission_status が出力されている場合は空となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 2 の場合は空となります。
本サービスから Docomo への SMS 送信リクエストが失敗した際に Docomo
から返されるエラーコードです。
5 桁の数字が出力されます。

24

5

submission_status

Integer※statusId が 3 かつ carrier が 103 の場合に出力されます。
※code が出力されている場合は空となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 2 の場合は空となります。
Softbank から端末への SMS 送信が失敗した際に Softbank から返される
配信結果です。
8 桁までの英数字が出力されます。

25

5

msgState

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。
本サービスから Softbank への SMS 送信リクエストが失敗した際にSoftbank から返されるエラーコードです。
5 桁の数字が出力されます。

26

5

submission_err_code

Integer※statusId が 3 かつ carrier が 105 の場合に出力されます。
※msgState と ntwkErr が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。
Softbank から端末への SMS 送信が失敗した際に Softbank から返される
エラーコードです。
8 桁までの英数字が出力されます。

27

5

ntwkErr

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。

28

5

statusString常に null となります。

29

5commandStatus

String常に null となります。

30

5

networkErrorCode

String常に null となります。

© AI CROSS,Inc. All Rights Reserved.

- 34 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

DLR サンプル➢

配信成功時（0）：<?xml version="1.0" encoding="UTF-8"?><eventNotifications><eventNotification type="DLR"><dateTime><![CDATA[2017/02/03 13:00:45]]></dateTime><messageId><![CDATA[000002517020320030241455L3V3V5d]]></messageId><phoneNumber><![CDATA[+818012345678]]></phoneNumber><smsCode><![CDATA[80051]]></smsCode><carrierId><![CDATA[105]]></carrierId><carrierName><![CDATA[Softbank]]></carrierName><messageText><![CDATA[test 20170203 13:00:34]]></messageText><clientId><![CDATA[25]]></clientId><clientTag><![CDATA[002580051_20170203130034]]></clientTag><statusId><![CDATA[2]]></statusId><statusDescription><![CDATA[Message delivered]]></statusDescription><rawdata><carrier><![CDATA[105]]></carrier><type><![CDATA[]]></type><data><code><![CDATA[]]></code><submission_status><![CDATA[]]></submission_status><msgState><![CDATA[]]></msgState><submission_err_code><![CDATA[]]></submission_err_code><ntwkErr><![CDATA[]]></ntwkErr><commandStatus><![CDATA[]]></commandStatus><networkErrorCode><![CDATA[]]></networkErrorCode></data></rawdata><detailedStatusId><![CDATA[2]]></detailedStatusId><separatedSuccessCount><![CDATA[1]]></ separatedSuccessCount></eventNotification></eventNotifications>© AI CROSS,Inc. All Rights Reserved.

- 35 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

配信失敗時(0)：<?xml version="1.0" encoding="UTF-8"?><eventNotifications><eventNotification type="DLR"><dateTime><![CDATA[2017/02/03 09:50:29]]></dateTime><messageId><![CDATA[000000317020320018132331WkyYHLX]]></messageId><phoneNumber><![CDATA[+818012345678]]></phoneNumber><smsCode><![CDATA[80022]]></smsCode><carrierId><![CDATA[105]]></carrierId><carrierName><![CDATA[Softbank]]></carrierName><messageText><![CDATA[test message]]></messageText><clientId><![CDATA[3]]></clientId><clientTag><![CDATA[000380022_20170203_0938]]></clientTag><statusId><![CDATA[3]]></statusId><statusDescription><![CDATA[Message delivery failed]]></statusDescription><rawdata><carrier><![CDATA[105]]></carrier><type><![CDATA[2]]></type><data><code><![CDATA[null]]></code><submission_status><![CDATA[null]]></submission_status><msgState><![CDATA[EXPIRED]]></msgState><submission_err_code><![CDATA[null]]></submission_err_code><ntwkErr><![CDATA[G020600]]></ntwkErr><commandStatus><![CDATA[null]]></commandStatus><networkErrorCode><![CDATA[null]]></networkErrorCode></data></rawdata><detailedStatusId><![CDATA[12832]]></detailedStatusId><separatedSuccessCount><![CDATA[0]]></ separatedSuccessCount></eventNotification></eventNotifications>© AI CROSS,Inc. All Rights Reserved.

- 36 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書※

JSON 形式の場合、お客様よりご指定いただいた URL に対し、下記の JSON を POST メソッドにて通知します。

No

階層

項目名

データ型

概要

1

1

json

---

json を記載するパラメータです。

2

1

eventNotifications

List

階層 2 の項目を配列で保持します。

3

2

type

string

固定値「DLR」となります。

42

dateTime

String5

2

messageId

String62

phoneNumber

String72

smsCodeString本サービスがキャリアより DLR を取得した時間です。
フォーマットは「YYYY/mm/dd HH:MM:SS」となります。
本サービス内部で生成/使用されるメッセージ ID です。
32 桁の文字列となります。
送信先電話番号です。国際電話番号形式で通知されます。
※詳細は『別記事項・国際電話番号形式について』をご参照ください。
送信元 SMS 用コードです。
5 桁または 6 桁の数字となります。
キャリア ID です。
101: AU103: NTT Docomo

82carrierId

String105: Softbank
106:楽天モバイル※statusId が 0,1 の場合本項目の値は不定です※該当キャリアが判別できない場合、null または 999 となります。
キャリア名です。

92

carrierName

String

上記のキャリア ID に応じたキャリア名が出力されます。
※statusId が 0,1 の場合本項目の値は不定です

102messageText

String

送信先に送信された SMS 本文です。

112

clientId

String

お客様毎に割り当てられた本サービスのクライアント ID です。

122

clientTag

String

SMS 送信時に指定したクライアントタグです。
ステータス ID です。下記いずれかの値が出力されます。
0: 状態不明

13

2

statusId

String1: 配信中
2: 送達
3: 配信失敗
ステータス概要です。ステータス ID に応じて下記のステータス概要が出力されます。

14

2

statusDescription

String0: Unknown
1: Message is Sending
2: Message delivered
3: Message delivery failed

15

2detailedStatusId

Integer

ステータスに関する詳細内部コードです。
※statusId が 0,1 の場合本項目の値は不定です© AI CROSS,Inc. All Rights Reserved.

- 37 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

162

separatedSuccessCount

Integer

課金通数です。
※statusId が 2 の場合のみ有効値が出力されます。
詳細エラーデータです。
階層 3 の項目を配列で保持します。

172

rawdataList※statusId が 2,3 の場合に出力されます。
※statusId が 0,1 の場合は null となります。
※本項目は将来廃止予定です
SMS 送信先のキャリア ID です。下記のいずれかになります。
101: AU18

3carrierString103: NTT Docomo
105: Softbank
106: 楽天モバイル※該当キャリアが判別できない場合、null または 999 となります。
詳細エラーデータのタイプを示します。
※statusId が 3 の場合に値が出力されます。出力される値は下記のいず
れかになります。

19

3

type

String

1: 本サービスからキャリアへの SMS 送信リクエストが失敗した際のレスポンス
2: キャリアから端末への SMS 送信が失敗した際にキャリアから受信した DLR※statusId が 2 の場合は空となります。
キャリアから取得したエラーデータです。

20

3

data

List

階層 4 の項目を配列で保持します。
※statusId が 2,3 の場合に出力されます。
Docomo に SMS 送信した際の 70 文字毎の分割数を示します。

21

4

sepmaxnum

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Docomo への SMS 送信が失敗した際に、送信が失敗した SMS が 70 文字毎に分割された SMS の中で何番目に送信されたかの順番を示します。

22

4

sepseqnum

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 3 以外の場合は出力されません。
Docomo から端末への SMS 送信が失敗した際に Docomo から返されるエラーコードです。
2 桁の数字が出力されます。

23

4

code

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※submission_status が出力されている場合は空となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 2 の場合は空となります。
本サービスから Docomo への SMS 送信リクエストが失敗した際に Docomo
から返されるエラーコードです。
5 桁の数字が出力されます。

24

4

submission_status

String※statusId が 3 かつ carrier が 103 の場合に出力されます。
※code が出力されている場合は空となります。
※statusId が 3 であるが carrier が 103 でない場合は null となります。
※statusId が 2 の場合は空となります。

© AI CROSS,Inc. All Rights Reserved.

- 38 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

Softbank から端末への SMS 送信が失敗した際に Softbank から返される
配信結果です。
8 桁までの英数字が出力されます。
25

4

msgState

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。
本サービスから Softbank への SMS 送信リクエストが失敗した際にSoftbank から返されるエラーコードです。
5 桁の数字が出力されます。

26

4

submission_err_code

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※msgState と ntwkErr が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。
Softbank から端末への SMS 送信が失敗した際に Softbank から返される
エラーコードです。
8 桁までの英数字が出力されます。

27

4

ntwkErr

String※statusId が 3 かつ carrier が 105 の場合に出力されます。
※submission_err_code が出力されている場合は null となります。
※statusId が 3 であるが carrier が 105 でない場合は null となります。
※statusId が 2 の場合は空となります。

28

4

statusString常に null となります。

29

4commandStatus

String常に null となります。

30

4

networkErrorCode

String常に null となります。

© AI CROSS,Inc. All Rights Reserved.

- 39 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

DLR サンプル➢

配信成功時(0)：{"eventNotifications": [{"type": "DLR","dateTime": "2017/02/24 21:45:47","messageId": "00002891702242187613918627udCsC","phoneNumber": "+819012345678","smsCode": "80366","carrierId": "103","carrierName": "NTT Docomo","messageText": "test message","clientId": "289","clientTag": "CID0289_20170224_2145","statusId": "2","statusDescription": "Message delivered","rawdata": {"carrier": "103","type": "","data": {"code": "","submission_status": "","msgState": "","submission_err_code": "","ntwkErr": "","commandStatus": "","networkErrorCode": ""}},"detailedStatusId": 2,"separatedSuccessCount": 1}]}© AI CROSS,Inc. All Rights Reserved.

- 40 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書➢

配信失敗時(0)：{"eventNotifications": [{"type": "DLR","dateTime": "2017/02/24 21:46:57","messageId": "0000289170224218762151655XflHVe","phoneNumber": "+819012345678","smsCode": "80366","carrierId": "103","carrierName": "NTT Docomo","messageText": "test message","clientId": "289","clientTag": "CID0289_20170224_2146","statusId": "3","statusDescription": "Message delivery failed","rawdata": {"carrier": "103","type": "2",
"data": {"code": "21","submission_status": null,"msgState": null,"submission_err_code": null,"ntwkErr": null,"commandStatus": null,"networkErrorCode": null}},"detailedStatusId": 3,"separatedSuccessCount": 0}]}© AI CROSS,Inc. All Rights Reserved.

- 41 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.5.2. レスポンス※

API 呼び出し結果としてお客様サーバより HTTP ステータスコードを返却してください。
HTTP ステータスコード

成功／失敗

2xx

成功

2xx 以外失敗

備考

HTTP ステータスコード 2xx を 10 秒以内に返却した場合に成功とみなします。
200 以外のステータスコードを返却した場合、またはタイムアウト（10 秒）が発生した場合は受信に失敗したと判断され、3 回のリトライ処理が行われます。

© AI CROSS,Inc. All Rights Reserved.

- 42 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.6. ショート URL 登録
API によりショート URL を登録することが可能です。

2.6.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p1/api/shortenurl.json※

以下のパラメータを URL エンコードにて追加し、POST メソッドにて呼び出します。

No

項目名

データ型

必須

String○概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値につ

1

token

きましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。

2

clientId

String○

割り当てられている契約クライアント ID につきましては、管理画面のクライ
アント情報をご確認ください。
・半角数字
生成されるショート URL の識別名を指定します。

3

name

・最大 256 文字

String指定しない場合、自動的に下記が name として登録されます。
Shorturl-YYYYMMDDHHMMSSsss(sss はミリ秒)

4longUrl

StringdomainString〇ショート URL に変換するオリジナル URL を指定します。
・最大 2048 文字
ショート URL に変換する際のドメインを指定します。

5※独自ドメインオプションをお申し込みいただいているお客様のみご指定可
能です© AI CROSS,Inc. All Rights Reserved.

- 43 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.6.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。
送信処理結果を示すメッセージです。

2

1

responseMessage

String3

1

shortUrl

String

生成されたショート URL です。

4

1

name

Stringリクエスト時に指定した生成されたショート URL の識別名です。

※結果コードの項を参照してください。

レスポンスサンプル➢

成功時（0）：{"responseCode":0,"responseMessage":"Success.","shortUrl":"https://ai9.jp/iBJ
LlO","name":"shortUrlSample"}➢

失敗時（1～）：{"responseCode":110,"responseMessage":"Invalid
longUrl.","shortUrl":null,"name":null}© AI CROSS,Inc. All Rights Reserved.

- 44 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.6.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

120{項目名} too long.

{項目名}の項目の文字長が上限を超えています。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 45 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.7. 登録済み定型文取得
API により、管理画面で登録した定型文の一覧を取得することが可能です。

2.7.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/template.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ型

必須

String○概要
アカウント登録時に発行されるアクセスキーを指定します。トークンの値につ

1

token

きましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。

2

clientId

String○

割り当てられている契約クライアント ID につきましては、管理画面のクライ
アント情報をご確認ください。
・半角数字© AI CROSS,Inc. All Rights Reserved.

- 46 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.7.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

String概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。
送信処理結果を示すメッセージです。

2

1

responseMessage

String

3

1

count

Integer

4

1

templates

List

階層 2 の項目を配列にて保持します。

5

2

title

String

定型文のタイトルです。

62

default_content

String

全キャリア共通の定型文メッセージです。

72

parameters

List

階層 3 の項目を配列にて保持します。

83

parameter_name

String※結果コードの項を参照してください。
登録済の定型文の件数です。

定型文に埋め込まれているパラメータです。本項目は定型文に埋め込まれたパラメータの件数分だけ繰り返されます。

© AI CROSS,Inc. All Rights Reserved.

- 47 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","count": 2,"templates": [{"title": "demo_sample_01","default_content": "demo_sample_01","parameters": []},{"title": "demo_sample_02","default_content": "{{%demo%}}_{{%sample%}}_02","parameters": [{"parameter_name": "demo"},{"parameter_name": "sample"
}
]
}
]
}

➢

失敗時（1～）：{"responseCode":100,"responseMessage":"RequiredclientId.","count":0,"templates":null}© AI CROSS,Inc. All Rights Reserved.

- 48 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.7.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 49 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.8. 電話番号クリーニング
API によって電話番号クリーニングを行うことができます。
※

この機能を利用するためにはオプション契約が必要となります。

2.8.1. リクエスト
接続先 URL

https://sms-api.aossms.com/p5/api/numbercleaning.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ型

必須

String○概要
アカウント登録時に発行されるアクセスキーを指定します。

1

token

トークンの値につきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID を指定します。

2

clientId

String○

割り当てられている契約クライアント ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字
判定対象電話番号を指定します。

3

phoneNumber

String〇

日本国内形式(070xxxxxxxx/080xxxxxxxx/090xxxxxxxx)、国際電話番号形式のどちらも指定することが可能です。
判定を行う基準となる日を指定します。

4referenceDate

String〇・2 年前～当日まで有効
・半角数字
・YYYYMMDD 形式© AI CROSS,Inc. All Rights Reserved.

- 50 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.8.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

responseCode

Integer

概要
応答コードです。
正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

1

responseMessage

String

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。
リクエスト時に指定した送信先電話番号です。

31

phoneNumber

String

国際電話番号形式で返却されます。
※国際電話番号形式については『別記事項・国際電話番号形式について』をご参照ください。
リクエスト時に指定した判定を行う基準日です。

41referenceDate

String・半角数字
・YYYYMMDD 形式
名義人変更判定結果の状態です。

5

1

statusStringT ：他人名義と判定された
N：本人
ERROR：判定 DB になく判定不可

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","phoneNumber": "+819012345678"," referenceDate": "20170531","status": "N"}➢

失敗時（1～）：{"responseCode": 1,"responseMessage": " Required clientId.","phoneNumber": Null," referenceDate": Null,"status": Null}

© AI CROSS,Inc. All Rights Reserved.

- 51 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.8.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 52 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.9. 通数集計
API によってキャリア別の通数を取得することができます。

2.9.1. リクエスト
接続先 URL
https://sms-api.aossms.com/p5/api/separatedsuccesscount.json※

以下のパラメータを URL エンコードにて追加し、GET メソッドにて呼び出します。

No

項目名

データ型

必須

String○概要
アカウント登録時に発行されるアクセスキーを指定します。

1

token

トークンの値につきましては、管理画面のアカウント情報をご確認ください。
・半角英数字契約クライアント ID または all を指定します。
※all は代理店参照者のみ使用可能です。

2

clientId

String○

割り当てられている契約クライアント ID につきましては、管理画面のクライアント情報をご確認ください。
・半角数字
・all（代理店参照者のみ）取得する年月を指定します。取得できる期間はデータ保持期間の間のみです。

3

month

String〇・半角数字
・YYYYMM 形式※当月を指定する場合、取得できる件数は前日までのものとなります。

© AI CROSS,Inc. All Rights Reserved.

- 53 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

2.9.2. レスポンス※

API 呼び出し結果として応答データ(JSON 形式)を返却します。

レスポンスパラメータ

No

階層

1

1

項目名

データ型

概要
応答コードです。

responseCode

Integer

正常時は 0 を返します。1 以上の場合はエラーになります。
※結果コードの項を参照してください。

2

1

responseMessage

String3

1

separatedSuccessCount

List

4

2

clientId

Interger

5

2

101

Interger

6

2

103

Interger

7

2

105

Interger

8

2

106

Interger

送信処理結果を示すメッセージです。
※結果コードの項を参照してください。
階層 2 の項目を配列で保持します。
お客様毎に割り当てられた本サービスのクライアント ID です。
※0 通の場合は表示されません。
指定年月の au 通数です。
※0 通の場合は表示されません。
指定年月のドコモ通数です。
※0 通の場合は表示されません。
指定年月のソフトバンク通数です。
※0 通の場合は表示されません。
指定年月の楽天モバイル通数です。
※0 通の場合は表示されません。

※取得した日時によっては請求書と差異が発生する可能性があります。
差異が発生した場合は請求書を正とさせて頂きます。

© AI CROSS,Inc. All Rights Reserved.

- 54 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

レスポンスサンプル➢

成功時（0）：{"responseCode": 0,"responseMessage": "Success.","separatedSuccessCount": [{"clientId": 12345,"101": 1274094,"105": 1163321,"103": 1608969,"106": 258990
}
]
}

➢

失敗時（1～）：{"responseCode": 100,
"responseMessage": "Required clientId.","separatedSuccessCount": null}

2.9.3. 結果コード※API で返却される responseCode と responseMessage を下記に定義します。

responseCode

responseMessage

説明

0Success.

リクエストが成功しました。

100

Required {項目名}.

{項目名}の項目が不足しています。

110

Invalid {項目名}.

{項目名}の項目が不正です。

500

System error.

上記で定義外のエラーが発生しました。

※responseCode:0 が返却されていない場合、リクエストの受け付けには失敗しています。

© AI CROSS,Inc. All Rights Reserved.

- 55 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

3. 別記事項
3.1. 国際電話番号形式について
本資料上のリクエストパラメータで『国際電話番号』形式としてある場合、以下に記載する国際電話番号形式に則った電話番号の指定が必要になります。
・先頭が半角記号＋より始まる (注意:GET/POST 送信時は URL エンコードが必要)
・国番号 81
・国番号の次の 1 文字は 7,8,9 のいずれか
・以降、任意の半角数字 8 桁•

xml タグ指定例)+818010007765•

URL エンコード指定例)%2b818010007765 (%2b が半角プラス+を URL エンコードした文字列になります)3.2. ステータス ID について
本サービスのステータス ID 設定値とメッセージは以下の通りです。
設定値
0
1
2
3

メッセージ

備考

Unknown
Message is Sending
Message delivered
Message delivery failed

状態不明
配信中
送達
配信失敗

3.3. レスポンスの rawdata について
各レスポンスの rawdata は廃止予定のため参照は推奨いたしません。

© AI CROSS,Inc. All Rights Reserved.

- 56 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

3.4. 詳細内部コード（detailedStatusId）について
本サービスの詳細内部コードは配信失敗の場合、モジュールコード(先頭 2 桁) + 分類コード(末尾 3 桁)」の 5桁で構成されます。詳細内部コード設定値の主要な値は以下の通りです。
※

詳細内部コードは将来予告なく追加・変更される可能性があります。そのためプログラム実装では厳密に参照することは避け例外を許容することをお勧めいたします。
モジュールコード(先頭 2 桁)
11～14
31,32
51,52
61,62
分類コード
(末尾 3 桁)
721
732
821
823
824
833
834

該当キャリアAU
DocomoSoftbank
楽天モバイル内容

起因箇所

輻輳
欠番、顧客都合輻輳
ネットワーク起因（圏外、電源 OFF 含む）
圏外、電源 OFF 等
圏外、話中、電源 OFF 等
移動機側エラー（SMS 拒否設定等 ）キャリア、送信先端末
送信先端末
送信先端末
キャリア、送信先端末
送信先端末
送信先端末
送信先端末

3.5. Y!Mobile （旧 Willcom、PHS 回線）について
Y!Mobile （旧 Willcom、PHS 回線）は 2021 年 1 月 31 日（日）にサービス終了しました。

以上© AI CROSS,Inc. All Rights Reserved.

- 57 -

CONFIDENTIAL
絶対リーチ！® SMS communicationPlatform API 仕様書

CONFIDENTIAL
本文書は、AI CROSS 株式会社が著作権その他の権利を有する営業秘密です。当社の許可なく複製し利用すること、また漏洩することは「著作権法」「不正競争防止法」によって禁じられております。

© AI CROSS,Inc. All Rights Reserved.

- 58 -