SMS API

Prev Next

基本情報

API URL

https://sens.apigw.ntruss.com/sms/v2

SENS SMS API Swaggerへ

API Header

項目 Mandatory 説明
Content-Type Mandatory リクエスト Body Content Typeを application/jsonに指定(POST)
x-ncp-apigw-timestamp Mandatory - 1970年1月1日 00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す
- API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key Mandatory ポータルまたは Sub Accountで発行された Access Key ID
x-ncp-apigw-signature-v2 Mandatory - 上記例の Bodyを Access Key IDとマッピングする SecretKeyで暗号化した署名
- HMAC暗号化アルゴリズムは、HmacSHA256を使用

NAVERクラウドプラットフォームの認証キーおよび Signature作成ガイド

メッセージ

メッセージの送信

SMS/LMS/MMSメッセージを送信します。

リクエスト URL

POST https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Headers

API Headerへ

リクエストボディ

{
    "type":"(SMS | LMS | MMS)",
    "contentType":"(COMM | AD)",
    "countryCode":"string",
    "from":"string",
    "subject":"string",
    "content":"string",
    "messages":[
        {
            "to":"string",
            "subject":"string",
            "content":"string"
        }
    ],
    "files":[
        {
             "fileId": "string"
        }
    ],
    "reserveTime": "yyyy-MM-dd HH:mm",
    "reserveTimeZone": "string"
}
項目 Mandatory Type 説明 備考
type Mandatory String SMS Type SMS、LMS、MMS (小文字の使用可能)
contentType Optional String メッセージ Type - COMM: 一般メッセージ
- AD: 広告メッセージ
- デフォルト: COMM
countryCode Optional String 国番号 - SENSで提供する国への送信のみ可能
- デフォルト: 82
- 国際 SMS送信国リスト
from Mandatory String 発信番号 事前登録された発信番号のみ使用可能
subject Optional String 基本メッセージの件名 LMS、MMSでのみ使用可能
- LMS、MMS: 最大40byte
content Mandatory String 基本メッセージの内容 - SMS: 最大90byte
- LMS、MMS: 最大2000Bytes
messages Mandatory Object メッセージ情報 - 以下の項目を参照(messages.XXX)
- 最大100個
messages.to Mandatory String 受信番号 ハイフン「-」なしの数字のみ入力可能
messages.subject Optional String 個別メッセージの件名 LMS、MMSでのみ使用可能
- LMS、MMS: 最大40byte
messages.content Optional String 個別メッセージの内容 - SMS: 最大90byte
- LMS、MMS: 最大2000Bytes
files.fileId Optional String ファイル ID MMSでのみ使用可能
ファイルのアップロードを参照
reserveTime Optional String 予約日時 メッセージの送信予約日時(yyyy-MM-dd HH:mm)
reserveTimeZone Optional String 予約日時のタイムゾーン - 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
- サポートタイムゾーンリスト
- TZ database nameの値を使用
注意
  • サポート可能な最大サイズを超えると、一部の内容が切り捨てられて送信されます。
  • メッセージ(subject、content)エンコードは EUC-KRベースで送信され、サポートしていない絵文字を含めると送信は失敗します。
参考
  • messages内で subject、contentを定義しないと、デフォルトで subject、contentに指定された値で送信されます。
  • messages内の subject、contentが、デフォルトの subject、contentより高い優先度を持ちます。
  • MMS typeなのに添付するファイルがない場合は LMSで送信されます。

レスポンスボディ

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string"
}
項目 Mandatory Type 説明 備考
requestId Mandatory String リクエスト ID
requestTime Mandatory DateTime リクエスト時間 yyyy-MM-dd'T'HH:mm:ss.SSS
statusCode Mandatory String リクエスト状態コード - 202: 成功
- その他: 失敗
- HTTP Status規格に従う
statusName Mandatory String リクエスト状態名 - success: 成功
- fail: 失敗

レスポンスステータス

