Classic/VPC環境で利用できます。
メッセージの送信結果を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /sms/v2/services/{serviceId}/messages/{messageId} |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | SMSサービス ID
|
messageId |
String | Required | メッセージ ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://sens.apigw.ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/messages/f574d3f0-****-****-****-daa31f50eaf5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
statusCode |
String | Required | 状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Required | メッセージ情報 |
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
messageId |
String | Required | メッセージ ID |
requestTime |
String | Required | リクエスト日時
|
contentType |
String | Required | メッセージコンテンツタイプ
|
type |
String | Required | メッセージタイプ
|
subject |
String | Required | メッセージの件名 |
content |
String | Required | メッセージの内容 |
countryCode |
String | Required | 国コード |
from |
String | Required | 送信番号 |
to |
String | Required | 受信番号 |
completeTime |
String | Optional | 完了日時
|
telcoCode |
String | Optional | 通信キャリアコード |
files |
Array | Optional | 添付ファイルリスト |
status |
String | Required | リクエスト状態
|
statusCode |
String | Optional | 受信結果コード |
statusName |
String | Optional | 受信状態
|
statusMessage |
String | Optional | 受信状態メッセージ |
files
filesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
fileId |
String | Required | ファイル ID |
name |
String | Required | ファイル名 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"statusCode": "200",
"statusName": "success",
"messages": [
{
"requestId": "RSMA-*************-****-********-ijYyjJqS",
"messageId": "f574d3f0-****-****-****-daa31f50eaf5",
"requestTime": "2025-11-25 10:17:00",
"contentType": "COMM",
"type": "MMS",
"subject": "Delivery",
"content": "Hello, ******. This is for notifying your delivery status.",
"countryCode": "82",
"from": "010********",
"to": "010********",
"completeTime": "2025-11-25 10:17:00",
"telcoCode": "ETC",
"files": [
{
"fileId": "a136************************74f7",
"name": "G0ufjqMy3wBpCucJenTaU.jpg"
}
],
"status": "COMPLETED",
"statusCode": "3018",
"statusName": "fail",
"statusMessage": "携帯電話加入通信キャリアを通じて送信番号偽装防止付加サービスに登録した番号を送信番号として使用する場合"
}
]
}
受信結果コード
EMMA v3.5.1以降において、SMSメッセージ送信後の受信結果を表すコードです。EMMA受信結果コードは次の3つに分類されます。
- IB G/W Report Code: 通信キャリアにメッセージ送信後に返された結果コード
- IB G/W Response Code: 中継会社のゲートウェイがメッセージ受信後に返す結果コード
- IB EMMA: EMMAがメッセージ送信リクエスト処理中に発生したエラーコード
IB G/W Report Code
IB G/W Reportコード別の説明は次の通りです。
| コード | 分類 | 説明 |
|---|---|---|
| 0 | success | 成功 |
| 2000 | failure | 送信時間オーバー |
| 2001 | failure | 送信失敗 (無線網で) |
| 2002 | failure | 送信失敗 (無線網 > 端末) |
| 2003 | failure | 端末の電源オフ |
| 2004 | failure | 端末のメッセージバッファフル |
| 2005 | failure | 陰影地域 |
| 2006 | failure | メッセージが削除される |
| 2007 | failure | 一時的な端末の問題 |
| 3000 | Invalid | 送信できない |
| 3001 | Invalid | 加入者なし |
| 3002 | Invalid | 成人認証失敗 |
| 3003 | Invalid | 受信番号形式エラー |
| 3004 | Invalid | 端末サービスの一時停止 |
| 3005 | Invalid | 端末が呼処理状態 |
| 3006 | Invalid | 着信拒否 |
| 3007 | Invalid | Callback URLを受け取れない携帯電話 |
| 3008 | Invalid | その他の端末問題 |
| 3009 | Invalid | メッセージ形式エラー |
| 3010 | Invalid | MMSに対応しない端末 |
| 3011 | Invalid | サーバエラー |
| 3012 | Invalid | スパム |
| 3013 | Invalid | サービスの拒否 |
| 3014 | Invalid | その他 |
| 3015 | Invalid | 送信経路なし |
| 3016 | Invalid | 添付ファイルのサイズ制限に失敗 |
| 3017 | Invalid | 送信番号の偽装防止細則に違反 |
| 3018 | Invalid | 送信番号の偽装防止サービスに登録した携帯電話の個人加入者番号 |
| 3019 | Invalid | KISAまたは未来創造科学部からすべての顧客企業に遮断処理を要請した送信番号 |
| 3022 | Invalid | Charset Conversion Error |
| 3023 | Invalid | 送信番号事前登録制により登録されていない番号 |
IB G/W Response Code
IB G/W Responseコード別の説明は次の通りです。
| コード | 説明 |
|---|---|
| 1001 | Server Busy (RS内部保存 Queue Full) |
| 1002 | 受信番号形式エラー |
| 1003 | 返信番号形式エラー |
| 1004 | スパム |
| 1005 | 使用件数オーバー |
| 1006 | 添付ファイルなし |
| 1007 | 添付ファイル有り |
| 1008 | 添付ファイルの保存失敗 |
| 1009 | CLIENT_MSG_KEYなし |
| 1010 | CONTENTなし |
| 1011 | CALLBACKなし |
| 1012 | RECIPIENT_INFOなし |
| 1013 | SUBJECTなし |
| 1014 | 添付ファイルキーなし |
| 1015 | 添付ファイル名なし |
| 1016 | 添付ファイルサイズなし |
| 1017 | 添付ファイル Contentなし |
| 1018 | 送信権限なし |
| 1019 | TTLオーバー |
| 1020 | charset conversion error |
| S000 | 中継会社へのリクエストに失敗(サーバエラー) |
| S001 | 中継会社へのリクエストに失敗(サーバエラー) |
| S002 | 中継会社へのリクエストに失敗(無効なリクエスト) |
| S003 | 中継会社へのリクエストに失敗(スパム処理) |
| S004 | クォーター超過 |
| S005 | 無効な MMSファイル |
| S006 | MMSファイルが見つからない |
| S007 | MMSファイルが有効期限切れ |
| S008 | MMSファイルサイズ超過 |
| S009 | MMSファイルの解像度超過 |
| S010 | MMSファイルのアップロードクォータ超過 |
| S011 | MMSファイルアップロード失敗 |
| S012 | 送信番号細則エラー |
| S998 | 予期せぬサーバエラー |
| S999 | その他のエラー |
IB EMMA
IB EMMAコード別の説明は次の通りです。
| コード | 説明 |
|---|---|
| E900 | Invalid-IB送信キーがない場合 |
| E901 | 受信番号がない場合 |
| E902 | 同報である場合、受信番号順番がない場合 |
| E903 | 件名がない場合 |
| E904 | メッセージがない場合 |
| E905 | 返信番号がない場合 |
| E906 | メッセージキーがない場合 |
| E907 | 同報の有無がない場合 |
| E908 | サービスタイプがない場合 |
| E909 | 送信リクエスト時刻がない場合 |
| E910 | TTLタイムがない場合 |
| E911 | サービスタイプが MMS MTの場合、添付ファイルの拡張子がない場合 |
| E912 | サービスタイプが MMS MTの場合、attach_fileフォルダに添付ファイルがない場合 |
| E913 | サービスタイプが MMS MTの場合、添付ファイルのサイズが0の場合 |
| E914 | サービスタイプが MMS MTの場合、メッセージテーブルにはファイルグループキーがあるのにファイルテーブルにはデータがない場合 |
| E915 | 重複メッセージ |
| E916 | 認証サーバブロック番号 |
| E917 | 顧客 DBブロック番号 |
| E918 | USER CALLBACK FAIL |
| E919 | 送信制限時間である場合、メッセージ再送処理が禁止された場合 |
| E920 | サービスタイプが LMS MTの場合、メッセージテーブルにファイルグループキーがある場合 |
| E921 | サービスタイプが MMS MTの場合、メッセージテーブルにファイルグループキーがない場合 |
| E922 | 同報単語の制限文字使用のエラー |
| E999 | その他のエラー |