CPaaS X の使用を開始する

CPaaS Xをセットアップして、1つのNTT CPaaSアカウントから複数の顧客のコミュニケーションを管理します。アプリケーションを作成してコミュニケーションを整理し、顧客を表すエンティティを作成します。

前提条件 [#prerequisites]

CPaaS X を使用するには、次のものが必要です。

メインアカウント: CPaaS Xはサブアカウントでは利用できません。
NTT CPaaSアカウント: CPaaS Xにアクセスするためのログインまたはアカウント登録
有効な通信チャネル: 使用する予定のチャネルは、アカウントで有効になっている必要があります
APIキー: アプリケーションに適した権限を持つAPIキーを作成

もっと詳しく知る

一般的なAPIキー設定についてはAPI認証を、アプリケーション、エンティティ、チャネルごとにアクセスを制限するCPaaS XスコープキーについてはAPIキーの管理をお読みください。

プラットフォーム構造 [#your-platform-structure]

CPaaS X は、次の 2 つのコアコンセプトを中心にコミュニケーションを整理します。

アプリケーション: 環境またはユースケースを表す (たとえば、「本番」、「ステージング」)
エンティティ: 顧客またはビジネスユニットを表します (例: customer-a、customer-b)

マルチテナントプラットフォームは次のようになります。

NTT CPaaSアカウント(CPaaS Xを使用) ├─ 用途:生産 │ ├─ 主体: customer-a │ ├─ エンティティ: customer-b │ └─ エンティティ: customer-c │ └─ アプリケーション:ステージング └─ エンティティ: customer-a

最初のアプリケーションとエンティティを作成する [#create-application-and-entity]

Web インターフェイスまたは API を使用して、最初のアプリケーションとエンティティを作成します。詳細な手順は、アプリケーションとエンティティの管理を参照してください。

アプリケーションを作成する: 環境またはユースケースを表す ID を使用します (例: production、staging、marketing-campaigns)
エンティティを作成する: 顧客またはビジネスユニットを表す ID を使用します (例: customer-a、customer-b)

両方を作成すると、基本的なテナント構造の準備が整います。オンボーディングする顧客ごとにエンティティの作成を繰り返します。

設定を確認する [#verify-your-setup]

アプリケーションとエンティティが正常に作成されたことを確認します。

NTT CPaaS Web インターフェイスで、開発者ツール > アプリケーションとエンティティ に移動します。
アプリケーションの アプリケーション タブを確認します
エンティティの エンティティ タブを確認します

[ アプリケーションの取得 ] エンドポイントと [ エンティティの取得 ] エンドポイントを使用して、アプリケーションとエンティティのページ分割されたリストを取得します。

クエリパラメータ: page (デフォルト: 0), size (デフォルト: 20、最大: 1000)

アプリケーションとエンティティの準備ができました。

最初のメッセージを送信する [#send-your-first-message]

CPaaS X は、サポートされているすべてのチャネル API で動作します。options.platform オブジェクトに applicationId と entityId を含めて、CPaaS X がメッセージを正しいテナントに帰属させるようにします。

この例では、前の手順で作成したアプリケーションとエンティティを使用してSMSを送信します。次のプレースホルダを独自の値に置き換えます。

{baseUrl}: ベース URL
{apiKey}: APIキー
{senderName}: アカウントに登録されている送信者(英数字の送信者 ID や電話番号など)
{recipientNumber}: 送信先の電話番号 (例: 441134960001)

json

1curl -X POST https://{baseUrl}/sms/3/messages \

2 -H "Authorization: App {apiKey}" \

3 -H "Content-Type: application/json" \

4 -d '{

5 "messages": [

6 {

7 "sender": "{senderName}",

8 "destinations": [

9 { "to": "{recipientNumber}" }

10 ],

11 "content": {

12 "text": "Your verification code is 12345"

13 },

14 "options": {

15 "platform": {

16 "applicationId": "production",

17 "entityId": "customer-a"

18 }

19 }

20 }

21 ]

22 }'

応答が成功すると、200 OKステータスが返されます。完全な要求および応答スキーマについては、 SMS API リファレンスを参照してください。

手記

リソースアソシエーションでsending strategiesが設定されている場合は、「送信者」フィールドを省略できます。CPaaS X は、宛先の国、チャネル、ルーティングルールに基づいて最適な送信者を自動的に選択します。

配信とエンティティのアトリビューションを確認する [#check-delivery-and-entity-attribution]

メッセージを送信した後、メッセージが正しいエンティティに帰属していることを確認します。CPaaS X は、リアルタイムの Webhook 通知とメッセージごとのログの 2 つのレベルの可視性を提供します。

Webhook サブスクリプション [#webhook-subscriptions]

配信追跡に推奨されるアプローチ。applicationId と entityId によるフィルタリングをサポートする Webhook subscriptions を使用して、エンティティごとの配信イベントをサブスクライブします。Events はリアルタイムでエンドポイントにプッシュされ、ポーリングは必要ありません。

メッセージログ [#message-logs]

同期検証が必要な場合は、クエリパラメーターとして entityId と applicationId を持つ SMS logs エンドポイントを使用して、特定のテナントのメッセージを取得します。各ログエントリには、エンティティの帰属を確認する「プラットフォーム」オブジェクトが含まれています。ログは送信後、表示されるまでに少し時間がかかる場合があります。

集計されたトラフィックデータ [#aggregated-traffic-data]

使用状況ダッシュボードとトラフィック分析の場合は、メトリック API を使用して、集計されたトラフィックデータをクエリします。APPLICATION_IDとENTITY_ID(指標APIディメンション名)をグループ化ディメンションとして使用して、すべてのチャネルにわたるテナントごとのメッセージ量と配信率を分類します。

また、NTT CPaaS Web インターフェイスの Analyze セクションを使用して、コードを記述せずに、アプリケーションとエンティティのフィルタリングを備えたビジュアルダッシュボードを作成することもできます。

もっと詳しく知る

Metrics API、Analyzeダッシュボード、リアルタイム通知用のイベントサブスクリプションなど、スコープ付きレポートオプションの概要については、Metrics and reporting(/cpaas-x/metrics-and-reporting)をお読みください。

関連ページ

送信戦略の設定
リソースを関連付け、ルーティングルールを定義します。

APIキーの管理
API キーを作成および管理します。

Webhook サブスクリプション
リアルタイムの配信通知を受信します。

アプリケーションとエンティティ
組織の階層とデータの分離を理解します。

リソースを理解する
リソース・タイプ、割り振りモデル、および CPaaS X アソシエーション。