MENU
      Login
          Login
          目次 x
          通知トーク API
            • 印刷する
            • PDF
            目次

            通知トーク API

              • 印刷する
              • PDF
              記事の要約

              基本情報

              API URL

              https://sens.apigw.ntruss.com/alimtalk/v2
              HTTP

              SENS通知トークの 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クラウドプラットフォームの認証キーおよび Signature作成ガイドへ

              メッセージ

              メッセージの送信

              メッセージを送信します。

              リクエスト URL

              POST https://sens.apigw.ntruss.com/alimtalk/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}
              HTTP

              Path Variables

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

              Headers

              API Headerに移動する

              リクエストボディ

              {
    "plusFriendId":"string",
    "templateCode":"string",
    "messages":[
        {
            "countryCode":"string",
            "to":"string",
            "title":"string",
            "content":"string",
            "headerContent":"string",
            "itemHighlight":{
                "title":"string",
                "description":"string"
            },
            "item":{
                "list":[
                    {
                        "title":"string",
                        "description":"string"
                    }
                ],
                "summary":{
                    "title":"string",
                    "description":"string"
                }
            },
            "buttons":[
                {
                    "type":"string",
                    "name":"string",
                    "linkMobile":"string",
                    "linkPc":"string",
                    "schemeIos":"string",
                    "schemeAndroid":"string"
                }
            ],
            "useSmsFailover": "boolean",
            "failoverConfig": {
                "type": "string",
                "from": "string",
                "subject": "string",
                "content": "string"
            }
        }
    ],
    "reserveTime": "yyyy-MM-dd HH:mm",
    "reserveTimeZone": "string"
}
              JSON
              項目MandatoryType説明備考
              plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              templateCodeMandatoryStringテンプレートコード
              messagesMandatoryObjectメッセージ情報- 以下の項目を参照(messages.XXX)
              - 最大100個
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者番号
              messages.titleOptionalString通知トーク強調表示の内容強調表記タイプのテンプレートでのみ使用可能
              messages.contentMandatoryString通知トークメッセージの内容
              messages.headerContentOptionalString通知トークヘッダの内容- アイテムリストタイプのテンプレートでのみ使用可能
              - 16bytes未満まで入力可能
              messages.itemHighlightOptionalObjectアイテムハイライトアイテムリストタイプのテンプレートでのみ使用可能
              messages.itemHighlight.titleMandatoryStringアイテムハイライトの件名- アイテムリストタイプのテンプレートでのみ使用可能
              画像がない場合
              - 最大30文字まで入力可能(2行)
              - 1行は15文字まで入力可能
              画像がある場合
              - 最大21文字まで入力可能(2行)
              - 1行は10文字まで入力可能
              - 2行を超えると省略処理
              messages.itemHighlight.descriptionMandatoryStringアイテムハイライトの説明- アイテムリストタイプのテンプレートでのみ使用可能
              画像がない場合
              - 最大19文字まで入力可能(1行)
              画像がある場合
              - 最大13文字まで入力可能(1行)
              - 1行を超えると省略処理
              messages.itemOptionalObjectアイテムリストアイテムリストタイプのテンプレートでのみ使用可能
              messages.messages.item.listMandatoryArray of Objectアイテムリスト- アイテムリストタイプのテンプレートでのみ使用可能
              - 最低2個以上、最大10個
              messages.item.list.titleMandatoryStringアイテムリストの件名- アイテムリストタイプのテンプレートでのみ使用可能
              - 最大6文字まで入力可能
              messages.item.list.descriptionMandatoryStringアイテムリストの説明- アイテムリストタイプのテンプレートでのみ使用可能
              - 最大23文字まで入力可能
              messages.summaryOptionalObjectアイテムサマリー情報アイテムリストタイプのテンプレートでのみ使用可能
              messages.summary.titleMandatoryStringアイテムサマリーのタイトル- アイテムリストタイプのテンプレートでのみ使用可能
              - 最大6文字まで入力可能
              messages.summary.descriptionMandatoryStringアイテムサマリーの説明- アイテムリストタイプのテンプレートでのみ使用可能
              - 許可されている文字: 通貨記号(ユニコードの通貨記号、元、円、ウォン)、通貨コード(ISO 4217)、数字、コンマ、小数点、空白
              - 小数点第2位まで許可
              - 最大23文字まで入力可能
              messages.buttonsOptionalArray of Object通知トークのメッセージのボタン以下のテンプレートボタン情報を参照
              messages.buttons.typeMandatoryStringボタンType以下のテンプレートボタン情報を参照
              messages.buttons.nameMandatoryStringボタン名以下のテンプレートボタン情報を参照
              messages.useSmsFailoverOptionalBooleanSMS Failover使用の有無- Failoverが設定されたカカオトークチャンネルでのみ使用可能
              - デフォルト: カカオトークチャンネルの Failover設定の有無による
              messages.failoverConfigOptionalObjectFailover設定以下の項目を参照
              messages.failoverConfig.typeOptionalStringFailover SMSメッセージの Type- SMSまたは LMS
              - デフォルト: contentの長さに応じて自動適用 (90bytes以下は SMS、超過は LMS)
              messages.failoverConfig.fromOptionalStringFailover SMSの発信番号- デフォルト: Failoverを設定する時に選択した発信番号
              - 承認されていない発信番号を使用すると、Failoverは動作しない
              messages.failoverConfig.subjectOptionalStringFailover SMSの件名- LMS typeとして動作するときに使用
              - デフォルト: カカオトークチャンネル名
              messages.failoverConfig.contentOptionalStringFailover SMSの内容デフォルト: 通知トークメッセージの内容(ボタンを除く)
              reserveTimeOptionalString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
              reserveTimeZoneOptionalString予約日時のタイムゾーン- 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
              - サポートタイムゾーンリスト
              * TZ database nameの値を使用
              注意
              • リクエスト Bodyの Mandatoryフィールドを利用する場合、スペースは使用できません (追加する場合に限る)。
              • 内容(content)とボタン(buttons)は、登録および検収済みのテンプレート規格に合わせて入力してください。
              • テンプレート規格に合わないメッセージ送信をリクエストすると、メッセージの送信に失敗します。
              参考
              • テンプレートに画像が登録されている場合、別途メッセージの送信時に、リクエスト bodyにその内容を入れなくても登録されている画像が送信されます。
              • SMS Failoverは通知トーク受信結果コードに照らして成功でない場合に動作します。prefixとして Bがついたコードの場合は failover機能による SMS代替送信は行われません。

              テンプレートの登録と検収に関するガイドは、Webコンソール説明書(旧ユーザーガイド)で確認できます。テンプレート登録ガイドへ

              テンプレートボタン情報

              TypeNameMandatory項目
              DS配送照会
              WLウェブリンクlinkMobile、linkPc (http://または https://で始まる URL)
              ALアプリリンクschemeIos, schemeAndroid
              BKボットキーワード
              MDメッセージの伝達
              ACチャンネルの追加ボタン名はチャンネルの追加に固定

              サポート宅配会社のリスト

              宅配会社宅配会社名送り状番号
              郵便局宅配郵便局数字13桁または数字6桁+数字7桁
              (区切り文字「-」または「_」)
              Logen宅配Logen数字11桁または数字3桁+数字4桁+数字4桁
              (区切り文字「-」または「_」)
              ILYANG Logis- ILYANG Logis宅配
              - ILYANG宅配
              - ILYANG Logis              		数字9~11桁
              FedEX- フェデックス
              - FedEx
              - fedex              		数字12桁
              HANJIN TRANSPORTATIONHANJIN TRANSPORTATION数字10桁または数字12桁
              KYOUNGDONG EXPRESSKYOUNGDONG EXPRESS数字9~16桁または数字4桁+数字3桁+数字6桁
              (区切り文字「-」)
              HAPDONG EXPRESSHAPDONG EXPRESS数字9~16桁
              LOTTE GLOBAL LOGISTICS- LOTTE GLOBAL LOGISTICS
              - LOTTE LOGISTICS
              - HYUNDAI EXPRESS
              - Hyundai Logistics              		数字12桁または数字4桁+数字4桁+数字4桁
              (区切り文字「-」)
              Nonghyup LogisNonghyup Logis数字12桁
              HONAM LOGISTICSHONAM LOGISTICS数字10桁
              CHUNIL PARCELCHUNIL PARCEL数字11桁
              DAESIN PARCEL SERVICESDAESIN PARCEL SERVICES数字13桁
              KUNYONG EXPRESSKUNYONG EXPRESS数字10桁
              CUpost- CUpost
              - CUコンビニ宅配              		数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
              (区切り文字「-」または「_」)
              CVSnetコンビニ宅配- GSPostbox宅配
              - GSコンビニ宅配
              - CVSnetコンビニ宅配              		数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
              (区切り文字「-」または「_」)
              HandexHandex数字10桁または数字14桁
              TNT Express- TNTExpress
              - TNT宅配
              - TNT Express              		数字8~9桁
              USPSUSPS数字10桁または数字22桁または英字の大文字2桁+数字9桁+英字の大文字2桁
              (区切り文字なし)
              EMSEMS英字の大文字2桁+数字9桁+英字の大文字2桁
              (区切り文字なし)
              DHLDHL数字10桁
              GOODSTOLUCKGOODSTOLUCK数字4桁+数字4桁+数字4桁
              (区切り文字「-」)
              • サポートしない宅配会社の場合、ボタンは自動で追加されません。
                • Webリンク(WL)ボタンで配送照会ページに接続すれば使用できます。

              レスポンスボディ

              {
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messages":[
        {
            "messageId":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "requestStatusCode":"string",
            "requestStatusName":"string",
            "requestStatusDesc":"string",
            "useSmsFailover":"boolean"
        }
    ]
}
              JSON
              項目MandatoryType説明備考
              requestIdMandatoryString送信リクエスト ID
              requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              statusCodeMandatoryStringリクエスト状態コード- 成功: 202
              - 失敗: その他
              - HTTP Status規格に従う
              statusNameMandatoryStringリクエスト状態名- 成功: success
              - 処理中: processing
              - 予約中: reserved
              - 失敗: fail
              messages.messageIdMandatoryStringメッセージ ID
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者の番号
              messages.contentMandatoryString通知トークメッセージの内容
              messages.requestStatusCodeMandatoryString送信リクエスト状態コード- 成功: A000
              - 失敗: その他のコード(Desc項目に失敗理由が明示される)
              messages.requestStatusNameMandatoryString送信リクエスト状態名- 成功: success
              - 失敗: fail
              messages.requestStatusDescMandatoryString送信リクエスト状態の内容
              messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無

              レスポンスステータス

              HTTP StatusDesc
              202Accepted(送信リクエスト完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

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

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

              リクエスト URL

              GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/messages?requestId=

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

              Path Variables

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

              Parameters

              項目MandatoryType説明備考
              requestIdMandatoryStringリクエスト ID送信リクエスト ID
              plusFriendIdMandatoryStringカカオチャンネル登録されたチャンネル名
              requestStartTimeMandatoryString照会時間の開始時刻yyyy-MM-dd'T'HH:mm:ss
              requestEndTimeMandatoryString照会時間の終了時刻yyyy-MM-dd'T'HH:mm:ss
              completeStartTimeMandatoryString送信完了の開始時間yyyy-MM-dd'T'HH:mm:ss
              completeEndTimeMandatoryString送信完了の終了時間yyyy-MM-dd'T'HH:mm:ss
              messageIdOptionalStringメッセージ ID
              requestStatusNameOptionalStringリクエスト状態success, fail
              messageStatusNameOptionalStringリクエスト状態success, processing, fail
              templateCodeOptionalStringテンプレートコード登録されたテンプレートコード
              toOptionalStringメッセージ受信番号ハイフン「-」を除く番号
              pageIndexOptionalIntegerページ番号デフォルト: 0
              pageSizeOptionalIntegerページサイズデフォルト: 20, 最大: 100
              requestIdを含めて照会する場合、デフォルト: 100
              参考
              • メッセージの送信履歴は直近30日以内の履歴のみ照会できます。
              • requestId、requestStartTime + requestEndTime、completeStartTime + completeEndTimeのうち少なくとも1つは必須です。
              • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時には使用できません。
              • requestStartTime ~ requestEndTimeの照会範囲は最大31日に制限されます。
              • completeStartTime ~ completeEndTimeの照会範囲は最大24時間に制限されます。
              • 照会条件に requestIdが含まれていない場合、plusFriendIdは必須です。

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
    "requestId": "string",
    "statusCode": "string",
    "statusName": "string",
    "messages": [
        {
            "requestTime": "string",
            "messageId": "string",
            "countryCode": "string",
            "to": "string",
            "content": "string",
            "plusFriendId": "string",
            "templateCode": "string",
            "completeTime": "string",
            "requestStatusCode": "string",
            "requestStatusName": "string",
            "requestStatusDesc": "string",
            "messageStatusCode": "string",
            "messageStatusName": "string",
            "messageStatusDesc": "string",
            "useSmsFailover": "boolean",
            "failover": {
                "smsServiceId": "string",
                "requestId": "string",
                "messageId": "string",
                "requestStatusCode": "string",
                "requestStatusName": "string",
                "requestStatusDesc": "string",
                "messageStatus": "string",
                "messageStatusCode": "string",
                "messageStatusName": "string",
                "messageStatusDesc": "string"
            }
        }
    ],
    "pageSize": "integer",
    "pageIndex": "integer",
    "itemCount": "integer",
    "hasMore": "boolean"
}
              JSON
              項目MandatoryType説明備考
              requestIdOptionalString送信リクエスト IDrequestIdで照会する場合にのみ表示
              statusCodeMandatoryStringリクエスト状態コード202 - 成功
              その他 - 失敗
              * HTTP Status規格に従う
              statusNameMandatoryStringリクエスト状態名success - 成功
              processing - 送信中
              reserved - 予約中
              fail - 失敗
              messages.requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              messages.messageIdMandatoryStringメッセージ ID
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者番号
              messages.contentMandatoryString通知トークメッセージの内容
              messages.plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              messages.templateCodeMandatoryStringテンプレートコード
              messages.completeTimeOptionalDateTime送信レポート(処理完了)時間yyyy-MM-dd'T'HH:mm:ss
              messages.requestStatusCodeMandatoryString送信リクエスト状態コードA000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messages.requestStatusNameMandatoryString送信リクエスト状態名success - 成功
              fail - 失敗
              messages.requestStatusDescMandatoryString送信リクエスト状態の内容
              messages.messageStatusCodeMandatoryString送信結果状態コード0000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messages.messageStatusNameMandatoryString送信結果状態名success - 成功
              processing - 処理中
                  * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
                  * messageCode、messageDescが照会されていない
              fail - 失敗
              messages.messageStatusDescMandatoryString送信結果状態の内容
              messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無
              messages.failoverOptionalObjectSMS Failover
              messages.failover.smsServiceIdOptionalStringSMS Failoverのサービス ID
              messages.failover.requestIdOptionalStringSMS Failoverの送信リクエスト ID
              messages.failover.messageIdOptionalStringSMS Failoverの送信メッセージ ID
              messages.failover.requestStatusCodeOptionalStringSMS Failoverの送信リクエスト状態コードエラーコード表を参考
              messages.failover.requestStatusNameOptionalStringSMS Failoverの送信リクエスト状態名success - 成功
              fail - 失敗
              messages.failover.requestStatusDescOptionalStringSMS Failoverの送信リクエスト状態の内容
              messages.failover.messageStatusOptionalStringSMS Failoverの送信処理状態READY: 待機
              PROCESSING: 処理中
              COMPLETED: 処理完了
              messages.failover.messageStatusCodeOptionalStringSMS Failover送信端末の受信状態結果コードエラーコード表を参考
              messages.failover.messageStatusNameOptionalStringSMS Failover送信端末の受信結果名
              messages.failover.messageStatusDescOptionalStringSMS Failover送信端末の受信内容
              pageSizeMandatoryIntegerページサイズ
              pageIndexMandatoryIntegerページのインデックス(0からスタート)
              itemCountMandatoryInteger照会結果ページ内のメッセージ数
              hasMoreMandatoryBoolean次のページの存在有無
              参考
              • 照会条件に requestIdが含まれていない場合、requestIdは含まれません。

              レスポンスステータス

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

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

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

              リクエスト URL

              GET https://sens.apigw.ntruss.com/alimtalk/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}
              HTTP

              Path Variables

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

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
    "messageId":"string",
    "requestId":"string",
    "requestTime":"string",
    "completeTime":"string",
    "plusFriendId":"string",
    "templateCode":"string",
    "countryCode":"string",
    "to":"string",
    "content":"string",
    "requestStatusCode":"string",
    "requestStatusName":"string",
    "requestStatusDesc":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "messageStatusDesc":"string",
    "useSmsFailover":"boolean",
    "failover": {
        "smsServiceId":"string",
        "requestId":"string",
        "requestStatusCode":"string",
        "requestStatusName":"string",
        "requestStatusDesc":"string",
        "messageId":"string",
        "messageStatus":"string",
        "messageStatusCode":"string",
        "messageStatusName":"string",
        "messageStatusDesc":"string"
    }
}
              JSON
              項目MandatoryType説明備考
              messageIdMandatoryStringメッセージ ID
              requestIdMandatoryString送信リクエスト ID
              requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              completeTimeOptionalDateTime送信レポート(処理完了)時間yyyy-MM-dd'T'HH:mm:ss
              plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              templateCodeMandatoryStringテンプレートコード
              countryCodeOptionalString受信者の国番号デフォルト: 82
              toMandatoryString受信者番号
              contentMandatoryString通知トークメッセージの内容
              requestStatusCodeMandatoryString送信リクエスト状態コードA000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              requestStatusNameMandatoryString送信リクエスト状態名success - 成功
              fail - 失敗
              requestStatusDescMandatoryString送信リクエスト状態の内容
              messageStatusCodeMandatoryString送信結果状態コード0000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messageStatusNameMandatoryString送信結果状態名success - 成功
              processing - 処理中
                  * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
                  * messageCode、messageDescが照会されていない
              fail - 失敗
              messageStatusDescMandatoryString送信結果状態の内容
              messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無
              messages.failoverOptionalObjectSMS Failover使用の有無
              messages.failover.smsServiceIdOptionalStringSMS Failoverのサービス ID
              messages.failover.requestIdOptionalStringSMS Failoverの送信リクエスト ID
              messages.failover.requestStatusCodeOptionalStringSMS Failoverの送信リクエスト状態コードエラーコード表を参考
              messages.failover.requestStatusNameOptionalStringSMS Failoverの送信リクエスト状態名success - 成功
              fail - 失敗
              messages.failover.requestStatusDescOptionalStringSMS Failoverの送信リクエスト状態の内容
              messages.failover.messageIdOptionalStringSMS Failoverの送信メッセージ ID
              messages.failover.messageStatusOptionalStringSMS Failoverの送信処理状態READY: 待機
              PROCESSING: 処理中
              COMPLETED: 処理完了
              messages.failover.messageStatusCodeOptionalStringSMS Failover送信端末の受信状態結果コードエラーコード表を参考
              messages.failover.messageStatusNameOptionalStringSMS Failover送信端末の受信結果名
              messages.failover.messageStatusDescOptionalStringSMS Failover送信端末の受信内容

              Failoverのリクエスト状態コード

              requestStatusCodeDesc
              0成功
              E4000failover設定が有効ではない
              E4001failover設定の情報が抜けている
              E4002failover SMSサービスが設定されていない
              E4003failover SMS type(SMS、LMS)が設定されていない
              E4004failover SMSの発信番号が設定されていない
              E4005failover SMSの件名が設定されていない
              E4006failover SMSの内容が設定されていない
              E4007failover SMSの受信番号が設定されていない
              E4008failover SMSサービスが使用可能な状態ではない
              E4009failover SMSの発信番号が認証されていない
              E4010failover SMS 080無料受信拒否サービスが使用可能な状態ではない
              E4999failover設定のパースエラー(サポートセンターに要相談)
              E5000内部エラー(サポートセンターに要相談)

              レスポンスステータス

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

              予約メッセージ

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

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

              GET https://sens.apigw.ntruss.com/alimtalk/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}
              HTTP

              Path Variables

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

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

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

              レスポンスステータス

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

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

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

              DELETE https://sens.apigw.ntruss.com/alimtalk/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}
              HTTP

              Path Variables

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

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              なし
              JSON

              レスポンスステータス

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

              カカオトークチャンネル

              チャンネルの照会

              カカオトークチャンネルを照会します。

              GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/channels

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

              Path Variables

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

              Parameters

              項目MandatoryType説明備考
              pageSizeOptionalIntegerページサイズデフォルト: 100 (1~100までの数字のみ入力可能)
              pageIndexOptionalIntegerページインデックスデフォルト: 0

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              [
    {
        "createTime": "string",
        "updateTime": "string",
        "serviceId": "string",
        "channelId": "string",
        "channelName": "string",
        "channelStatus": "string",
        "useSmsFailover": "boolean",
        "failoverServiceId": "string",
        "failoverTelNo": "string",
        "isBlock": "boolean",
        "isDormant": "boolean"
    }
]
              JSON
              項目MandatoryType説明備考
              createTimeMandatoryString作成時間format: LocalDateTime
              updateTimeOptionalString更新時間format: LocalDateTime
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              channelIdMandatoryStringカカオトークチャンネル ID
              channelNameMandatoryStringカカオトークチャンネル名
              channelStatusMandatoryStringカカオトークチャンネルの状態- 正常: ACTIVE
              - 削除: DELETED
              - 完全削除中: DELETING_PERMANENTLY
              - 完全削除: PERMANENTLY_DELETED
              - ブロック: BLOCKED
              - 削除遅延中: PENDING_DELETE
              useSmsFailoverMandatoryBooleanSMS代替送信を使用するか否か
              failoverServiceIdOptionalStringFailover SMSサービス ID
              failoverTelNoOptionalStringFailover発信番号
              isBlockMandatoryBooleanチャンネルをブロックするかどうか
              isDormantMandatoryBooleanチャンネルを休眠に切り替えるかどうか

              レスポンスステータス

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

              通知トークのテンプレート

              テンプレートの照会

              カカオトークチャンネルに登録された通知トークのテンプレートを照会します。

              GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/templates?channelId=

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

              Path Variables

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

              Parameters

              • channelIdは必須値であり、templateCode使用時にテンプレートの詳細情報を返します。
              • commentsをはじめとする付加情報は、詳細照会時にのみ表示されます。
              項目MandatoryType説明備考
              channelIdMandatoryStringチャンネル IDカカオトークに登録されたチャンネル ID
              templateCodeMandatoryStringテンプレートコードtemplateCodeを用いて照会する時、詳細な照会結果を返す
              登録されたテンプレートコード
              templateNameOptionalStringテンプレート名like照会結果を返す
              pageSizeOptionalIntegerページサイズデフォルト: 100 (1~100までの数字のみ入力可能)
              pageIndexOptionalIntegerページインデックスデフォルト: 0

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              [
    {
        "createTime": "string",
        "updateTime": "string",
        "channelId": "string",
        "templateCode": "string",
        "templateName": "string",
        "categoryCode": "string",
        "categoryName": "string",
        "messageType" : "string",
        "emphasizeType" : "string",
        "content": "string",
        "adContent": "string",
        "extraContent": "string",
        "title": "string",
        "additionalTitle": "string",
        "comments": [
            {
                "commentId": "string",
                "content": "string",
                "status": "string",
                "createTime": "string",
                "attachment": [
                    {
                        "fileName": "string",
                        "fileUrl": "string"
                    }
                ]
            }
        ],
        "templateInspectionStatus": "string",
        "templateStatus": "string",
        "buttons":[
                {
                    "order":"integer",
                    "type":"string",
                    "name":"string",
                    "linkMobile":"string",
                    "linkPc":"string",
                    "schemeIos":"string",
                    "schemeAndroid":"string"
                }
            ],
        "imageName": "string",
        "imageUrl": "string",
        "headerContent": "string",
        "itemHighlight": {
            "title": "string",
            "description": "string",
            "imageUrl": "string"
        },
        "item": {
            "list": [
                {
                    "title": "string",
                    "description": "string"
                }
            ],
            "summary": {
                "title": "string",
                "description": "string"
            }
        },
        "securityFlag": "boolean",
        "isBlock": "boolean",
        "isDormant": "boolean"
    }
]
              JSON
              項目MandatoryType説明備考
              createTimeMandatoryString作成時間format: LocalDateTime
              updateTimeOptionalString更新時間format: LocalDateTime
              channelIdMandatoryStringカカオトークチャンネル ID
              templateCodeMandatoryStringテンプレートコード
              templateNameMandatoryStringテンプレート名
              categoryCodeMandatoryStringテンプレートカテゴリコード
              categoryNameMandatoryStringテンプレートカテゴリ名
              messageTypeMandatoryStringテンプレートメッセージタイプ- BA: 基本型
              - EX: 付加情報型
              - AD: 広告追加型
              - MI: 複合型
              emphasizeTypeMandatoryStringテンプレート強調のタイプ- NONE: 基本型
              - TEXT: 強調表記型
              - IMAGE: 画像型
              - ITEM_LIST: アイテムリスト型
              contentMandatoryStringテンプレートの内容
              adContentOptionalString広告メッセージ
              extraContentOptionalString付加情報
              titleOptionalString強調表記型のタイトル
              additionalTitleOptionalString強調表記型の追加タイトル
              comments.commentIdMandatoryString検収 ID
              comments.contentMandatoryString検収の内容
              comments.statusMandatoryString検収の状態- 検収完了: APR
              - 検収の不受理: REJ
              comments.createMandatoryString検収時間
              comments.attachmentOptionalObject検収問い合わせの添付ファイル
              comments.attachment.fileNameMandatoryStringファイル名
              comments.attachment.fileUrlMandatoryStringファイル URL
              templateInspectionStatusMandatoryStringテンプレートの検収状態- 受諾: ACCEPT
              - 登録: REGISTER
              - 検収中: INSPECT
              - 完了: COMPLETE
              - 不受理: REJECT
              templateStatusMandatoryStringテンプレートの状態- 正常: ACTIVE
              - 待機: READY
              - 停止: STOP
              buttonsOptionalArray of Object通知トークのメッセージのボタン上位のテンプレートボタン情報を参照
              buttons.orderMandatoryIntegerボタンの順番ボタンの登録順番
              buttons.typeMandatoryStringボタンType上位のテンプレートボタン情報を参照
              buttons.nameMandatoryStringボタン名上位のテンプレートボタン情報を参照
              buttons.linkMobileOptionalStringボタンmobile link登録されている template button情報を参照
              buttons.linkPcOptionalStringボタンpc link登録されている template button情報を参照
              buttons.schemeIosOptionalStringボタンios scheme登録されている template button情報を参照
              buttons.schemeAndroidOptionalStringボタンadnroid scheme登録されている template button情報を参照
              titleOptionalString強調表示型のタイトル
              additionalTitleOptionalString強調表示型の追加タイトル
              useImageMandatoryBoolean画像の使用有無
              imageNameOptionalString画像名
              imageUrlOptionalString画像URL
              useHeaderContentMandatoryBooleanヘッダの使用有無
              headerContentOptionalStringヘッダの内容
              useItemHighlightMandatoryBooleanアイテムハイライトの使用有無
              useItemHighlightImageMandatoryBooleanアイテムハイライト画像の使用有無
              itemHighlightOptionalObjectアイテムハイライトアイテムハイライト使用時にのみ表示
              itemHighlight.titleOptionalStringアイテムハイライトの件名
              itemHighlight.descriptionOptionalStringアイテムハイライトの内容
              itemHighlight.imageUrlOptionalStringアイテムハイライトの画像 URL
              itemOptionalObjectアイテムアイテム使用時にのみ表示
              item.listOptionalStringアイテムリストアイテムリスト使用時にのみ表示
              item.list.titleOptionalStringアイテム名
              item.list.descriptionOptionalStringアイテム内容
              item.summaryOptionalStringアイテムサマリー情報アイテムサマリー情報使用時にのみ表示
              item.summary.titleOptionalStringアイテムサマリー情報名
              item.summary.descriptionOptionalStringアイテムサマリー情報の内容
              securityFlagMandatoryBooleanセキュリティ設定の有無
              isBlockMandatoryBooleanテンプレートをブロックするかどうか
              isDormantMandatoryBooleanテンプレートを休眠に切り替えるかどうか
              参考
              • channelIdは必須値であり、templateCode使用時にテンプレートの詳細情報を返します。
              • commentsをはじめとする付加情報は、詳細照会時にのみ表示されます。

              レスポンスステータス

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

              エラーコード

              通知トークの受信結果コード

              StatusError textDesc
              0000-正常に送信
              1001NoJsonBodyRequest Bodyが JSON形式ではない
              1002InvalidHubPartnerKeyパートナーキーが有効ではない
              1003InvalidSenderKey送信プロファイルキーが有効ではない
              1004NoValueJsonElementRequest BODY(JSON)で nameが見つからない
              1005SenderNotFound送信プロファイルが見つからない
              1006DeletedSender削除された送信プロファイル
              1007StoppedSenderブロック状態の送信プロファイル
              1011ContractNotFound契約情報が見つからない
              1012InvalidUserKeyException正しくない形式のユーザーキーリクエスト
              1013InvalidAppLink有効ではないアプリリンク
              1014InvalidBizNum有効ではない事業者番号
              1015TalkUserIdNotFonud有効でないアプリユーザー IDリクエスト
              1016BizNumNotEqual事業者登録番号の不一致
              1020InvalidReceiveUserException有効なユーザー識別子の値がまったくない場合
              1021BlockedProfileブロック状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1022DeactivatedProfile非活性状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1023DeletedProfile削除されたカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1024DeletingProfile削除待ち状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1025SpammedProfileメッセージブロック状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1026UnableUseMessageTypeその msg_typeで使用できない response_methodでリクエスト(画像通知トーク(AI)はリアルタイムで送信不可)
              1027-チャンネルメッセージ制裁状態によるメッセージ送信失敗
              1030InvalidParameterException正しくないパラメータリクエスト
              1033-テンプレートタイプとメッセージタイプが一致しない
              2000FailedToCheckFriendshipExceptionトークチャンネルとの友達関係確認時のエラー(システムエラー)
              2003FailedToSendMessageByNoFriendshipExceptionメッセージの送信失敗 (テストサーバでカカオトークチャンネルを追加していない場合)
              2004FailedToMatchTemplateExceptionテンプレートと一致してるかどうかを確認中にエラー発生 (カカオトークの内部エラー)
              2005FailedToReadImageExceptionカカオから画像のメタ情報を読み込み中にエラー
              2006FailedToMatchSerialNumberPrefixPatternシリアル番号形式の不一致
              3000UnexceptedExcetpion予期せぬエラーの発生
              3005AckTimeoutExceptionメッセージを送信したが、受信が確認できてない(成否が不明)
              3006FailedToSendMessageExceptionカカオトーク内部システムエラーによるメッセージ送信失敗
              3008InvalidPhoneNumberException電話番号エラー
              3010JsonParsseExcetpionJSONパースエラー
              3011MessageNotFoundExceptionメッセージが存在しない
              3012SerialNumberDuplicatedExceptionメッセージのシリアル番号が重複している(メッセージのシリアル番号は固有の値でなければならない)
              3013MessageEmptyException空のメッセージ
              3014MessageLengthOverLimitExceptionメッセージの長さ制限エラー(テキストタイプ1000文字をオーバー、画像タイプ400文字をオーバー)
              3015TemplateNotFoundExceptionテンプレートが見つからない
              3016NoMatchedTemplateExceptionメッセージ内容がテンプレートと一致しない
              3018NoSendAvailableExceptionメッセージを送信できない
              3019MessageNoUserExceptionトークのユーザーではない
              3020MessageUserBlockedAlimTalkException通知トークブロック
              3021MessageNotSupportedKakaotalkExceptionトークの最低バージョンをサポートしない
              3022NoSendAvailableTimeExceptionメッセージが送信可能な時間ではない(友達トーク/マーケティングメッセージは08時~20時まで送信可能)
              3023MessageInvalidVideoExceptionメッセージに含まれるビデオを送信できない(ビデオのアドレスまたはサムネイル画像アドレスが正しくないか、サムネイル画像が規格に合わない)
              3024MessageInvaildImageExceptionメッセージに含まれた画像を送信できない
              3025ExceedMaxVariableLengthException変数の文字数制限を超過
              3026Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})'相談/ボット切り替えボタン extra、event文字数の制限を超過
              3027NoMatchedTemplateButtonExceptionボタンの内容がテンプレートと一致しない
              3028NoMatchedTemplateTitleExceptionメッセージの強調表記件名がテンプレートと一致しない
              3029ExceedMaxTitleLengthExceptionメッセージの強調表記件名の長さが制限を超過(50文字)
              3031-テキストタイプの不一致
              3030NoMatchedTemplateWithMessageTypeExceptionメッセージタイプやテンプレートの強調タイプが一致しない
              3031NoMatchedTemplateHeaderExceptionヘッダがテンプレートと一致しない
              3032ExceedMaxHeaderLengthExceptionヘッダの長さ制限を超過(16文字)
              3033NoMatchedTemplateItemHighlightExceptionアイテムハイライトがテンプレートと一致しない
              3034ExceedMaxItemHighlightTitleLengthExceptionアイテムハイライトの件名の長さが制限を超過(画像がない場合は30文字、画像がある場合は21文字)
              3035ExceedMaxItemHighlightDescriptionLengthExceptionアイテムハイライトの説明の長さが制限を超過(画像がない場合は19文字、画像がある場合は14文字)
              3036NoMatchedTemplateItemListExceptionアイテムリストがテンプレートと一致しない
              3037ExceedMaxItemDescriptionLengthExceptionアイテムリストのアイテムの説明の長さが制限を超過(23文字)
              3038NoMatchedTemplateItemSummaryExceptionアイテムのサマリー情報がテンプレートと一致しない
              3039ExceedMaxItemSummaryDescriptionLengthExceptionアイテムサマリー情報の説明の長さが制限を超過(14文字)
              3040InvalidItemSummaryDescriptionExceptionアイテムのサマリー情報の説明が有効でない文字を含む(通貨記号/コード、数字、コンマ、小数点、スペースを除いた文字を含む)
              3041MessageInvalidWideItemListLengthExceptionワイドアイテムリスト数の最小値と最大値が一致しない
              3042NoMatchedTemplateRepresentLinkException代表リンクがテンプレートと一致しない
              3046ExceedMaxAdditionalContentLengthException付加情報の最大長さ制限エラー
              3047ExceedMaxCommerceTitleLengthExceptionコマース情報、商品名の最大長さ制限エラー
              3050MessageNotSupportedUnsubscribeException受信同意拒否スペック(Nタイプ)をサポートしない
              3051InvalidateCarouselItemMinException or InvalidateCarouselItemMaxExceptionカルーセルアイテムリスト数の最小値と最大値が一致しない
              3052CarouselMessageLengthOverLimitExceptionカルーセルアイテムメッセージが長さ制限を超過
              3056WideItemListTitleLengthOverLimitExceptionワイドアイテムリストタイトルの長さ制限エラー
              3058CarouselHeaderLengthOverLimitExceptionカルーセルヘッダの長さ制限エラー
              3059MessageNotSupportedCouponExceptionクーポンのスペックをサポートしない
              4000ResponseHistoryNotFoundExceptionメッセージ送信結果が見つからない
              4001UnKnownMessageStatusError不明なメッセージ状態
              7011-シリアル番号パターンのエラー
              7014-メッセージ有効時間のオーバーエラー
              8512-受信者タイプが見つからない
              8514-request_idが見つからない
              8520-サポートしない商品タイプエラー
              8521-サポートしないメッセージタイプエラー
              8522-サポートしないテキストタイプエラー
              8523-サポートしない response methodエラー
              8530-受信者リストサイズエラー
              8999-内部サーバエラー
              9998現在サービスを提供していません。システムにトラブルが発生し、担当者が確認中
              9999システムに原因不明のトラブルが発生し、担当者が確認中システムにトラブルが発生し、担当者が確認中
              B000Prepare to relay failed中継会社への送信のための事前作業に失敗
              B001Request to relay failed中継会社への送信失敗
              B002Filtering for request to relay failed無効なリクエストによりフィルタリングされる
              B003Invalid phone number format無効な発信番号形式
              B004Quota Exceedクォーター超過
              B005Message processing timeout exceedメッセージのリクエスト時間と処理時間の差が許容範囲外である
              B400Invalid Requestメッセージ形式エラー
              B999Unexpected server error予期せぬエラー
              この記事は役に立ちましたか?
              What's Next
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              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.
              Logout