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

        通知トークの API

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

          基本情報

          API URL

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

          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}

          Path Variables

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

          Headers

          API Headerに移動する

          リクエスト Body

          {
    "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"
}
          項目MandatoryType説明備考
          plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
          templateCodeMandatoryStringテンプレートコード
          messagesMandatoryObjectメッセージ情報- 以下の項目を参照(messages.XXX)
          - 最大100個
          messages.countryCodeOptionalString受信者の国番号default: 82
          messages.toMandatoryString受信者番号
          messages.titleOptionalString通知トーク強調表示の内容強調表記タイプのテンプレートでのみ使用可能
          messages.contentMandatoryString通知トークメッセージの内容
          messages.headerContentOptionalString通知トークヘッダの内容- アイテムリストタイプのテンプレートでのみ使用可能
          - 16 bytes 未満まで入力可能
          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.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の長さに応じて自動適用(90byte以下は 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
          - fedex          		数字12桁
          韓進宅配韓進宅配数字10桁または数字12桁
          京東宅配京東宅配数字9~16桁または数字4桁+数字3桁+数字6桁
          (区切り文字「-」)
          合同宅配合同宅配数字9~16桁
          ロッテ宅配- ロッテ宅配
          - ロッテロジスティクス
          - 現代宅配
          - 現代ロジスティクス          		数字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桁
          CUコンビニ宅配- CUコンビニ宅配
          - CUコンビニ宅配          		数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
          (区切り文字「-」または「_」)
          CVSnetコンビニ宅配- GSPostbox宅配
          - GSコンビニ宅配
          - CVSnetコンビニ宅配          		数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
          (区切り文字「-」または「_」)
          ハンデックスハンデックス数字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桁
          (区切り文字「-」)
          • サポートしない宅配会社の場合、ボタンは自動で追加されません。
            • ウェブリンク(WL)ボタンで配送照会ページに接続することで使用できます。

          レスポンス Body

          {
    "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"
        }
    ]
}
          項目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受信者の国番号default: 82
          messages.toMandatoryString受信者の番号
          messages.contentMandatoryString通知トークメッセージの内容
          messages.requestStatusCodeMandatoryString送信リクエスト状態コード- 成功: A000
          - 失敗: その他のコード(Desc項目に失敗理由が明示される)
          messages.requestStatusNameMandatoryString送信リクエスト状態名- 成功: success
          - 失敗: fail
          messages.requestStatusDescMandatoryString送信リクエスト状態の内容
          messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無

          レスポンス Status

          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}

          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ページ番号default: 0
          pageSizeOptionalIntegerページサイズdefault: 20, max: 100
          requestIdを含んだ照会時、default: 100
          参考
          • メッセージ送信履歴は、 直近30日 以内の履歴のみ照会できます。
          • requestIdまたは requestStartTime + requestEndTimeまたは completeStartTime + completeEndTimeのうちいずれかが必須です。
          • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時に使用できません。
          • requestStartTime ~ requestEndTimeの照会範囲は、最大31日に制限されます。
          • completeStartTime ~ completeEndTimeの照会範囲は、最大24時間に制限されます。
          • 照会条件に requestIdが含まれていない場合、plusFriendIdは必須です。

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          {
    "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"
}
          項目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受信者の国番号default: 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は含まれません。

          レスポンス Status

          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}

          Path Variables

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

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          {
    "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"
    }
}
          項目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受信者の国番号default: 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内部エラー(サポートセンターに要相談)

          レスポンス Status

          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}

          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/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}

          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

          カカオトークチャンネル

          チャンネル照会

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

          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}

          Path Variables

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

          Parameters

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

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          [
    {
        "createTime": "string",
        "updateTime": "string",
        "serviceId": "string",
        "channelId": "string",
        "channelName": "string",
        "channelStatus": "string",
        "useSmsFailover": "boolean",
        "failoverServiceId": "string",
        "failoverTelNo": "string",
        "isBlock": "boolean",
        "isDormant": "boolean"
    }
]
          項目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チャンネル休眠の切り替え有無

          レスポンス Status

          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}

          Path Variables

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

          Parameters

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

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          [
    {
        "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"
    }
]
          項目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ボタン android 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をはじめとする付加情報は、詳細照会時にのみ表示されます。

          レスポンス Status

          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無効な appリンク
          1014InvalidBizNum有効ではない事業者番号
          1015TalkUserIdNotFonud無効な app user idリクエスト
          1016BizNumNotEqual事業者登録番号の不一致
          1020InvalidReceiveUserException有効なユーザー識別子の値がまったくない場合
          1021BlockedProfile遮断状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
          1022DeactivatedProfile閉鎖状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
          1023DeletedProfile削除されたカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
          1024DeletingProfile削除待機状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
          1025SpammedProfileメッセージブロック状態のカカオトークチャンネル(カカオトークチャンネル運用営ツールで確認)
          1026UnableUseMessageType当該 msg_typeで使用できない response_methodでリクエスト(イメージ通知トーク(AI)はリアルタイムで送信不可)
          1030InvalidParameterException不正なパラメータリクエスト
          1033-テンプレートタイプとメッセージタイプが不一致
          2003FailedToSendMessageByNoFriendshipExceptionメッセージの送信失敗(テストサーバでカカオトークチャンネルを追加していない場合)
          2004FailedToMatchTemplateExceptionテンプレートとの一致有無を確認中にエラー発生(カカオトークの内部エラー)
          2006FailedToMatchSerialNumberPrefixPatternシリアル番号形式の不一致
          3000UnexceptedExcetpion予期せぬエラーの発生
          3005AckTimeoutExceptionメッセージを送信したが、受信が確認できない(成否不明)
          3006FailedToSendMessageExceptionカカオトーク内部システムエラーによるメッセージ送信失敗
          3008InvalidPhoneNumberException電話番号エラー
          3010JsonParsseExcetpionJsonパースエラー
          3011MessageNotFoundExceptionメッセージが存在しない
          3012SerialNumberDuplicatedExceptionメッセージのシリアル番号が重複している(メッセージのシリアル番号は固有の値でなければならない)
          3013MessageEmptyException空のメッセージ
          3014MessageLengthOverLimitExceptionメッセージの長さ制限エラー(テキストタイプ1000文字をオーバー、イメージタイプ400文字をオーバー)
          3015TemplateNotFoundExceptionテンプレートが見つからない
          3016NoMatchedTemplateExceptionメッセージ内容がテンプレートと一致しない
          3018NoSendAvailableExceptionメッセージを送信できない
          3020SeenInfoNotFoundExceptionメッセージ確認情報が見つからない
          3022NoSendAvailableTimeExceptionメッセージが送信可能な時間ではない(友達トーク/マーケティングメッセージは08時~20時まで送信可能)
          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アイテム要約情報の説明に有効でない文字を含む(通貨記号/コード、数字、コンマ、小数点、スペースを除いた文字を含む)
          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