通知トーク API

Prev Next

基本情報

API URL

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

SENS通知トークの API Swaggerへ

API Header

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

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

メッセージ

メッセージの送信

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

リクエスト 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

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

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

テンプレートボタン情報

Type Name Mandatory項目
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 TRANSPORTATION HANJIN TRANSPORTATION 数字10桁または数字12桁
KYOUNGDONG EXPRESS KYOUNGDONG EXPRESS 数字9~16桁または数字4桁+数字3桁+数字6桁
(区切り文字「-」)
HAPDONG EXPRESS HAPDONG EXPRESS 数字9~16桁
LOTTE GLOBAL LOGISTICS - LOTTE GLOBAL LOGISTICS
- LOTTE LOGISTICS
- HYUNDAI EXPRESS
- Hyundai Logistics		 数字12桁または数字4桁+数字4桁+数字4桁
(区切り文字「-」)
Nonghyup Logis Nonghyup Logis 数字12桁
HONAM LOGISTICS HONAM LOGISTICS 数字10桁
CHUNIL PARCEL CHUNIL PARCEL 数字11桁
DAESIN PARCEL SERVICES DAESIN PARCEL SERVICES 数字13桁
KUNYONG EXPRESS KUNYONG EXPRESS 数字10桁
CUpost - CUpost
- CUコンビニ宅配		 数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
(区切り文字「-」または「_」)
CVSnetコンビニ宅配 - GSPostbox宅配
- GSコンビニ宅配
- CVSnetコンビニ宅配		 数字10桁または数字12桁または数字4桁+数字4桁+数字4桁
(区切り文字「-」または「_」)
Handex Handex 数字10桁または数字14桁
TNT Express - TNTExpress
- TNT宅配
- TNT Express		 数字8~9桁
USPS USPS 数字10桁または数字22桁または英字の大文字2桁+数字9桁+英字の大文字2桁
(区切り文字なし)
EMS EMS 英字の大文字2桁+数字9桁+英字の大文字2桁
(区切り文字なし)
DHL DHL 数字10桁
GOODSTOLUCK GOODSTOLUCK 数字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"
        }
    ]
}
項目 Mandatory Type 説明 備考
requestId Mandatory String 送信リクエスト ID
requestTime Mandatory DateTime 送信リクエスト時間 yyyy-MM-dd'T'HH:mm:ss.SSS
statusCode Mandatory String リクエスト状態コード - 成功: 202
- 失敗: その他
- HTTP Status規格に従う
statusName Mandatory String リクエスト状態名 - 成功: success
- 処理中: processing
- 予約中: reserved
- 失敗: fail
messages.messageId Mandatory String メッセージ ID
messages.countryCode Optional String 受信者の国番号 デフォルト: 82
messages.to Mandatory String 受信者の番号
messages.content Mandatory String 通知トークメッセージの内容
messages.requestStatusCode Mandatory String 送信リクエスト状態コード - 成功: A000
- 失敗: その他のコード(Desc項目に失敗理由が明示される)
messages.requestStatusName Mandatory String 送信リクエスト状態名 - 成功: success
- 失敗: fail
messages.requestStatusDesc Mandatory String 送信リクエスト状態の内容
messages.useSmsFailover Mandatory Boolean SMS Failover使用の有無

レスポンスステータス

HTTP Status Desc
202 Accepted(送信リクエスト完了)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal 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

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

Parameters

