API以上のRCS

RCS API、Messages API、または Conversations API を使用して、RCS（Rich Communication Services メッセージとイベントを送受信します。RCS API は、チャネル固有の統合のための完全な RCS 機能セットを公開します。Messages API と Conversations API は、オムニチャネルのユースケースで他のチャネルとともに RCS をサポートします。

このページでは、送信メッセージとイベント、受信メッセージとイベント、ログとステータスレポート、機能チェック、送信者、テスト番号、テンプレート管理について説明します。開始する前に、compliance and guidelines と message types についてよく理解してください。

Looking for technical details?
NTT CPaaS RCS APIのドキュメントで、エンドポイントの仕様、リクエストの例、レスポンスパラメータをご覧ください。

RCS APIでできること

RCS API を使用して、次のことを行います。

オプションの SMS または MMS フェイルオーバー、有効期間、スケジュール配信、配信時間枠、URL クリック追跡を使用して、テキスト、ファイル、カード、カルーセル、テンプレート形式でリッチな送信メッセージを送信します。
入力インジケーターや開封確認などのメッセージングイベントを送信します。
受信メッセージとリアルタイムイベント(ユーザーアクションと入力)を受信します。
Webhook を介してメッセージ配信、既読状態、会話セッションの開始を追跡します。
送信前に、RCS の宛先番号の機能を確認してください。
送信者、テスト番号、メッセージテンプレートをプログラムで管理します。

この API は、トランザクションアラート、OTP、プロモーションメッセージから、豊富な双方向の会話エクスペリエンスまで、フルサイクルの通信をサポートします。

認証と構成を設定する

RCS メッセージの送受信を開始する前に、次の設定を完了してください。

** API認証ガイドを使用して統合を認証**します。すべての RCS エンドポイントは、標準の NTT CPaaS の「権限付与: アプリ」ヘッダーを使用して、パーソナライズされたベース URL で利用できます。
送信メッセージを送信する前に、RCS 送信者を作成して起動します。送信者の作成と起動の手順については、RCSを参照してください。
Webhook 通知を構成して、配信レポート、表示されたレポート、受信メッセージ、およびイベントを受信します。サブスクリプション管理APIを使用してサブスクリプションを設定するか、 NTT CPaaS WebインターフェイスでグローバルWebhook URLを割り当てます。
プロモーションコンテンツを送信する前に、地域の規制要件とオプトイン要件を満たすために compliance and guidelines を確認してください。

送信メッセージ

送信メッセージは、モバイル終端(MT)メッセージとも呼ばれ、RCSを介してビジネスからエンドユーザーに送信されるメッセージです。RCS は、テキスト、ファイル、カード、カルーセル、テンプレートメッセージなど、複数のメッセージ形式をサポートしており、それぞれがリッチでインタラクティブなコミュニケーションを可能にします。詳細な形式仕様、サポートされているメディアの種類、および構造要件については、「 message types」を参照してください。

一括およびテンプレートバリアントを含む送信エンドポイントの完全なリストについては、RCS API リファレンスの「アウトバウンドメッセージ」を参照してください。

アウトバウンドイベント

RCS は、メッセージ交換中にリアルタイムのフィードバックを提供する会話インジケーターをサポートしています。iOSとAndroidの両方のプラットフォームは、追加費用なしでこれらの指標をサポートしています。

入力インジケーターは、送信者エージェントまたはチャットボットが積極的に応答を作成していることをエンドユーザーに通知します。インジケーターは、エンドユーザーデバイスに 5 秒間表示されます。

開封確認 送信者エージェントがエンドユーザーからのメッセージを閲覧したことを確認します。エンドユーザーデバイスには、メッセージが表示されたことを示すインジケーターが表示されます。

エンドポイントの詳細については、RCS API リファレンスの「アウトバウンドイベント」を参照してください。

受信メッセージ

受信メッセージは、モバイル発信(MO)メッセージとも呼ばれ、エンドユーザーから RCS を介してビジネスに送信されるメッセージです。受信メッセージは双方向通信を可能にし、テキスト、ファイル、位置データ、提案応答を含めることができます。インバウンドメッセージは、Webhook通知を介してリアルタイムでシステムに配信されます。受信メッセージの種類の詳細については、「メッセージの種類」を参照してください。

Webhook の詳細については、RCS API リファレンスの「受信メッセージ」を参照してください。

手記

JPG ファイルや PDF ファイルなど、エンドユーザーがモバイル発信 (MO) メッセージで送信したメディアファイルは、60 日間使用できます。60 日後、RCS (RCS) はこれらのファイルをキャッシュから削除します。

インバウンドイベント

エンドユーザーが提案されたアクションを操作したり、入力を開始したりしたときに Webhook 通知を受け取ります。

Webhook の詳細については、RCS API リファレンスの「受信イベント」を参照してください。

