モバイルアプリユーザーからの応答をAPI経由で受信する方法

NTT CPaaSは、モバイルアプリユーザーから受信するプッシュ通知に対する応答をサポートしています。応答メッセージの受信方法には基本的に、以下に示す2通りの方法があり、ユースケースに応じて選択可能です。

• HTTP転送メソッド - モバイルアプリユーザーから届くメッセージをリアルタイムで受信できます。
• プルメソッド - 必要な時にいつでもAPI 経由でNTT CPaaSのサーバーから新しいメッセージをフェッチできます。

メッセージの受信を開始する前に、受信メッセージ用にアプリケーションを構成する必要があります。各シナリオの設定方法については、下記の 構成 セクションをご参照ください。ユースケースに応じて、どちらの方法を選択するか自由に決められます。

HTTP転送メソッド

このメソッドを使用して、受信メッセージをリアルタイムで受信します。モバイルアプリのユーザーから受信したすべてのメッセージは、Action setup (アクションのセットアップ) で指定された任意のURLに転送されます。任意のURLは、POSTリクエストを受け取れるように設定しておく必要があります。

プルメソッド

モバイルアプリユーザーから届くすべてのメッセージは、NTT CPaaSプラットフォームで受信され、受信したメッセージを返す APIコール (opens in a new tab)を介して、それらにアクセスすることを決定するまでそこに置かれます。

構成

Configuration (構成) は、アクションの論理コンテナーです。Action setup (アクションのセットアップ)で、インバウンドのメッセージの受信方法を選択できますが、その前に構成を作成する必要があります。

すべての構成の一覧表示

NTT CPaaSプラットフォーム内の各アプリケーションは、一意の識別子であるAPPLICATION CODE で識別できます。

アプリケーションのすべての構成を取得するには、 List all configurations (すべての構成の一覧表示) (opens in a new tab)メソッドを使用します。成功すると、configurationKeyの一覧が表示されます。

単一構成の取得

単一構成を取得 (opens in a new tab)するには、APPLICATION CODE (アプリケーションコード) とConfiguration Key (構成キー) を使用します。

パスパラメーター

新しい構成の作成

NTT CPaaSプラットフォーム内の各アプリケーションは、アプリケーションコードで一意に識別されます。 このメソッド (opens in a new tab) を使って、アプリケーション内に新しい構成を作成します。成功すると、configurationKeyを受け取ります。別の構成が既に存在する場合、新しい構成を作成しようとすると、409 CONFLICTステータスになります。

構成の削除

構成を削除するには、このメソッド (opens in a new tab)を使って、削除したいconfigurationKey (opens in a new tab)と構成を削除したいAPPLICATION CODEを指定します。

パスパラメーター

アクションのセットアップ

アクションモデル

アクションが異なれば、それぞれのアクションがトリガーするロジックに応じてモデルも異なります。これらのモデルは、GETメソッドとPOSTメソッドのリクエスト本文と応答本文として使用されます。

HTTP FORWARDアクション

プルアクション

すべてのアクションを一覧表示

特定のアプリケーション構成のアクション (存在する場合) を返すには、List all actions (すべてのアクションを一覧表示) (opens in a new tab) メソッドを使用します。成功すると、応答には、指定した構成のすべてのアクションが含まれます。

新しいアクションの作成

アプリケーション内で構成用の新しいアクションを作成するには、 Create a new action (新しいアクションの作成) (opens in a new tab)メソッドを使用します。

パスパラメーター

リクエスト例

HTTP転送

 
    {
    
        "type": "HTTP_FORWARD",
    
        "forwardUrl": "https://www.myDomain.com/messageReceiver",
    
        "callbackData": "callbackData"
    
    } 
 

リクエスト例

プル

 
    {
        "type": "PULL",
        "callbackData": "callbackData"
    }
 

アクションの削除

アクションを削除するには、 Delete (削除) (opens in a new tab)メソッドを使用します。

パスパラメーター