項目 Mandatory Type 説明 備考
requestId Mandatory String リクエスト ID 送信リクエスト ID
plusFriendId Mandatory String カカオチャンネル 登録されたチャンネル名
requestStartTime Mandatory String 照会時間の開始時刻 yyyy-MM-dd'T'HH:mm:ss
requestEndTime Mandatory String 照会時間の終了時刻 yyyy-MM-dd'T'HH:mm:ss
completeStartTime Mandatory String 送信完了の開始時間 yyyy-MM-dd'T'HH:mm:ss
completeEndTime Mandatory String 送信完了の終了時間 yyyy-MM-dd'T'HH:mm:ss
messageId Optional String メッセージ ID
requestStatusName Optional String リクエスト状態 success, fail
messageStatusName Optional String リクエスト状態 success, processing, fail
templateCode Optional String テンプレートコード 登録されたテンプレートコード
to Optional String メッセージ受信番号 ハイフン「-」を除く番号
nextToken Optional String 次のページのトークン 下記参照
pageSize Optional Integer ページサイズ デフォルト: 20, 最大: 100
requestIdを含めて照会する場合、デフォルト: 100
参考
  • メッセージの送信履歴は直近30日以内の履歴のみ照会できます。
  • requestId、requestStartTime + requestEndTime、completeStartTime + completeEndTimeのうち少なくとも1つは必須です。
  • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時には使用できません。
  • requestStartTime ~ requestEndTimeの照会範囲は最大31日に制限されます。
  • completeStartTime ~ completeEndTimeの照会範囲は最大24時間に制限されます。
  • 照会条件に requestIdが含まれていない場合、plusFriendIdは必須です。
  • nextToken
    • 前のリクエストでnextTokenレスポンスを受け取った場合にのみ有効で、次のページの結果をリクエストできることを示します。追加結果がある場合、前のレスポンスのnextTokenの値をこの Parameterに設定すると、次のページの結果を照会できます。

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

{
    "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",
    "nextToken": "string",
    "itemCount": "integer",
    "hasMore": "boolean"
}
項目 Mandatory Type 説明 備考
requestId Optional String 送信リクエスト ID requestIdで照会する場合にのみ表示
statusCode Mandatory String リクエスト状態コード 202 - 成功
その他 - 失敗
* HTTP Status規格に従う
statusName Mandatory String リクエスト状態名 success - 成功
processing - 送信中
reserved - 予約中
fail - 失敗
messages.requestTime Mandatory DateTime 送信リクエスト時間 yyyy-MM-dd'T'HH:mm:ss.SSS
messages.messageId Mandatory String メッセージ ID
messages.countryCode Optional String 受信者の国番号 デフォルト: 82
messages.to Mandatory String 受信者番号
messages.content Mandatory String 通知トークメッセージの内容
messages.plusFriendId Mandatory String カカオトークチャンネル名((旧)プラス友達 ID)
messages.templateCode Mandatory String テンプレートコード
messages.completeTime Optional DateTime 送信レポート(処理完了)時間 yyyy-MM-dd'T'HH:mm:ss
messages.requestStatusCode Mandatory String 送信リクエスト状態コード A000 - 成功
その他のコード - 失敗(Desc項目に失敗理由が明示される)
messages.requestStatusName Mandatory String 送信リクエスト状態名 success - 成功
fail - 失敗
messages.requestStatusDesc Mandatory String 送信リクエスト状態の内容
messages.messageStatusCode Mandatory String 送信結果状態コード 0000 - 成功
その他のコード - 失敗(Desc項目に失敗理由が明示される)
messages.messageStatusName Mandatory String 送信結果状態名 success - 成功
processing - 処理中
    * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
    * messageCode、messageDescが照会されていない
fail - 失敗
messages.messageStatusDesc Mandatory String 送信結果状態の内容
messages.useSmsFailover Mandatory Boolean SMS Failover使用の有無
messages.failover Optional Object SMS Failover
messages.failover.smsServiceId Optional String SMS Failoverのサービス ID
messages.failover.requestId Optional String SMS Failoverの送信リクエスト ID
messages.failover.messageId Optional String SMS Failoverの送信メッセージ ID
messages.failover.requestStatusCode Optional String SMS Failoverの送信リクエスト状態コード エラーコード表を参考
messages.failover.requestStatusName Optional String SMS Failoverの送信リクエスト状態名 success - 成功
fail - 失敗
messages.failover.requestStatusDesc Optional String SMS Failoverの送信リクエスト状態の内容
messages.failover.messageStatus Optional String SMS Failoverの送信処理状態 READY: 待機
PROCESSING: 処理中
COMPLETED: 処理完了
messages.failover.messageStatusCode Optional String SMS Failover送信端末の受信状態結果コード エラーコード表を参考
messages.failover.messageStatusName Optional String SMS Failover送信端末の受信結果名
messages.failover.messageStatusDesc Optional String SMS Failover送信端末の受信内容
pageSize Mandatory Integer ページサイズ
nextToken Optional String 次のページのトークン 下記参照
itemCount Mandatory Integer 照会結果ページ内のメッセージ数
hasMore Mandatory Boolean 次のページの存在有無
参考
  • 照会条件に requestIdが含まれていない場合、requestIdは含まれません。
  • nextToken
    • 照会された結果の次のページが存在する場合にのみnextTokenがレスポンスに含まれます。nextTokenの値をリクエスト照会 API Parameterに設定すると、次のページの結果を照会できます。

