2019年1月10日からNcloudのOPEN API説明書がリニューアルされました。
リニューアルされた説明書は以下のリンクをご参照ください。

PUSH API(v1, 旧バージョン) 説明書へショートカット >>

  • Simple & Easy Notification Service PUSH OPEN API v1は2019年1月からサポート中断されます。

PUSH API(v2, 新バージョン) API 参照書へショートカット >>
Simple & Easy Notification Service Push 説明書へショートカット >>

目次

証明書を発行する

Pushサービスを利用するためには使用しようとするPush Type別に証明書を発行して当該証明書をSimple & Easy Notification Serviceに登録する必要があります。

証明書を登録する

コンソールへアクセスしてPush > Certificate メニューをクリックします。

登録されたプロジェクトリストの中から証明書を登録するプロジェクトを選択します。

GCM/FCM証明書を登録する

① 検索ウィンドウを利用していつでもプロジェクトを転換できます。
② 発行されたSender Id
③ 発行されたServer Key

APNS証明書を登録する

プロジェクトを選択後、証明書を登録します。

① 証明書ファイルをアップロード
② 証明書のパスワード
③ 証明書Type(Sandbox/Production)
④ App Id(証明書が登録されたら表示されます。)
⑤ 証明書の満了日(証明書が登録されたら表示されます。)

証明書を修正する

登録された証明書情報を変更すると 保存 ボタンが有効化されます。 保存 ボタンをクリックすると証明書情報が修正されます。

証明書を削除する

証明書が登録された状態では 削除 ボタンが表示されます。 削除 ボタンをクリックすると証明書を削除できます。

① 削除する証明書のプロジェクト名を再度入力すると 確認 ボタンが有効化されます。

ユーザーデバイスを登録/削除する

証明書登録が完了したらユーザーデバイスを登録/削除できます。

ユーザー/デバイス登録/削除機能はOPEN APIで提供されます(API v2使用ガイドへショートカット)。提供されるOPEN APIを使用して顧客のApplicationから自由にユーザー及びデバイストックンを管理できます。

チャンネルを生成する

コンソールへアクセスして Push > Channel メニューをクリックします。

登録されたプロジェクトリストの中からチャンネルを生成するプロジェクトを選択します。検索ウィンドウを利用していつでもプロジェクトを転換できます。

生成する ボタンをクリックするとチャンネル生成のダイアログボックスが生成されます。

① チャンネル名です。必ず入力する値で、英文字の小文字、数字、ハイフン(-) 下線(_)でのみ構成でき、24字未満で入力できます。
② チャンネルの説明です。128字未満で入力できます。

チャンネルにユーザーを登録/削除する

チャンネル生成が完了したら、チャンネルにユーザーを登録できます。チャンネルの管理機能はOPEN APIで提供されます(API v2 使用ガイドへショートカット)。

チャンネルを修正する

チャンネルの照会画面から修正しようとするチャンネルの右端のボタンをクリックして 修正 ボタンをクリックします。

① チャンネル名は修正できません。
② チャンネルの説明は修正できます。

チャンネルを削除する

チャンネルの照会画面から削除しようとするチャンネルの右端のボタンをクリックして 削除 ボタンをクリックします。

① 削除するチャンネル名を再度入力すると 確認 ボタンが有効化されます。

メッセージを発送する

Pushメッセージの発送はOPEN APIを通じてのみできます。 OPEN API 使用ガイドへショートカット

メッセージの発送結果を照会する

メッセージの発送結果を数秒内にリアルタイムで照会できます。結果をみるボタンをクリックします。

① メッセージの発送結果を確認できます。 JSON形式のデータで提供されます。

項目 Mandatory Type 説明 備考
requestId Mandatory String リクエストID
requestTime Mandatory DateTime リクエスト時間
statusCode Mandatory String リクエスト状態コード 以下の Response Code 参照
statusName Mandatory String リクエスト状態名 success - 成功
fail - 失敗
statusMessage Mandatory String リクエスト状態メッセージ
messageStatusCode Mandatory String 発送状態コード 200 - 成功
その他 - 失敗
messageStatusName Mandatory String 発送状態名 success - 成功
processing - 処理中
fail - 失敗
completeTime Mandatory DateTime 発送完了時間
targetCount Mandatory Integer リクエスト対象のデバイス数
sentCount Mandatory Integer 発送成功デバイス数
messageType Mandatory String メッセージタイプ NOTIF - 通知メッセージ
AD - 広告性メッセージ
target Mandatory Object 発送リクエストtarget情報
message Mandatory Object 発送リクエスト message 情報  
  • 発送状態が処理中(processing)の場合、targetCount/sentCountが0に照会されます(集計前)。