ログとステータスレポート

RCS メッセージ配信とエンドユーザーエンゲージメントは、配信レポート、表示レポート、および詳細なメッセージログを通じて監視できます。配信レポートでは、メッセージがエンドユーザーデバイスに届いたことが確認されます。表示されたレポートは、エンドユーザーがメッセージを開いて表示したことを示します。

Webhook での請求の透明性

RCS Webhook には、各メッセージに適用される請求タイプを可視化する請求の透明性フィールドが含まれています。これらのフィールドは、メッセージが非会話型請求から会話型請求に移行したタイミングを追跡するのに役立ちます。

フィールド	型	説明
`trafficType`	文字列 (列挙型)	メッセージに適用される請求タイプ。 `BASIC`、 `SINGLE`、 `A2P_CONVERSATION`、 `P2A_CONVERSATION`、 `RICH`、または `RICH_MEDIA`のいずれか。各値と請求タイプへのマッピングについては、請求タイプを参照してください。
`interactionType`	文字列	メッセージのインタラクション分類。
`conversation.id`	文字列	会話セッションの一意の識別子。
`conversation.canInitiate`	ブール	会話セッションを開始できるかどうかを示します。

これらのフィールドは、配信レポート (DLR) Webhook、モバイル発信元 (MO) メッセージ Webhook、およびイベント Webhook に表示されます。

請求の透明性フィールドを含む DLR Webhook ペイロードの例を表示する

手記

Webhook ペイロードの構造とフィールド定義の詳細については、「 RCS 配信レポートの受信 Webhook リファレンス」を参照してください。

会話開始 Webhook イベント

専用の Webhook イベントは、24 時間の会話型課金セッションが開始されるとリアルタイムで通知します。このイベントは、A2P (ビジネス開始) と P2A (ユーザー開始) の両方の会話セッションでトリガーされます。

イベントは、次の各シナリオでトリガーされます。

A2P会話: エンドユーザーが24時間以内にビジネスメッセージに返信し、会話セッションを作成します。
P2A 会話: 企業が 24 時間以内に未承諾のエンドユーザーメッセージに応答し、会話セッションを作成します。

会話開始イベントには、24 時間セッション期間中の後続のメッセージ Webhook の会話 ID と一致するconversation.idフィールドが含まれています。

大事な

Webhook 通知を受信するには、 NTT CPaaS Web インターフェイスで Webhook URL を設定します。設定手順については、「メッセージングイベントのWebhook通知を設定する」を参照してください。

エンドポイントと Webhook の詳細 (配信レポート、メッセージログ、表示されたレポート、会話開始イベント) については、RCS API リファレンスの「ログと状態レポート」を参照してください。

機能チェック

メッセージを送信する前に、特定の電話番号の RCS が利用可能であることを確認します。機能チェックを使用して、RCS が使用できない場合に SMS へのフォールバックロジックを実装します。同期と非同期 (Webhook) の両方の機能チェックがサポートされています。

手記

機能チェック API には、起動された RCS 送信者が必要です。機能チェックを実行する前に、送信者を起動します。

エンドポイントと Webhook の詳細については、RCS API リファレンスの「機能チェック」を参照してください。

送信者管理

RCS 送信者、その構成、および起動要求を管理します。送信者管理には、送信者の作成、構成とプラットフォームパラメーターの更新、起動ステータスの追跡、状態変更に関する Webhook 通知の受信が含まれます。また、特定の国でのローンチのリクエスト、必要なすべての情報を含むローンチリクエストの送信、RCS ローンチが利用可能なプロバイダーおよび国ごとのローンチ要件の表示についても説明します。

送信者管理 API を使用して、次のことを行います。

起動前に送信者を作成して更新します。
送信者と送信者の起動ステータスを追跡します。
利用可能な RCS プロバイダーを表示します。

リソース要求 API を使用して、次のことを行います。

起動情報を照会します。
起動要求を送信して更新します。
起動要求のライフサイクルを追跡します。

エンドポイントと Webhook の詳細については、RCS API リファレンスの「送信者管理」を参照してください。

テスト番号管理

起動前に RCS の送信者を検証するために使用されるテスト番号を管理します。テスト番号の管理には、テスト番号の追加と削除、プライマリテスト番号の設定、可用性の更新、テスト番号の状態変更時の Webhook 通知の受信が含まれます。

エンドポイントと Webhook の詳細については、RCS API リファレンスの「番号管理のテスト」を参照してください。

テンプレート管理

RCS メッセージテンプレートを作成、更新し、承認のために送信します。テンプレート管理には、テンプレートのリスト、テンプレートの作成と編集、承認のための送信、承認ステータスの確認、テンプレートの状態変更時の Webhook 通知の受信が含まれます。

エンドポイントと Webhook の詳細については、RCS API リファレンスの「テンプレート管理」を参照してください。