レスポンスステータス

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

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

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

リクエスト URL

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

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

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

{
    "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"
    }
}
項目 Mandatory Type 説明 備考
messageId Mandatory String メッセージ ID
requestId Mandatory String 送信リクエスト ID
requestTime Mandatory DateTime 送信リクエスト時間 yyyy-MM-dd'T'HH:mm:ss.SSS
completeTime Optional DateTime 送信レポート(処理完了)時間 yyyy-MM-dd'T'HH:mm:ss
plusFriendId Mandatory String カカオトークチャンネル名((旧)プラス友達 ID)
templateCode Mandatory String テンプレートコード
countryCode Optional String 受信者の国番号 デフォルト: 82
to Mandatory String 受信者番号
content Mandatory String 通知トークメッセージの内容
requestStatusCode Mandatory String 送信リクエスト状態コード A000 - 成功
その他のコード - 失敗(Desc項目に失敗理由が明示される)
requestStatusName Mandatory String 送信リクエスト状態名 success - 成功
fail - 失敗
requestStatusDesc Mandatory String 送信リクエスト状態の内容
messageStatusCode Mandatory String 送信結果状態コード 0000 - 成功
その他のコード - 失敗(Desc項目に失敗理由が明示される)
messageStatusName Mandatory String 送信結果状態名 success - 成功
processing - 処理中
    * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
    * messageCode、messageDescが照会されていない
fail - 失敗
messageStatusDesc Mandatory String 送信結果状態の内容
messages.useSmsFailover Mandatory Boolean SMS Failover使用の有無
messages.failover Optional Object SMS Failover使用の有無
messages.failover.smsServiceId Optional String SMS Failoverのサービス ID
messages.failover.requestId Optional String SMS Failoverの送信リクエスト ID
messages.failover.requestStatusCode Optional String SMS Failoverの送信リクエスト状態コード エラーコード表を参考
messages.failover.requestStatusName Optional String SMS Failoverの送信リクエスト状態名 success - 成功
fail - 失敗
messages.failover.requestStatusDesc Optional String SMS Failoverの送信リクエスト状態の内容
messages.failover.messageId Optional String SMS Failoverの送信メッセージ ID
messages.failover.messageStatus Optional String SMS Failoverの送信処理状態 READY: 待機
PROCESSING: 処理中
COMPLETED: 処理完了
messages.failover.messageStatusCode Optional String SMS Failover送信端末の受信状態結果コード エラーコード表を参考
messages.failover.messageStatusName Optional String SMS Failover送信端末の受信結果名
messages.failover.messageStatusDesc Optional String SMS Failover送信端末の受信内容

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

requestStatusCode Desc
0 成功
E4000 failover設定が有効ではない
E4001 failover設定の情報が抜けている
E4002 failover SMSサービスが設定されていない
E4003 failover SMS type(SMS、LMS)が設定されていない
E4004 failover SMSの発信番号が設定されていない
E4005 failover SMSの件名が設定されていない
E4006 failover SMSの内容が設定されていない
E4007 failover SMSの受信番号が設定されていない
E4008 failover SMSサービスが使用可能な状態ではない
E4009 failover SMSの発信番号が認証されていない
E4010 failover SMS 080無料受信拒否サービスが使用可能な状態ではない
E4999 failover設定のパースエラー(サポートセンターに要相談)
E5000 内部エラー(サポートセンターに要相談)

レスポンスステータス

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

予約メッセージ

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

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

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

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

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

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

レスポンスステータス

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

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

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

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

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

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

なし

レスポンスステータス

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

カカオトークチャンネル

チャンネルの照会

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

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

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

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

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

レスポンスステータス

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

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

Parameters

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

Headers

API Headerへ

リクエストボディ

なし