メッセージの発送履歴を照会する

メッセージの発送履歴を照会できます。最大30日まで保管されます。

① リクエスト日時で検索できます。
② リクエスト状態で検索できます。
③ メッセージングサーバへのリクエスト状態を意味します(Success, Fail)。
④ メッセージングサーバでの発送状態を意味します(Success, Processing, Fail)。
⑤ 発送リクエストの結果を照会できます。

予約メッセージの結果を照会/キャンセルする

Reservation メニューへ移動する

コンソールへアクセスして Push > Reservation メニューから 予約内訳 タブへ移動します。

予約内訳を照会する

① 予約時間で検索できます。
② 状態で検索できます。
③ 予約時間帯に該当する予約時間です。
④ 予約状態を意味します。 READY, PROCESSING, CANCELED, FAIL, DONE, STALE, SKIPで区別されます。
⑤ メッセージ予約のIDです。
⑥ 詳細をみるをクリックするとメッセージ発送内容を照会できるウィンドウがポップアップされます。

予約をキャンセルする

① キャンセルしたい予約をクリックします。
② 上段の 予約をキャンセル ボタンをクリックします。 (予約のキャンセルは Ready状態の予約のみキャンセルできます。)
③ キャンセルしようとする予約の内訳が間違いないか確認して削除します。

スケジュールを生成/修正/削除する

Reservationメニューへ移動する

コンソールへアクセスして Push > Reservation メニューから スケジュール タブへ移動します。

プロジェクトを選択及びメッセージ発送画面をポップアップする

登録されたプロジェクトリストの中からスケジュールを生成するプロジェクトを選択します。

① 検索ウィンドウを利用していつでもプロジェクトを転換できます。
② プロジェクトを選択後 生成する ボタンをクリックします。

スケジュールを生成する

① スケジュール発送に使用するスケジュールコードを入力します。
② 繰り返す曜日を選択します。 毎日をクリックすると全ての曜日が選択されます。
③ メッセージを発送する時間を入力します。[HH:mm] の形で入力でき、選択されたTimeZoneに合わせて発送されます。
④ スケジュールが作動する期間を選択します。6か月後まで選択できます。
⑤ スケジュールに関する説明を自由に入力します。

スケジュールを修正/削除する

① 修正または削除するスケジュールを選択します。
[修正] ボタンをクリックして必要な情報に修正してアップデートします。
[削除] ボタンをクリックしてスケジュールコードを入力後削除します。

スケジュールメッセージを照会する

スケジュールをクリックするとスケジュールの下からスケジュールメッセージを確認できます。
② スケジュールにMappingされたメッセージIDです。
詳細をみるをクリックするとメッセージに関する情報を照会できます。

OPEN API v1 使用ガイド

API v1 deprecated予定(2019年1月)

API v1は段階的にdeprecatedされる予定です。
新たに Simple & Easy Notification Serviceの Push サービスを利用される場合は API v2を使用されることお勧めします。

API v2はデバイス/ユーザー別受信同意の管理機能及びCustomメッセージの発送 / Push Type別 option 設定などの新規 featureなどが提供され、
今後の機能改善はv2 バージョン以上でのみ適用される見込みです。

API v2 migration

v2を使用するために新たにプロジェクトを生成する必要はありません。
v1で使用していたプロジェクトとサービスIDはそのまま使用でき、v2で提供される APIをそのまま使用できます。
但し、 v2以上からはNAVERクラウドプラットフォームのAPI Gatewayと連携されてIAM認証が基本として必要になります。
関連内容はAPI v2使用ガイドをご参照ください。 API v2 使用ガイドへショートカット


API v1 Swagger

API v1はSwagger ページからガイドを提供致します。 API v1 Swagger へショートカット

に対する検索結果は~件です。 ""

    に対する検索結果がありません。 ""

    処理中...