SMS API
    • PDF

    SMS API

    • PDF

    Article Summary

    基本情報

    API URL

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

    SENS SMS API Swaggerに移動する

    API Header

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

    NAVER Cloud Platformの認証キーおよび 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

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

    Headers

    API Headerに移動する

    リクエスト Body

    {
        "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"
    }
    
    項目MandatoryType説明備考
    typeMandatoryStringSMS TypeSMS、LMS、MMS(小文字使用可能)
    contentTypeOptionalStringメッセージ Type- COMM: 一般メッセージ
    - AD: プッシュ型広告
    - default: COMM
    countryCodeOptionalString国番号- SENSが提供する国への送信のみ可能
    - default: 82
    - 国際 SMS送信国家リスト
    fromMandatoryString発信番号事前登録された発信番号のみ使用可能
    subjectOptionalString基本メッセージの件名LMS、MMSでのみ使用可能
    - LMS、MMS: 最大40byte
    contentMandatoryString基本メッセージの内容- SMS: 最大90byte
    - LMS、MMS: 最大2000byte
    messagesMandatoryObjectメッセージ情報- 以下の項目を参照(messages.XXX)
    - 最大100個
    messages.toMandatoryString受信番号ハイフン(-)を除く数字のみ入力可能
    messages.subjectOptionalString個別メッセージの件名LMS、MMSでのみ使用可能
    - LMS、MMS: 最大40byte
    messages.contentOptionalString個別メッセージの内容- SMS: 最大90byte
    - LMS、MMS: 最大2000byte
    files.fileIdOptionalStringファイル IDMMSでのみ使用可能
    ファイルアップロードを参照
    reserveTimeOptionalString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
    reserveTimeZoneOptionalString予約日時のタイムゾーン- 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
    - 対応タイムゾーンリスト
    - TZ database name値を使用
    注意
    • 最大対応可能サイズを超えると、一部の内容が削除されて送信されます。
    • メッセージ(subject、content)のエンコードは EUC-KR基準で送信され、対応しない絵文字を含めると送信に失敗します。
    参考
    • messages内で subjectと contentを定義しないと、デフォルト subject、contentに指定された値で送信されます。
    • messages内で subjectと contentがデフォルト subject、contentより優先順位が高いです。
    • MMS typeでも添付するファイルがない場合、LMSで送信されます。

    レスポンス Body

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

    レスポンス Status

    HTTP StatusDesc
    202Accept(リクエスト完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    429Too Many Requests
    500Internal 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

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

    Headers

    リクエスト Body

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

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

    レスポンス Body

    {
        "fileId":"string",
        "createTime":"string",
        "expireTime":"string"
    }
    
    項目MandatoryType説明備考
    fileIdMandatoryStringファイル IDMMSメッセージ送信時に活用
    createTimeMandatoryDateTimeファイルをアップロードした時間
    expireTimeMandatoryDateTimeファイル有効期限切れ時間

    レスポンス Status

    HTTP StatusDesc
    200OK(アップロード完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    429Too Many Requests
    500Internal 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

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

    Parameters

    項目MandatoryType説明備考
    requestIdMandatoryStringリクエスト ID送信リクエスト ID
    requestStartTimeMandatoryString照会時間開始時刻yyyy-MM-dd HH:mm:ss
    requestEndTimeMandatoryString照会時間終了時刻yyyy-MM-dd HH:mm:ss
    completeStartTimeMandatoryString送信完了開始時間yyyy-MM-dd HH:mm:ss
    completeEndTimeMandatoryString送信完了終了時間yyyy-MM-dd HH:mm:ss
    messageIdOptionalStringメッセージ ID
    typeOptionalStringメッセージタイプSMS, LMS, MMS
    contentTypeOptionalStringコンテンツタイプ- COMM: 一般メッセージ
    - AD: プッシュ型広告
    countryCodeOptionalString国コード
    statusOptionalString送信リクエストステータス- READY: 待機
    - PROCESSING: 処理中
    - COMPLETED: 処理完了
    fromOptionalStringメッセージ送信番号ハイフン(-)を除く番号
    toOptionalStringメッセージ受信番号ハイフン(-)を除く番号
    statusNameOptionalStringデバイスの受信ステータス- SUCCESS: 成功
    - FAIL: 失敗
    pageIndexOptionalIntegerページ番号default: 0
    pageSizeOptionalIntegerページサイズdefault: 20, max: 100
    requestIdを含んだ照会時、default: 1000
    参考
    • メッセージ送信履歴は、直近90日以内の履歴のみ照会できます。
    • requestIdまたは requestStartTime + requestEndTimeまたは completeStartTime + completeEndTimeのうちいずれかが必須です。
    • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時に使用できません。
    • requestStartTime ~ requestEndTimeの照会範囲は、最大30日に制限されます。
    • completeStartTime ~ completeEndTimeの照会範囲は、最大24時間に制限されます。

    Headers

    API Headerに移動する

    リクエスト Body

    なし
    

    レスポンス Body

    {
        "statusCode": "string",
        "statusName": "string",
        "messages": [
            {
                "requestId": "string",
                "campaignId": "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"
            }
        ],
        "pageIndex": "integer",
        "pageSize": "integer",
        "itemCount": "integer",
        "hasMore": "boolean"
    }
    
    項目MandatoryType説明備考
    statusCodeMandatoryStringメッセージングサーバへの送信リクエストステータス- 202: 成功
    - その他: 失敗
    - HTTP Status規格に従う
    statusNameMandatoryStringメッセージングサーバへの送信リクエストステータス名- success: 成功
    - reserved: 予約中
    - fail: 失敗
    messages.requestIdMandatoryStringメッセージリクエスト ID
    messages.messageIdMandatoryStringメッセージ ID
    messages.requestTimeMandatoryString送信リクエスト時間yyyy-MM-dd HH:mm:ss
    messages.contentTypeMandatoryStringメッセージ Type- COMM: 一般メッセージ
    - AD: プッシュ型広告
    messages.countryCodeMandatoryString国番号
    messages.fromMandatoryString発信番号
    messages.toMandatoryString受信番号
    messages.statusMandatoryString送信リクエストステータス- READY: 待機
    - PROCESSING: 処理中
    - COMPLETED: 処理完了
    messages.statusCodeOptionalStringデバイスの受信ステータスの結果コード- 0: 成功
    - その他: 失敗(エラーコード表を参照
    messages.statusNameOptionalStringデバイスの受信ステータスの結果名- success: 成功
    - fail: 失敗
    messages.statusMessageOptionalStringデバイスの受信ステータスの結果メッセージ
    messages.completeTimeOptionalString送信完了時間yyyy-MM-dd HH:mm:ss
    messages.telcoCodeOptionalString通信会社コード
    pageIndexMandatoryIntegerページのインデックス(0始まり)
    pageSizeMandatoryIntegerページサイズ
    itemCountMandatoryInteger照会したページ内のメッセージ数
    hasMoreMandatoryBoolean次のページの存在有無
    参考

    リクエストステータスが完了(status: COMPLETED)になるまでは、受信結果に該当する以下のフィールドは照会されません。

    • statusCode
    • statusName
    • statusMessage
    • completeTime
    • telcoCode

    メッセージングサーバへの送信リクエストステータス名が reserved(予約中)の場合、messagesフィールドは照会されません。

    レスポンス Status

    HTTP StatusDesc
    200OK(リクエスト完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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

    項目MandatoryType説明備考
    serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
    messageIdMandatoryStringメッセージ IDメッセージ送信リクエストの照会時に返されるメッセージ識別子

    Headers

    API Headerに移動する

    リクエスト Body

    なし
    

    レスポンス Body

    {
        "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"
                    }
                ]
            }
        ]
    }
    
    項目MandatoryType説明備考
    statusCodeMandatoryStringメッセージングサーバへの送信リクエストステータス- 200: 成功
    - その他: 失敗
    statusNameMandatoryStringメッセージングサーバへの送信リクエストステータス名- success: 成功
    - fail: 失敗
    messages.requestTimeMandatoryDateTimeリクエスト時間yyyy-MM-dd HH:mm:ss
    messages.contentTypeMandatoryStringメッセージ Type- COMM: 一般メッセージ
    - AD: プッシュ型広告
    messages.contentMandatoryStringメッセージの内容送信リクエストした contentをそのまま照会できるが、実際の送信は type別の長さ制限に合わせて送信
    messages.countryCodeMandatoryString国番号
    messages.fromMandatoryString発信番号
    messages.toMandatoryString受信番号
    messages.statusMandatoryStringメッセージングサーバでの送信処理ステータス- READY: 待機
    - PROCESSING: 処理中
    - COMPLETED: 処理完了
    messages.statusCodeMandatoryStringデバイスの受信ステータスの結果コード- 0: 成功
    - その他: 失敗(エラーコード表を参照
    messages.statusNameMandatoryStringデバイスの受信ステータスの結果名- success: 成功
    - fail: 失敗
    messages.statusMessageMandatoryStringデバイスの受信ステータスの結果メッセージ
    messages.completeTimeMandatoryDateTime送信完了時間yyyy-MM-dd HH:mm:ss
    messages.telcoCodeMandatoryString通信会社コード
    files.nameOptionalString添付したファイル名MMSでのみ照会可能
    files.fileIdOptionalString添付したファイル IDMMSでのみ照会可能
    参考

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

    レスポンス Status

    HTTP StatusDesc
    200OK(リクエスト完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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

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

    Headers

    API Headerに移動する

    リクエスト Body

    なし
    

    レスポンス Body

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

    レスポンス Status

    HTTP StatusDesc
    200OK(照会完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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

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

    Headers

    API Headerに移動する

    リクエスト Body

    なし
    

    レスポンス Body

    なし
    

    レスポンス Status

    HTTP StatusDesc
    204No Content(削除完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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

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

    Parameters

    項目MandatoryType説明備考
    clientTelNoOptionalString受信拒否番号080サービス番号に登録された受信拒否番号
    pageSizeOptionalIntegerページサイズ- default: 100
    - 0~100までの数字のみ入力可能
    pageIndexOptionalIntegerページインデックスdefault: 0
    startTimeOptionalInteger照会開始時間- 受信拒否の登録時間基準
    - default: 全体
    endTimeOptionalInteger照会終了時間- 受信拒否の登録時間基準
    - default: 全体

    Headers

    API Headerに移動する

    リクエスト Body

    なし
    

    レスポンス Body

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

    レスポンス Status

    HTTP StatusDesc
    200OK
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    429Too Many Requests
    500Internal 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

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

    Parameters

    なし
    

    Headers

    API Headerに移動する

    リクエスト Body

    [
        {
            "clientTelNo":"string"
        }
    ]
    
    項目MandatoryType説明備考
    clientTelNoMandatoryString受信拒否番号1回のリクエストで1000件までリクエスト可能(List)

    レスポンス Body

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

    レスポンス Status

    HTTP StatusDesc
    200OK
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    429Too Many Requests
    500Internal 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

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

    Parameters

    なし
    

    Headers

    API Headerに移動する

    リクエスト Body

    [
        {
            "clientTelNo":"string"
        }
    ]
    
    項目MandatoryType説明備考
    clientTelNoMandatoryString受信拒否番号1回のリクエストで1000件までリクエスト可能(List)

    レスポンス Body

    なし
    

    レスポンス Status

    HTTP StatusDesc
    204No Content(削除完了)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    429Too Many Requests
    500Internal 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: 中継会社 G/Wがメッセージ受信後に出す結果コード
    • IB EMMA: EMMAがメッセージ送信リクエストに対して処理したエラーコード

    IB G/W Report Code

    コード分類意味
    0success成功
    2000failure送信時間オーバー
    2001failure送信失敗(無線網で)
    2002failure送信失敗(無線網 -> 端末で)
    2003failure端末電源オフ
    2004failure端末のメッセージバッファフル
    2005failure陰影地域
    2006failureメッセージが削除される
    2007failure一時的な端末問題
    3000Invalid送信できない
    3001Invalid加入者なし
    3002Invalid成人認証失敗
    3003Invalid受信番号形式エラー
    3004Invalidデバイスサービスの一時停止
    3005Invalidデバイスが呼処理のステータス
    3006Invalid着信拒否
    3007InvalidCallback URLを受け取れない携帯電話
    3008Invalidその他の端末問題
    3009Invalidメッセージ形式エラー
    3010InvalidMMSに対応しない端末
    3011Invalidサーバエラー
    3012Invalidスパム
    3013Invalidサービス拒否
    3014Invalidその他
    3015Invalid送信パスなし
    3016Invalid添付ファイルのサイズ制限に失敗
    3017Invalid発信番号の偽装防止細則に違反
    3018Invalid発信番号の偽装防止サービスに登録した携帯電話の個人登録者の番号
    3019InvalidKISAまたは未来創造科学部からすべての顧客会社に遮断処理をリクエストした発信番号
    3022InvalidCharset Conversion Error
    3023Invalid発信番号事前登録制により登録されていない番号

    IB G/W Response Code

    コード意味
    1001Server Busy(RS内部保存 Queue Full)
    1002受信番号形式エラー
    1003返信番号形式エラー
    1004SPAM
    1005使用件数オーバー
    1006添付ファイルなし
    1007添付ファイル有り
    1008添付ファイルの保存失敗
    1009CLIENT_MSG_KEYなし
    1010CONTENTなし
    1011CALLBACKなし
    1012RECIPIENT_INFOなし
    1013SUBJECTなし
    1014添付ファイル KEYなし
    1015添付ファイル NAMEなし
    1016添付ファイルサイズなし
    1017添付ファイル Contentなし
    1018送信権限なし
    1019TTLオーバー
    1020charset conversion error
    S000中継会社リクエスト失敗(サーバエラー)
    S001中継会社リクエスト失敗(サーバエラー)
    S002中継会社リクエスト失敗(不正なリクエスト)
    S003中継会社リクエスト失敗(スパム処理)
    S004クォータ超過
    S005不正な MMSファイル
    S006MMSファイルが見つからない
    S007MMSファイル有効期限切れ
    S008MMSファイルサイズ超過
    S009MMSファイル解像度超過
    S010MMSファイルアップロードのクォータ超過
    S011MMSファイルアップロード失敗
    S012発信番号細則エラー
    S998予期しないサーバーエラーです
    S999その他のエラー

    IB EMMA

    コード意味
    E900Invalid-IBの送信キーがない場合
    E901受信番号がない場合
    E902同報である場合)受信番号順番がない場合
    E903件名がない場合
    E904メッセージがない場合
    E905返信番号がない場合
    E906メッセージキーがない場合
    E907同報の有無がない場合
    E908サービスタイプがない場合
    E909送信リクエスト時刻がない場合
    E910TTLタイムがない場合
    E911サービスタイプが MMS MTである場合、添付ファイルの拡張子がない場合
    E912サービスタイプが MMS MTである場合、attach_fileフォルダに添付ファイルがない場合
    E913サービスタイプが MMS Mtである場合、添付ファイルのサイズが0である場合
    E914サービスタイプが MMS MTである場合、メッセージテーブルにファイルグループキーはあるがファイルテーブルにデータがない場合
    E915重複メッセージ
    E916認証サーバ遮断番号
    E917顧客 DB遮断番号
    E918USER CALLBACK FAIL
    E919送信制限時間である場合、メッセージ再送信処理が禁止された場合
    E920サービスタイプが LMS MTである場合、メッセージテーブルにファイルグループキーがある場合
    E921サービスタイプが MMS MTである場合、メッセージテーブルにファイルグループキーがない場合
    E922同報単語の制約文字使用エラー
    E999その他のエラー

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.