レスポンスボディ

[
    {
        "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"
    }
]
項目 Mandatory Type 説明 備考
createTime Mandatory String 作成時間 format: LocalDateTime
updateTime Optional String 更新時間 format: LocalDateTime
channelId Mandatory String カカオトークチャンネル ID
templateCode Mandatory String テンプレートコード
templateName Mandatory String テンプレート名
categoryCode Mandatory String テンプレートカテゴリコード
categoryName Mandatory String テンプレートカテゴリ名
messageType Mandatory String テンプレートメッセージタイプ - BA: 基本型
- EX: 付加情報型
- AD: 広告追加型
- MI: 複合型
emphasizeType Mandatory String テンプレート強調のタイプ - NONE: 基本型
- TEXT: 強調表記型
- IMAGE: 画像型
- ITEM_LIST: アイテムリスト型
content Mandatory String テンプレートの内容
adContent Optional String 広告メッセージ
extraContent Optional String 付加情報
title Optional String 強調表記型のタイトル
additionalTitle Optional String 強調表記型の追加タイトル
comments.commentId Mandatory String 検収 ID
comments.content Mandatory String 検収の内容
comments.status Mandatory String 検収の状態 - 検収完了: APR
- 検収の不受理: REJ
comments.create Mandatory String 検収時間
comments.attachment Optional Object 検収問い合わせの添付ファイル
comments.attachment.fileName Mandatory String ファイル名
comments.attachment.fileUrl Mandatory String ファイル URL
templateInspectionStatus Mandatory String テンプレートの検収状態 - 受諾: ACCEPT
- 登録: REGISTER
- 検収中: INSPECT
- 完了: COMPLETE
- 不受理: REJECT
templateStatus Mandatory String テンプレートの状態 - 正常: ACTIVE
- 待機: READY
- 停止: STOP
buttons Optional Array of Object 通知トークのメッセージのボタン 上位のテンプレートボタン情報を参照
buttons.order Mandatory Integer ボタンの順番 ボタンの登録順番
buttons.type Mandatory String ボタンType 上位のテンプレートボタン情報を参照
buttons.name Mandatory String ボタン名 上位のテンプレートボタン情報を参照
buttons.linkMobile Optional String ボタン mobile link 登録されている template button情報を参照
buttons.linkPc Optional String ボタン pc link 登録されている template button情報を参照
buttons.schemeIos Optional String ボタン ios scheme 登録されている template button情報を参照
buttons.schemeAndroid Optional String ボタン adnroid scheme 登録されている template button情報を参照
title Optional String 強調表示型のタイトル
additionalTitle Optional String 強調表示型の追加タイトル
useImage Mandatory Boolean 画像の使用有無
imageName Optional String 画像名
imageUrl Optional String 画像 URL
useHeaderContent Mandatory Boolean ヘッダの使用有無
headerContent Optional String ヘッダの内容
useItemHighlight Mandatory Boolean アイテムハイライトの使用有無
useItemHighlightImage Mandatory Boolean アイテムハイライト画像の使用有無
itemHighlight Optional Object アイテムハイライト アイテムハイライト使用時にのみ表示
itemHighlight.title Optional String アイテムハイライトの件名
itemHighlight.description Optional String アイテムハイライトの内容
itemHighlight.imageUrl Optional String アイテムハイライトの画像 URL
item Optional Object アイテム アイテム使用時にのみ表示
item.list Optional String アイテムリスト アイテムリスト使用時にのみ表示
item.list.title Optional String アイテム名
item.list.description Optional String アイテム内容
item.summary Optional String アイテムサマリー情報 アイテムサマリー情報使用時にのみ表示
item.summary.title Optional String アイテムサマリー情報名
item.summary.description Optional String アイテムサマリー情報の内容
securityFlag Mandatory Boolean セキュリティ設定の有無
isBlock Mandatory Boolean テンプレートをブロックするかどうか
isDormant Mandatory Boolean テンプレートを休眠に切り替えるかどうか
参考
  • channelIdは必須値であり、templateCode使用時にテンプレートの詳細情報を返します。
  • commentsをはじめとする付加情報は、詳細照会時にのみ表示されます。

レスポンスステータス

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

エラーコード

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

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