NAVERクラウドプラットフォームの商品の使用方法をより詳細に提供し、様々なAPIの活用をサポートするために[説明書]と[APIリファレンス]を分けて提供しています。
2019年1月10日からNcloudのOPEN API説明書がリニューアルされました。
リニューアルされた説明書は、以下のリンクを参考にしてください。
通知トークAPI v2 APIリファレンスに移動する >>
Simple & Easy Notification Service 通知トーク説明書に移動する >>
目次
- カカオトークチャンネルを作成する
- カカオトークチャンネルを登録する
- カカオトークチャンネルを移管する
- カカオトークチャンネルを削除する
- カカオトークチャンネルを復元する
- カカオトークチャンネルを完全に削除する
- カカオトークチャンネルのFailoverを設定する
- 通知トークテンプレートを登録する
- 通知トークテンプレートを修正する
- 通知トークテンプレートを削除する
- 通知トークテンプレートについて問い合わせる
- 通知トークメッセージを送信する
- 通知トークメッセージ送信履歴を照会する
- 予約メッセージ結果を照会/キャンセルする
- スケジュールを作成/修正/削除する
カカオトークチャンネルを作成する
カカオトークチャンネルは、カカオトークカカオトークチャンネル管理者センターで作成できます。作成したカカオトークチャンネルの通知トークサービスとして登録するには、登録後にホーム公開に設定を変更する必要があります。
2017年5月24日、イエローアイディからプラス友達に変更されました。
2019年9月17日、プラス友達からカカオトークチャンネルに変更されました。
カカオトークチャンネルを登録する
通知トークサービスは、事業主顧客限定のbizメッセージサービスです。ビジネス認証を受けたカカオトークチャンネルのみ登録することができ、ビジネス認証はカカオトークチャンネル管理者センターで受けられます。登録するには、カカオトークチャンネル、管理者番号によるカカオトーク認証が必要です。
コンソールにアクセスし、Simple & Easy Notification Service > Biz Message > KakaoTalk Channelメニューに移動してチャンネルの登録ボタンをクリックします。
① カカオトークチャンネルは、チャンネル作成時に登録した検索用IDを入力します。(顧客が受け取る通知トークメッセージは、カカオトークに登録したチャンネル名で表示されます。)
② 認証番号を受信する管理者の携帯電話番号を入力します。認証番号はカカオトークメッセージで送信されます。
③ 事業主カテゴリを選択します(大/中/小分類)。
④ ①～③の項目をすべて入力し、認証番号を取得するボタンをクリックすると、入力した携帯電話番号に認証番号が送信されます。受信した認証番号を入力すると、登録できるようになります。
有効でない事業主情報により登録された通知トークサービスは予告なしに削除されることがあり、アビューズ行為とみなされる可能性があります。アビューズ行為を繰り返すとSimple & Easy Notification Serviceサービスの使用が遮断されることがあるので、ご注意ください。
カカオトークチャンネルを移管する
移管したいカカオトークチャンネルを選択して移管ボタンをクリックすると、移管画面がポップアップされます。
bizメッセージの使用が設定されている他のプロジェクトに移管することができます。
基本的に同一アカウント内での移管だけが可能であり、
他のアカウントへのカカオトークチャンネルの移転が必要な場合、サポートセンターを通じて、現在チャンネルが登録されているアカウントと移転するアカウントにそれぞれ移管/引受リクエストを登録する必要があります。
カカオトークチャンネルを削除する
削除したいカカオトークチャンネルを選択して削除ボタンをクリックすると、削除画面がポップアップされます。
削除すると、すぐに削除済み状態に切り替えられ、復元機能で元の状態に戻すこともできます。
カカオトークチャンネルを復元する
復元したいカカオトークチャンネルを選択して復元ボタンをクリックすると、復元画面がポップアップされます。
復元すると、すぐに使用可能な状態に切り替えられます。
カカオトークチャンネルを完全削除する
完全削除したいカカオトークチャンネルを選択して完全削除ボタンをクリックすると、削除リクエスト画面がポップアップされます。
カカオトークチャンネルを完全に削除するには、検収を受ける必要があります。
一度リクエストされた完全削除は、キャンセルすることができず、完全削除以降は復元できません。
また、完全に削除されたカカオトークチャンネルは、二度とSENSに登録できません。
カカオトークチャンネルのFailoverを設定する
Failover設定ボタンをクリックすると、設定画面がポップアップされます。
① ボタンをクリックすると、設定画面がポップアップされます。
② 使用有無を選択します。
③ Failoverに使用するプロジェクトを選択します。
- SMSサービスを使用中のプロジェクトのみ選択できます。
④ Failoverに使用する発信番号を選択します。
- 承認が完了した発信番号のみ選択できます。
- 設定された発信番号は、Failover時に基本の発信番号として使用されます。
- 設定以降に発信番号の承認状態が変更されると、Failoverは動作しません。
通知トークテンプレートを登録する
カカオトークチャンネル登録後、通知トークメッセージを送信するには、テンプレート検収を受ける必要があります。検収は平均で2～3日かかります(営業日基準、週末・祝日を除く)。
コンソールにアクセスし、Simple & Easy Notification Service > Biz Message > AlimTalk Templateメニューに移動してテンプレートを登録するプロジェクトを選択し、テンプレートの登録ボタンをクリックします。
① テンプレートを登録するカカオトークチャンネルを選択します。
② テンプレートコードを入力します。識別子として使用され、同じカカオトークチャンネル内で重複はできません。
③ テンプレート名を入力します。同じカカオトークチャンネル内で重複はできません。
④ テンプレートの内容を入力します。
- 通知トークメッセージとして使用する内容を入力します。
- 変数として使用する文言は#{置換子}で入力します(例：#{name})。
⑤ メッセージのタイプを選択します。
- 基本型：テンプレート本文の内容のみで構成されます。
- 付加情報型：利用案内などの付加的情報メッセージ案内を、付加情報として追加できます。
- 文字数は500文字以内
- 変数使用不可
- チャンネル追加ボタン使用不可
- 情報型メッセージのみ可能
広告追加型：通知トーク検収ガイドのうち、一部許可されたメッセージに限り、チャンネル追加の受信同意、またはイベントプロモーション案内を広告メッセージとして追加できます。
- 文字数は80文字以内
- 変数、URLは使用不可
複合型：付加情報型 + 広告追加型
⑥ 強調のタイプを選択します。
- 基本型：テンプレート本文の内容のみで構成されます。
- 強調表記型：強調が必要な内容を通知トークのふきだし上段領域に表現できます。
- Title：強調して表現する内容 (変数使用可能)
- Additional Title：Titleにどんな内容が入るのかに関する説明 (変数使用不可)
⑦ セキュリティ設定の有無を選択します。
- 使用する時、このテンプレートで送信されたメッセージは、モバイルでのみ確認できます。
⑧ テンプレートで使用するボタンを追加します。
- 配送照会、Webリンク、アプリリンク、ボットキーワード、メッセージ伝達、チャンネル追加の6種類のボタンを追加できます。
- ボタンは最大5個まで追加できます。
- Webリンクは、必ず
http://またはhttps://で始まるURLを入力してください。 - ボタンのリンクに置換子を使用する際、
http://またはhttps://のプロトコルを明示すると登録できます(例：http://#{URL}またはhttps://#{URL})。 - ボタンのType別の詳細情報は、以下のテンプレート作成ガイドに移動するで確認できます。
テンプレートを登録した後は、検収リクエスト -> 検収待機 -> 検収中 -> 検収不受理/検収完了状態の順で行われます。
検収不受理の場合、お問い合わせの登録や修正を介して再検収することができ、削除して再登録することもできます。
検収完了したテンプレートは、通知トークのメッセージ送信に使用することができ、修正や削除はできません。
テンプレートの検収及び作成に関する詳細なガイドは、以下のリンクを参考にしてください。
通知トークテンプレートを修正する
検収不受理状態のテンプレートのみ修正できます。不受理となったテンプレートは、お問い合わせや修正を通じて再検収をリクエストすることができます。
カカオトークチャンネルとテンプレートコードは修正できません。
修正したテンプレートは検収待機状態から再度行われます。
通知トークテンプレートを削除する
検収リクエスト、検収待機、検収不受理状態のテンプレートのみ削除できます。
削除されたテンプレートコードは、再使用できます。
削除されたテンプレートは復元できません。
通知トークテンプレートについて問い合わせる
検収中、検収不受理状態のテンプレートについてのみ問い合わせできます。
テンプレート検収のための質問応答チャンネルとして使用できます。
お問い合わせは、カカオトークの検収担当者に送信され、検収履歴タブ画面で照会できます。
通知トークメッセージを送信する
通知トークの送信は、OPEN APIを介してのみ行われます(OPEN APIユーザーガイドに移動する)。
通知トークメッセージ送信履歴を照会する
送信リクエストされた通知トークメッセージの履歴を照会できます。
コンソールにアクセスし、Simple & Easy Notification Service > 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ヶ月後まで選択できます。
⑤ スケジュールに関する説明を自由に入力します。
スケジュールを修正/削除する
① 修正または削除するスケジュールを選択します。
② 修正ボタンをクリックして自由に情報を修正した後、アップデートします。
③ 削除ボタンをクリックしてスケジュールコードを入力し、削除します。
スケジュールメッセージを照会する
① スケジュールをクリックすると、スケジュールの下でスケジュールメッセージを確認できます。
② スケジュールにマッピングされたメッセージIDです。
③ 詳細確認をクリックすると、メッセージに関する情報を照会できます。
④ 結果を見るをクリックすると、メッセージに関する送信履歴を照会できます。
