NAVERクラウドプラットフォーム商品の使用方法をより詳細に提供し、多様なAPI活用の支援のため [説明書]と [API参照書]を区別して提供しております。
2019年1月10日からNcloudのOPEN API説明書がリニューアルされました。
リニューアルされた説明書は以下のリンクをご参照ください。
通知トークAPI v2 API参照書へショートカット >>
Simple & Easy Notification Service 通知トーク説明書へショートカット >>
目次
- カカオトークチャンネルを生成する
- カカオトークチャンネルを登録する
- カカオトークチャンネルに移管する
- カカオトークチャンネルを削除する
- カカオトークチャンネルを復元する
- カカオトークチャンネルを永久削除する
- カカオトークチャンネルFailoverを設定する
- 通知トークテンプレートを登録する
- 通知トークテンプレートを修正する
- 通知トークテンプレートを削除する
- 通知トークテンプレートのお問い合わせ
- 通知トークメッセージを発送する
- 通知トークメッセージの発送履歴を照会する
- 予約メッセージの結果を照会/キャンセルする
- スケジュールを生成/修正/削除する
カカオトークチャンネルを生成する
カカオトークチャンネルはカカオトーク カカオトークチャンネル管理者センターから生成できます。生成したカカオトークチャンネルの通知サービスに登録するためには 登録してからホームを公開に設定変更が必要です。
2017年5月24日イエローIDからプラスカカともに変更されました。
2019年9月17日 プラスカカともからカカオトークチャンネルに変更されました。
カカオトークチャンネルを登録する
通知トークサービスは事業者顧客のみ使用できるビズメッセージサービスです。ビジネス認証を受けたカカオトークチャンネルのみ登録でき、ビジネス認証はカカオトークチャンネル管理者センターを通じてできます。登録のためにはカカオトークチャンネル、管理者番号によるカカオトーク認証が必要です。
コンソールへアクセスして Biz Message > KakaoTalk Channel メニューへ移動して チャンネルを登録 ボタンをクリックします。
① カカオトークチャンネルIDはチャンネル生成の際に登録した検索用IDを入力します。（お客様が受け取る通知トークメッセージはカカオトークに登録したチャンネル名で表示されます。)
② 認証番号を受信する管理者の携帯電話番号を入力します。認証番号はカカオトークメッセージで発送されます。
③ 事業者カテゴリーを選択します。(大/中/小分類)
④ ①~③ 項目を全て入力後認証番号を獲得する ボタンを押すと入力した携帯電話番号に認証番号が発送されます。受信した認証番号を入力後登録できます。
有効でない事業者情報で登録された通知トークサービスは予告なしで削除されることがあり、アビュージングにみなされることがあります。繰り返されるアビュージングの試みがある際はSimple & Easy Notification Serviceサービスの使用が遮断されることがあるのでご注意ください。
カカオトークチャンネルに移管する
移管しようとするカカオトークチャンネルを選択し、転送ボタンをクリックすると、移管画面がポップアップされます。
ビズメッセージの使用設定がされている他のプロジェクトに移管できます。
基本的に同一アカウント内での移管のみ可能であり、
他のアカウントへのカカオトークチャンネルの移転が必要な場合、顧客サポートを通じて現在チャンネルが登録されているアカウントと移転するアカウントにそれぞれ移管/引受け要請を登録してください。
カカオトークチャンネルを削除する
削除しようとするカカオトークチャンネルを選択して削除 ボタンをクリックすると削除リクエスト画面がポップアップされます。
削除と同時に削除された状態に切り替わり、復元機能で元の状態に戻すことができます。
カカオトークチャンネルを復元する
復元しようとするカカオトークチャンネルを選択し、戻すボタンをクリックすると、復元画面がポップアップされます。
復元後すぐに使用可能な状態に切り替わります。
カカオトークチャンネルを永久削除する
永久削除しようとするカカオトークチャンネルを選択し、完全削除ボタンをクリックすると、削除要請画面がポップアップされます。
カカオトークチャンネルの永久削除には検収が必要です。
一度要請された永久削除は取り消すことができず、永久削除以降は復旧できません。
また、永久削除されたカカオトークチャンネルは、二度とSENSに登録できません。
カカオトークチャンネルFailoverを設定する
Failover 設定ボタンをクリックすると、設定画面がポップアップします。
① ボタンをクリックすると、設定画面がポップアップします。
② 使用するかどうかを選択します。
③ Failoverに使用するプロジェクトを選択します。
- SMSサービスを使用中のプロジェクトのみ選択できます。
④ Failover に使用する発信番号を選択します。
- 承認済みの発信番号だけを選択することができます。
- 設定された発信番号は、Failover 時に基本発信番号として使用されます。
- 設定後に発信番号承認状態が変更されると、Failover は動作しません。
通知トークテンプレートを登録する
カカオトークチャンネル登録以降に通知トークメッセージ発送のためにはテンプレートのチェック過程が必要です。検収には平均2～3日間所要されます。(営業日基準、週末及び休日を除く)
コンソールへアクセスして Biz Message > AlimTalk Template メニューへ移動してテンプレートを登録するプロジェクトを選択後 テンプレートを登録 ボタンをクリックします。
① テンプレートを登録するカカオトークチャンネルを選択します。
② テンプレートコードを入力します。識別者に使用され、カカオトークチャンネル内では重複されません。
③ テンプレート名を入力します。同じカカオトークチャンネルでは重複されません。
④ テンプレートの内容を入力します。
- 通知トークメッセージに使用する内容を入力します。
- 変数に使用する文は #{置換者}で入力します。(例: #{name}).
⑤ テンプレートに使用するボタンをクリックします。
- 配送照会, ウェブリンク, アプリリンク, ボットキーワード, メッセージ転送 の5タイプのボタンを追加できます。
- 最大5個のボタンを追加できます。
- ウェブリンクは必ず
http://またはhttps://で始まるURLを入力してください。 - ボタンリンクに置換者を使用の際は
http://またはhttps://プロトコルを明記しないと登録できません。(例:http://#{URL}またはhttps://#{URL}). - ボタンType別の詳細情報は下の テンプレート作成ガイドへショートカットから確認できます。
テンプレート登録後は 検収リクエスト -> 検収待機中 -> 検収中→検収下げ戻し/検収完了 状態の順で進みます。
検収下げ戻しの際、お問い合わせ登録及び修正を通じて再検収が可能で、削除後に再登録もできます。
検収が完了したテンプレートは通知トークメッセージの発送に使うことができ、修正/削除はできません。
テンプレートの検収及び作成に関する詳しいガイドは次のリンクをご参照ください。
通知トークテンプレートを修正する
検収の下げ戻し 状態のテンプレートのみ修正できます。下げ戻されたテンプレートはお問い合わせする、修正するを通じて再検収リクエストできます。
カカオトークチャンネル及びコードは修正できません。
修正したテンプレートは検収待機中 状態から再び進められます。
通知トークテンプレートを削除する
検収リクエスト, 検収待機中, 検収下げ戻し 状態のテンプレートのみ削除できます。
削除されたテンプレートコードは再利用できます。
削除されたテンプレートはリカバリーできません。
通知トークテンプレートのお問い合わせ
検収中, 検収下げ戻し 状態のテンプレートのみお問い合わせできます。
テンプレート検収のための質疑応答チャンネルに利用できます。
お問い合わせはカカオトーク検収担当者に伝わり、検収履歴タブ画面から照会できます。
通知トークメッセージを発送する
通知トークの発送は OPEN APIを通じてできます。(OPEN API使用ガイドへショートカット).
通知トークメッセージの発送履歴を照会する
発送リクエストされた通知トークメッセージの履歴を照会できます。
コンソールへアクセスして Biz Message > AlimTalk Message メニューへ移動します。
発送履歴を照会するプロジェクトとカカオトークチャンネルを選択します。
① 検索するリクエスト期間を選択します。
② リクエスト状態、テンプレートコード、リクエストID、受信番号を検索できます。
③ リクエスト状態はメッセージ発送サーバへの送信成功の可否を意味します。
④ 発送状態はメッセージの発送サーバが受信端末へのカカオトーク発送成功可否を意味します。
⑤ Failover 動作状態であり、SMS 代替送信要請状態を意味します。
- SMS受信の成否は、SMSメッセージの履歴から確認することができます。
⑥ リクエストIDは受信者1人当たり1個ずつ発行され、OPEN APIから個別結果を照会できます。(OPEN API使用ガイドへショートカット).
⑦ Failoverが設定されたリクエストなのかどうかを意味します。
結果を見るボタンをクリックすると、 発送リクエストに関する結果データを確認できます。 (JSON形式)
- 発送結果データに関する詳しい説明はOPEN APIガイドで確認できます。OPEN API 使用ガイドへショートカット).
予約メッセージの結果を照会/キャンセルする
Reservation メニューへ移動する
コンソールへアクセスしてBiz Message > Reservation メニューから 予約の内訳 タブへ移動します。
予約内訳を照会する
① 予約時間で検索できます。
② 状態で検索できます。
③ 予約時間帯に該当する予約時間です。
④ 予約状態を意味します。 READY, PROCESSING, CANCELED, FAIL, DONE, STALE, SKIPで区別します。
⑤ メッセージ予約IDです。
⑥ 詳細をみるをクリックするとメッセージの発送内容を照会できるウィンドウがポップアップされます。
⑦ 結果をみるをクリックするとメッセージの発送結果を照会できるウィンドウがポップアップされます。
予約をキャンセルする
① キャンセルしたい予約をクリックします。
② 上段の 予約をキャンセル ボタンをクリックします。 (予約キャンセルの場合、Ready状態の予約のみキャンセルできます。)
③ キャンセルしようとする予約の内訳が間違いないか確認して削除します
スケジュールを生成/修正/削除する
Reservation メニューへ移動する
コンソールへアクセスしてBiz Message > Reservationメニューから スケジュール タブへ移動します。
プロジェクトを選択及び発送画面をポップアップする
登録されたプロジェクトリストの中からスケジュールを生成するプロジェクトを選択します。
① 検索ウィンドウを利用していつでもプロジェクトを転換できます。
② プロジェクトを選択後 生成する ボタンをクリックします。
スケジュールを生成する
① スケジュール発送に使用するスケジュールコードを入力します。
② 繰り返す曜日を選択します。毎日をクリックすると全ての曜日が選択されます。
③ メッセージを発送する時間を入力します。[HH:mm]の形で入力でき、選択されたTimeZoneに合わせて発送されます。
④ スケジュールが作動する期間を選択します。最大6か月まで選択できます。
⑤ スケジュールに関する説明を自由に入力します。
スケジュールを修正/削除する
① 修正または削除するスケジュールを選択します。
② 修正 ボタンをクリックして必要な情報に修正後アップデートします。
③ 削除 ボタンをクリックしてスケジュールコードを入力後削除します。
スケジュールメッセージを照会する
① スケジュールをクリックするとスケジュールの下からスケジュールメッセージを確認できます。
② スケジュールにMappingされたメッセージIDです。
③ 詳細をみるをクリックするとメッセージに関する情報を照会できます。
④ 結果をみるをクリックするとメッセージに関する発送履歴を照会できます。
