チャネルマネージャAPIを使用したRCSブランドおよびエージェントビルダー

VonageのRCSオファリングを使用するには、ブランドはいくつかのブランドレベルのメタデータを登録する必要があり、次にRCSでブランドを代表するAgentを作成し、それを検証し、RCSメッセージを送信するときにMessages APIでそれを使用します。Channel Manager APIは、これらのエンティティ（ブランド、エージェント）をプログラムで管理するためのエンドポイントを提供します。

このガイドでは、その手順を説明する：

どのような前提条件を満たさなければならないか。
ブランドマネジメントのエンドポイント：何をするのか、どのようなデータが必要なのか。
エージェント管理のエンドポイント：何をするのか、どのようなデータが必要なのか。
オンボーディングのワークフロー：ステップ、ステータスの遷移。

前提条件

APIエンドポイントを使い始める前に、以下のことを確認してください：

Vonage APIアカウントをお持ちです。
ブランド管理APIおよびエージェント管理APIを呼び出す権限があります。
ブランド名、ロゴ、バナー画像、ウェブサイト、プライバシーポリシー、利用規約、Eメール/表示情報など、必要なブランド/エージェントのメタデータをすべて収集しました。
対象地域（例：米国）における検証要件を理解している。

主要APIコンポーネント

主体は2つある：

ブランド：あなたの組織（会社、ブランド・アイデンティティ）を表します。
エージェント：メッセージ送信時にブランドのアイデンティティを表す（名前、ロゴ、色など）。

ブランド・マネジメントのエンドポイント

これらのエンドポイントは、ブランドエンティティの作成または更新に使用されます。

オペレーション	HTTPメソッドとパス	目的
ブランド一覧	[GET］ `https://api.nexmo.com/v1/channel-manager/rcs/brands`	アカウントに登録されているすべてのブランドを表示します。
ブランドの創造	[POST］ `https://api.nexmo.com/v1/channel-manager/rcs/brands`	新しいブランドを作る。
更新ブランド	`PATCH` `https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id`	ブランド名を変更する。
ブランド削除	削除 `https://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id`	既存のRCSブランドを削除する。

エージェント管理エンドポイント

これらのエンドポイントは、ブランドの下にAgentを作成するために使用されます。Agentは、ブランドとしてRCSを送信するために必要なものです。

オペレーション	HTTPメソッドとパス	目的
エージェント一覧	[GET］ `https://api.nexmo.com/v1/channel-manager/rcs/agents`	あなたのアカウントまたはブランドの下にあるすべてのエージェントをアカウントします。
エージェントの作成	[POST］ `https://api.nexmo.com/v1/channel-manager/rcs/agents`	ブランディング資産（ロゴ、バナー）、ディスプレイ情報、電話番号、説明などの提供を含む、指定されたブランドのエージェントを登録します。
エージェントを取得する	[GET］ `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id`	エージェントのメタデータ、ステータス、関連ブランドなどを取得します。
更新エージェント	[プット］ `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id`	エージェントのメタデータ、画像、おそらく電話番号、説明を変更します。フィールドによっては、確認後にロックされる場合があります。
部分更新エージェント	`PATCH` `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id`	既存のRCSエージェントを部分的に更新する。
キャリア	[GET］ `https://api.nexmo.com/v1/channel-manager/rcs/metadata/carriers`	キャリアのリストを取得する。
代理店にキャリアを追加	[POST］ `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/carriers`	既存のRCSエージェントにキャリアを追加する。
テストデバイスをエージェントに追加する	[POST］ `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices`	既存のRCSエージェントにテストデバイスを追加する。
エージェントからテストデバイスを削除する	削除 `https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id`	既存のRCSエージェントからテストデバイスを削除します。

オンボーディング・ワークフロー

これは、ブランドとエージェントのエンドポイントをまとめるための典型的なオンボーディングフローです：

ブランドの創造

でブランドを作ることから始める。 POST /v1/channel-manager/rcs/brands エンドポイントを使用します。このリクエストでは、ブランド名を登録する。ブランドが作成されると、APIは brand_id 以降のすべてのステップで参照する必要がある。

エージェントの作成

ブランドが存在する場合、エージェントを作成するには POST /v1/channel-manager/rcs/agents エンドポイント。エージェントは、あなたのブランドを代表してRCSメッセージを配信する顧客向けプロファイルを表します。このリクエストでは brand_id を、エージェントの表示名、説明、画像、および連絡先の詳細とともに返します。APIは agent_idこれはエージェントに対するすべての操作の識別子となる。

Numbersの追加

を使用してテスト番号を追加する。 POST https://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices エンドポイントです。これらのNumbersによって、本番前にエージェントの体験をテストすることができる。

ローンチエージェント

エージェントを起動するには PUT /v1/channel-manager/rcs/agents/:agent_id または PATCH /v1/channel-manager/rcs/agents/:agent_id そして関連情報を提供することである。

注意: エージェントを編集できるのは、エージェントが起動するまでです。起動後は、アカウントマネージャまたはVonageサポートまでご連絡ください。

キャリアの選択

を呼び出して、エージェントをホストするキャリアを選択する。 POST /v1/channel-manager/rcs/agents/{agentId}/carriers エンドポイントを指定します。このリクエストでは、エージェントを起動させたいキャリア ID のリストを指定します。キャリア設定は GET /v1/channel-manager/rcs/carriers.

キャリアとGoogleがエージェントを承認しても、すぐに本番環境で利用できるようになるわけではありません。その代わりに、Googleのオペレーションチームによる内部レビューにリクエストを提出し、キャリアと協力してローンチを完了します。このプロセスには通常4-8週間かかり、その後、Messages APIの送信者としてエージェントを使用し、顧客にRCSメッセージを配信できるようになります。

継続的メンテナンス

一部のメタデータ（ロゴ、説明文）の更新が必要な場合は、検証後に編集可能なフィールドを確認するか、Account Managerにお問い合わせください。ロックされている場合もあります。

エージェントのステータス

ステータス	説明
DRAFT	エージェント情報が送信された後、バックエンドプロセスが開始されるまでの一時的なステータスです。この段階ではエージェント記録は不完全です。
CREATED	エージェントの記録は完全で、システムに安全に保存されます。
PENDING	エージェントは検証のために提出された。キャリアとグーグルがブランドを審査中です。すべてのチェックに合格するまで、エージェントはローンチできません。
REJECTED	エージェントは検証プロセスに失敗し、起動できません。
LAUNCHED	このエージェントは、すべての検証チェックに合格し、通信事業者とGoogleから承認を受けました。このエージェントは現在アクティブで、RCS会話用のMessages APIで送信者として使用できます。

さらに読む

RCSエージェントビルダーガイド
 チャネルマネージャAPIリファレンス