HTTP Status Desc
202 Accept (リクエスト完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

ファイルのアップロード

MMS送信のためのファイルをアップロードします。

リクエスト URL

POST https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/files

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Headers

リクエストボディ

{
    "fileName":"string",
    "fileBody":"string"
}
項目 Mandatory Type 説明 備考
fileName Mandatory String ファイル名 - .jpg、.jpeg拡張子を持つファイル名
- 最大40文字
fileBody Mandatory String ファイルボディ - .jpg、.jpeg画像を Base64にエンコードした値
- ソースファイル基準で最大300KB
- 解像度 最大1500 * 1440
参考

アップロード対象のファイルと同じ名前とサイズを持つファイルが既に存在する場合は、同じファイルと認識してファイルを再利用します (6日間保管)。

レスポンスボディ

{
    "fileId":"string",
    "createTime":"string",
    "expireTime":"string"
}
項目 Mandatory Type 説明 備考
fileId Mandatory String ファイル ID MMSメッセージ送信時に活用
createTime Mandatory DateTime ファイルアップロード時間
expireTime Mandatory DateTime ファイルの有効期限

レスポンスステータス

HTTP Status Desc
200 OK (アップロード完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

メッセージ送信リクエストの照会

メッセージの送信リクエストを照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/messages

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Parameters

項目 Mandatory Type 説明 備考
requestId Mandatory String リクエスト ID 送信リクエスト ID
requestStartTime Mandatory String 照会時間の開始時刻 yyyy-MM-dd HH:mm:ss
requestEndTime Mandatory String 照会時間の終了時刻 yyyy-MM-dd HH:mm:ss
completeStartTime Mandatory String 送信完了の開始時間 yyyy-MM-dd HH:mm:ss
completeEndTime Mandatory String 送信完了の終了時間 yyyy-MM-dd HH:mm:ss
messageId Optional String メッセージ ID
type Optional String メッセージタイプ SMS, LMS, MMS
contentType Optional String コンテンツタイプ - COMM: 一般メッセージ
- AD: 広告メッセージ
countryCode Optional String 国コード
status Optional String 送信リクエスト状態 - READY: 待機
- PROCESSING: 処理中
- COMPLETED: 処理完了
from Optional String メッセージ発信番号 ハイフン「-」を除く番号
to Optional String メッセージ受信番号 ハイフン「-」を除く番号
statusName Optional String 端末の受信状態 - SUCCESS: 成功
- FAIL: 失敗
nextToken Optional String 次のページのトークン 下記参照
pageSize Optional Integer ページサイズ デフォルト: 20, 最大: 100
requestIdを含めて照会する場合、デフォルト: 1000
参考
  • メッセージの送信履歴は直近90日以内の履歴のみ照会できます。
  • requestId、requestStartTime + requestEndTime、completeStartTime + completeEndTimeのうち少なくとも1つは必須です。
  • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時には使用できません。
  • requestStartTime ~ requestEndTimeの照会範囲は最大30日に制限されます。
  • completeStartTime ~ completeEndTimeの照会範囲は最大24時間に制限されます。
  • nextToken
    • 前のリクエストでnextTokenレスポンスを受け取った場合にのみ有効で、次のページの結果をリクエストできることを示します。追加結果がある場合、前のレスポンスのnextTokenの値をこの Parameterに設定すると、次のページの結果を照会できます。

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

{
    "statusCode": "string",
    "statusName": "string",
    "messages": [
        {
            "requestId": "string",
            "messageId": "string",
            "requestTime": "string",
            "contentType": "string",
            "type": "string",
            "countryCode": "string",
            "from": "string",
            "to": "string",
            "completeTime": "string",
            "telcoCode": "string",
            "status": "string",
            "statusCode": "string",
            "statusName": "string",
            "statusMessage": "string"
        }
    ],
    "pageSize": "integer",
    "nextToken": "string",
    "itemCount": "integer",
    "hasMore": "boolean"
}
項目 Mandatory Type 説明 備考
statusCode Mandatory String メッセージングサーバへの送信リクエスト状態 - 202: 成功
- その他: 失敗
- HTTP Status規格に従う
statusName Mandatory String メッセージングサーバへの送信リクエスト状態名 - success: 成功
- reserved: 予約中
- fail: 失敗
messages.requestId Mandatory String メッセージリクエスト ID
messages.messageId Mandatory String メッセージ ID
messages.requestTime Mandatory String 送信リクエスト時間 yyyy-MM-dd HH:mm:ss
messages.contentType Mandatory String メッセージ Type - COMM: 一般メッセージ
- AD: 広告メッセージ
messages.countryCode Mandatory String 国番号
messages.from Mandatory String 発信番号
messages.to Mandatory String 受信番号
messages.status Mandatory String 送信リクエスト状態 - READY: 待機
- PROCESSING: 処理中
- COMPLETED: 処理完了
messages.statusCode Optional String 端末の受信状態結果コード - 0: 成功
- その他: 失敗エラーコード表を参照
messages.statusName Optional String 端末の受信状態結果名 - success: 成功
- fail: 失敗
messages.statusMessage Optional String 端末の受信状態結果メッセージ
messages.completeTime Optional String 送信完了時間 yyyy-MM-dd HH:mm:ss
messages.telcoCode Optional String 通信キャリアコード
pageSize Mandatory Integer ページサイズ
nextToken Optional String 次のページのトークン 下記参照
itemCount Mandatory Integer 照会結果ページ内のメッセージ数
hasMore Mandatory Boolean 次のページの存在有無
参考

リクエスト状態が完了(status: COMPLETED)になる前は、受信結果に対応する以下のフィールドは照会できません。

  • statusCode
  • statusName
  • statusMessage
  • completeTime
  • telcoCode

メッセージングサーバへの送信リクエスト状態名が reserved(予約中)の場合、messagesは照会できません。

  • nextToken
    • 照会された結果の次のページが存在する場合にのみnextTokenがレスポンスに含まれます。nextTokenの値をリクエスト照会 API Parameterに設定すると、次のページの結果を照会できます。

レスポンスステータス

HTTP Status Desc
200 OK (リクエスト完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

メッセージ送信結果の照会

メッセージの送信結果を照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID
messageId Mandatory String メッセージ ID メッセージ送信リクエストを照会する時に返されるメッセージ識別子

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

{
    "statusCode":"string",
    "statusName":"string",
    "messages":[
        {
            "requestTime":"string",
            "contentType":"string",
            "content":"string",
            "countryCode":"string",
            "from":"string",
            "to":"string",
            "status":"string",
            "statusCode":"string",
            "statusMessage":"string",
            "statusName":"string",
            "completeTime":"string",
            "telcoCode":"string",
            "files":[
                {
                    "name":"string",
                    "fileId":"string"
                }
            ]
        }
    ]
}
項目 Mandatory Type 説明 備考
statusCode Mandatory String メッセージングサーバへの送信リクエスト状態 - 200: 成功
- その他: 失敗
statusName Mandatory String メッセージングサーバへの送信リクエスト状態名 - success: 成功
- fail: 失敗
messages.requestTime Mandatory DateTime リクエスト時間 yyyy-MM-dd HH:mm:ss
messages.contentType Mandatory String メッセージ Type - COMM: 一般メッセージ
- AD: 広告メッセージ
messages.content Mandatory String メッセージの内容 送信リクエストした contentがそのまま照会されるが、実際は type別長さ制限に合わせて送信
messages.countryCode Mandatory String 国番号
messages.from Mandatory String 発信番号
messages.to Mandatory String 受信番号
messages.status Mandatory String メッセージングサーバでの送信処理状態 - READY: 待機
- PROCESSING: 処理中
- COMPLETED: 処理完了
messages.statusCode Mandatory String 端末の受信状態結果コード - 0: 成功
- その他: 失敗エラーコード表を参照
messages.statusName Mandatory String 端末の受信状態結果名 - success: 成功
- fail: 失敗
messages.statusMessage Mandatory String 端末の受信状態結果メッセージ
messages.completeTime Mandatory DateTime 送信完了時間 yyyy-MM-dd HH:mm:ss
messages.telcoCode Mandatory String 通信キャリアコード
files.name Optional String 添付したファイル名 MMSでのみ照会可能
files.fileId Optional String 添付したファイル ID MMSでのみ照会可能
参考

メッセージの送信結果履歴は直近90日以内の履歴のみ照会できます。

レスポンスステータス

HTTP Status Desc
200 OK (リクエスト完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

予約メッセージ

予約メッセージ状態の照会

メッセージの予約送信状態を照会します。

GET https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID
reserveId Mandatory String 予約メッセージ ID 予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

{
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}
項目 Mandatory Type 説明 備考
reserveId Mandatory String 予約メッセージ ID 予約送信リクエスト照会時に返されるメッセージ識別子(requestId)
reserveTime Mandatory String 予約日時 メッセージの送信予約日時(yyyy-MM-dd HH:mm)
reserveTimeZone Mandatory String 予約日時のタイムゾーン - 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
- サポートタイムゾーンリスト
- TZ database nameの値を使用
reserveStatus Mandatory String 予約の状態 - READY: 送信待ち
- PROCESSING: 送信リクエスト中
- CANCELED: 送信キャンセル
- FAIL: 送信リクエスト失敗
- DONE: 送信リクエスト成功
- STALE: 送信リクエスト失敗(時間オーバー)

レスポンスステータス

HTTP Status Desc
200 OK(照会完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

予約メッセージのキャンセル

メッセージの送信予約をキャンセルします。

DELETE https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID
reserveId Mandatory String 予約メッセージ ID 予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

なし

レスポンスステータス

HTTP Status Desc
204 No Content(削除完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

080受信拒否番号

受信拒否番号の照会

受信拒否された番号を照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Parameters

項目 Mandatory Type 説明 備考
clientTelNo Optional String 受信拒否番号 080サービス番号に登録された受信拒否番号
pageSize Optional Integer ページサイズ - デフォルト: 100
- 0~100までの数字のみ入力可能
pageIndex Optional Integer ページインデックス デフォルト: 0
startTime Optional Integer 照会開始時間 - 受信拒否の登録時間基準
- デフォルト: すべて
endTime Optional Integer 照会終了時間 - 受信拒否の登録時間基準
- デフォルト: すべて

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

[
    {
     "clientTelNo": "string",
     "registerTime": "string",
     "registerType": "char"
    }
]
項目 Mandatory Type 説明 備考
clientTelNo Mandatory String 受信拒否番号
registerTime Mandatory String 登録時間 foramt: LocalDateTime
registerType Mandatory Char 登録手段 - M(manual): 手動登録
- C(call): 電話での登録

レスポンスステータス

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

受信拒否番号の登録

受信拒否する番号を登録します。

リクエスト URL

POST https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Parameters

なし

Headers

API Headerへ

リクエストボディ

[
    {
        "clientTelNo":"string"
    }
]
項目 Mandatory Type 説明 備考
clientTelNo Mandatory String 受信拒否番号 一度に1,000件までリクエスト可能(List)

レスポンスボディ

[
    {
        "clientTelNo": "string",
        "registerTime": "string",
        "registerType": "char"
    }
]
項目 Mandatory Type 説明 備考
clientTelNo Mandatory String 受信拒否番号
registerTime Mandatory String 登録時間 foramt: LocalDateTime
registerType Mandatory Char 登録手段 - M(manual): 手動登録
- C(call): 電話での登録

レスポンスステータス

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

受信拒否番号の削除

受信拒否された番号を削除します。

リクエスト URL

DELETE https://sens.apigw.ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目 Mandatory Type 説明 備考
serviceId Mandatory String サービス ID プロジェクト登録時に発行されたサービス ID

Parameters

なし

Headers

API Headerへ

リクエストボディ

[
    {
        "clientTelNo":"string"
    }
]
項目 Mandatory Type 説明 備考
clientTelNo Mandatory String 受信拒否番号 一度に1,000件までリクエスト可能(List)

レスポンスボディ

なし

レスポンスステータス

HTTP Status Desc
204 No Content(削除完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

メッセージ送信の例

SMSメッセージ

一般メッセージ

{
    "type":"SMS",
    "contentType":"COMM",
    "countryCode":"82",
    "from":"01012345678",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ]
}

予約メッセージ

{
    "reserveTime":"2019-07-25 17:09",
    "type":"SMS",
    "contentType":"COMM",
    "countryCode":"82",
    "from":"01012345678",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ]
}

広告メッセージ

{
    "type":"SMS",
    "contentType":"AD",
    "countryCode":"82",
    "from":"01012345678",
    "content":"(広告) 会社名、内容 [無料受信拒否]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "content":"(広告) 会社名、上記の contentとは別に当該番号にのみ送る内容(optional) [無料受信拒否]08012345678"
        }
    ]
}

LMSメッセージ

一般メッセージ

{
    "type":"LMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"件名",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ]
}

予約メッセージ

{
    "reserveTime":"2019-07-25 17:09",
    "type":"LMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"件名",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ]
}

広告メッセージ

{
    "type":"LMS",
    "contentType":"AD",
    "from":"01012345678",
    "subject":"件名",
    "content":"(広告) 会社名、内容 [無料受信拒否]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"(広告) 会社名、上記の contentとは別に当該番号にのみ送る内容(optional) [無料受信拒否]08012345678"
        }
    ]
}

MMSメッセージ

一般メッセージ

{
    "type":"MMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"件名",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}

予約メッセージ

{
    "reserveTime":"2019-07-25 17:09",
    "type":"MMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"件名",
    "content":"内容",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"上記の contentとは別に当該番号にのみ送る内容(optional)"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}

広告メッセージ

{
    "type":"MMS",
    "contentType":"AD",
    "from":"01012345678",
    "subject":"件名",
    "content":"(広告) 会社名、内容 [無料受信拒否]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "subject":"上記の contentとは別に当該番号にのみ送る件名(optional)",
            "content":"(広告) 会社名、上記の contentとは別に当該番号にのみ送る内容(optional) [無料受信拒否]08012345678"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}

エラーコード

EMMA v.3の受信結果コード

  • EMMA Version: EMMA V3.5.1以上
  • IB G/W Report Code: 通信キャリアに送信後に取得した結果コード
  • IB G/W Response Code: 中継会社のゲートウェイがメッセージ受信後に出す結果コード
  • IB EMMA: EMMAがメッセージ送信リクエストに対して処理したエラーコード

IB G/W Report Code

コード 分類 意味
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

コード 意味
1001 Server Busy (RS内部保存 Queue Full)
1002 受信番号形式エラー
1003 返信番号形式エラー
1004 SPAM
1005 使用件数オーバー
1006 添付ファイルなし
1007 添付ファイル有り
1008 添付ファイルの保存失敗
1009 CLIENT_MSG_KEYなし
1010 CONTENTなし
1011 CALLBACKなし
1012 RECIPIENT_INFOなし
1013 SUBJECTなし
1014 添付ファイル KEYなし
1015 添付ファイル NAMEなし
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

コード 意味
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 その他のエラー