技術パートナー向けWhatsAppホスティング埋め込みサインアップフロー

WhatsApp Hosted Embedded Sign-up Flow はホワイトラベルのオンボーディングUIです。Vonageパートナーは独自のエンベデッドサインアップフローを作成、設定、ホストすることなく、クライアントにWhatsAppビジネスアカウントを提供することができます。

前提条件

組み込みサインアップソリューションを活用するためには、Vonageパートナーは以下の前提条件を満たす必要があります：

• 技術プロバイダーとしてMetaに登録
• アプリダッシュボードでメタアプリをライブ表示させる
• WABAまたはWhatsApp番号を登録するビジネスポートフォリオの「フルコントロール」または「管理者」権限があること
• Vonageにソリューションリクエストを提出し、リクエストが受理され、ソリューションIDが提供されたこと。

上記の前提条件についてご質問がある場合、またはサポートが必要な場合は、Vonage Account Managerまでお問い合わせください。

プロセスの流れ

WhatsApp Hosted Embeddedサインアップの流れは以下の通りです：

1. Vonageパートナーは、埋め込みサインアップURLを生成します。
2. パートナーは、URLを顧客と共有することができます（例えば、電子メールやSMSを介して、または自社のWebページにURLを埋め込むことによって）。
3. このURLは、WhatsAppビジネスアカウント(WABA)またはWhatsApp番号のオンボーディング登録が完了する、Vonageがホストするホワイトラベルのエンベデッドサインアップフローに顧客を誘導します。
4. 顧客は、組み込まれたサインアップフローを使用してオンボーディングプロセスを完了します。

埋め込みサインアップURLの生成

埋め込みサインアップURLは、次のようなPOSTリクエストで生成できます。 ホストされたESフローのURLエンドポイントを生成する の チャネルマネージャAPI.

認証はBasic AuthまたはBearer Token (JWT) Authで行うことができる。

リクエストボディには、JSONオブジェクトが含まれていなければなりません。 solution_id プロパティがあり、その値は Vonage が提供するソリューション ID です ( 前提条件).

ボディには api_key プロパティを使用して、パートナーが URL の作成を希望する顧客の Vonage サブアカウントを特定します (このプロパティが省略された場合、プライマリ Vonage アカウントのメイン API キーが使用されます)。

A ttl プロパティを指定して、生成されたURLの有効期限を設定することもできる (最大3日間省略した場合、デフォルトの有効期限である86400秒（1日）が使用される）。

リクエスト・ボディの例

{
  "solution_id": "123456789111213",
  "api_key": "abc123", // Optional
  "ttl": 3600 // Optional
}

レスポンス・ボディの例

成功したレスポンスには、HTTPステータスコードとして 200 そして、生成された埋め込みサインアップURLとリクエストのトレースIDを含むJSONオブジェクトのレスポンスボディを含む。

{
  "id": "3amb0119-0196-42d1-8fb5-55a98s133546",
  "url": "https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8Ds"
}

WhatsApp電話認証番号ステータスの確認

WhatsApp番号登録手続きの一環として、番号確認のためのワンタイムパスワード(OTP)が登録番号に送信されます。番号認証が完了すると、その番号をご利用いただけます。

番号照合状況は、以下の方法で確認できる：

• Numbersのステータスを手動で確認する
• Numbersの最新情報を購読する

Numbersのステータスを手動で確認する

手動で電話番号のステータスを確認するには、WhatsApp マネージャーのインターフェースをご利用ください。有効な電話番号には「ステータス」が表示されます。 接続済み.

Numbersの最新情報を購読する

Numbersの検証ステータスの変更に関する最新情報を購読するには、以下を使用します。 WhatsApp 通知購読.

サブスクリプションは様々なイベントに対して作成することができます。 WhatsApp 通知購読ガイド ドキュメント.Numbersのステータスアップデートを利用するには、次のようにサブスクリプションを作成する必要があります。 account_update サブスクリプション・タイプを whatsapp_subscribe_typesまた vonage_number_onboarded サブスクリプション・タイプを vonage_subscribe_types.

この通知は PARTNER_ADDED イベントが発生し、サブスクリプション作成時に指定したウェブフックまたはSlackフックに送信されます。通知のペイロードには waba_id, solution_idそして owner_business_id 詳細はこちら。

のペイロードは POST にリクエストする。 https://api.nexmo.com/v2/whatsapp-manager/subscriptions エンドポイントは次のようになる：

{
  "type": "webhook",
  "label": "#dk-test",
  "whatsapp_subscribe_types": "account_update", // or can be left blank ""
  "vonage_subscribe_types": "vonage_number_onboarded",
  "webhook": {
      "url" : "https://eo34s4y0tl.m.pipedream.net"
  }
}

WhatsApp番号とVonageアプリケーションのリンク

WhatsApp 番号を Vonage Messages API 経由でのメッセージ送信に使用するには、Vonage アプリケーションにリンクする必要があります。

これは Vonageダッシュボード または アカウントエンドポイントにアプリケーションをリンクする の 外部アカウントAPI.

パートナーへの注意事項

• Vonageパートナー/技術プロバイダーがHosted Embedded Signup Flowを使用するために、別途有効化する必要はありません。メイン api-key および関連クレデンシャル。
• 共有WhatsAppビジネスアカウント(WABA)に限り、埋め込みサインアップフローまたは埋め込みサインアップフローで新規WhatsApp番号を登録できます。OBO WABA の場合、手動オンボーディングが必要です。詳しくは メタ・ドキュメンテーション OBOとシェアードWABAの詳細はこちら。
• Vonageパートナー/技術プロバイダーは、ホスティングされた組み込みフローを使用するクライアントが、ビジネスポートフォリオ情報セクションにビジネス詳細を記入し、完了していることを確認する必要があります。必要な詳細、例えばユーザーのビジネスEメールが無効な場合、オンボーディング・プロセスは失敗する可能性があります。
• WhatsApp番号登録の際、Meta APIからの応答時間は最大120秒かかります。
• WhatsApp番号の登録/解除はMetaにより制限されています(1週間につき1番号につき10回まで)。制限回数に達すると、その番号は登録がブロックされます。