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を用いて、顧客のアプリケーションでユーザーとデバイストークンを自由に管理できます。

チャンネルを作成する

コンソールにアクセスし、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ヶ月後まで選択できます。
⑤ スケジュールに関する説明を自由に入力します。

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

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

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

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

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

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

    処理中...