各APIを操作してSMSメッセージを動かす前に、どのAPIでも共通的に利用される仕様があります。
APIご利用時には下記の点を確認して実装してください。
共通仕様
・ バージョン管理
リクエストヘッダにて、APIバージョンの指定が可能です。SMS送信、SMS送信結果取得(一括)、SMS送信結果取得(レコード単位)、SMS送信キャンセルは、APIバージョンの指定が必須です。
SMS送信結果返信(コールバック)は、サービス設定に登録されたAPIバージョンが適用されます。
例)Karaden-Version: 2023-01-01
・『Karaden』サービス開始直後のAPIバージョンは「2023-01-01」となります。
・リリース単位で、全てのAPIバージョンが更新されます。
例)
・2023年5月:APIバージョン「2023-01-01」で『Karaden』サービス開始。
・2023年6月:APIバージョン「2023-06-01」をリリース。
API | 「2023-06-01」の仕様変更有無 | 最新バージョン | 「2023-06-01」を指定した時の挙動 | 「2023-01-01」を指定した時の挙動 | バージョンを指定しない時の挙動 | リリースしていないバージョンを指定した時の挙動 |
SMS0001 | 〇 |
2023-06-01
|
「2023-06-01」の仕様で処理 |
「2023-01-01」の仕様で処理
|
エラー |
エラー
|
SMS0002 | - |
「2023-01-01」の仕様で処理
|
||||
SMS0003 | - | |||||
SMS0004 | - | |||||
SMS0005 | - |
・ステータス
<result>
物理名 | 論理名 | 値 | 説明 |
result
|
結果
|
done | 完了 |
processing | 処理中 |
<status>
物理名 | 論理名 | 値 | 説明 |
status
|
状態
|
done | 送信済 |
waiting | 送信待ち | ||
error | 送信エラー | ||
canceled | 送信キャンセル |
<sent_result>
物理名 | 論理名 | 値 | 説明 |
sent_result
|
送達結果
|
none | 送達結果なし |
received | 着信済 | ||
unconnected | 圏外 | ||
error | エラー | ||
unknown | 不明 |
<carrier>
物理名 | 論理名 | 値 | 説明 | 備考 | |
carrier
|
キャリア
|
docomo | ドコモ | ||
softbank | ソフトバンク | ||||
au | au | ||||
rakuten | 楽天 | ||||
checking | 判別中 | ||||
unknown | 不明 | 『Karaden』画面上では、空欄を表示。 |