VonageのVerify APIで柔軟なWorkflowsを使ってみる

この記事はVonageのVerifyAPIの柔軟なWorkflowsを使い方を説明します

概要説明

Vonage Verify APIは、ユーザーがPINコードを送信して入力を求めることにより、ユーザーが正確で有効な電話番号を入力したことを確認できるように設計されています。

デフォルトでは、これは最初にPINコードを含むSMSを送信しますが、SMSで二要素認証が完了しない場合は続いてPINを含む音声メッセージを含む電話に移行します。電話については二要素認証が完了しない場合は、最大2回実施されます。

これらのWorkflowsによるマルチステップが実装されいる事で、ユーザーの電話番号での二要素認証の成功率が大幅に向上します。しかしながら、、これが全てのユーザーにとって最適のワークフローではないケースがある事から柔軟なWorkflowsが実装されました。

ワークフローを制御

ワークフローは、APPの設計やビジネスユースケースにより「適切な」ワークフローが異なる場合があります。そのため、Verify APIでは、API呼び出しを行うときにworkflow_idを指定できるようになりました。指定可能なワークフローパターンは５種類あり、いずれからも選択できるようになりました。

追加のパラメーターが既存のパラメーターと一緒に追加されるため、API呼び出しは次のようになります（Node.js記述）

nexmo.verify.request({

  number: RECIPIENT_NUMBER,
  brand: BRAND_NAME,
  workflow_id: WORKFLOW_ID
}, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    const verifyRequestId = result.request_id;
    console.log('request_id', verifyRequestId);
  }
});

このコードスニペットは、Vonage開発者ポータルで他の言語でも見つけることができます。

WorkFlowsの指定方法

Workflow_idには、1〜5の任意の整数を指定できます。これらの数値が表すワークフローは、次のとおりです。

Workflow 1 (Default Workflow): SMS -> TTS -> TTS

こちらはデフォルトの動作となり、SMSによるテキストメッセージでPINコードを送信し、リクエストがまだ認証されない場合は、2回の後続の音声通話でフォローアップされます。広く一般的に利用されているワークフローとなる事から、Workflows選択に困った場合はこちらをお勧めします。

Workflow 2: SMS -> SMS -> TTS

テキストメッセージで1回目及び2回目にPINコードを送信し、リクエストが認証されない場合は最後に音声通話を送信します。 SMSでの対応がが音声通話よりも望ましい地域やユーザー向けのワークフローとなります。

Workflow 3: TTS -> TTS

1回目および2回目ともユーザーに電話してPINコードを音声で伝え認証を促すワークフローとなります。SMSが届き難い等の理由から電話での対応が最適である場合に最適なワークフローとなります。

Workflow 4: SMS -> SMS

1回目および2回目ともユーザーにテキストメッセージでPINコードを送信し認証を促すワークフローです。電話が苦手なミレニアル世代等を多くにユーザーを持つサービスには最適なワークフローです。

Workflow 5: SMS -> TTS

Workflow　1のデフォルトワークフローと同じですが、電話での認証は1回PINコードを送信し認証を促します。テキストとスピーチの両方を提供しますが、それぞれを1回だけ試行するだけなので2回の電話が煩わしい場合に最適なワークフローです。

参照記事

上記の内容について不明な点がありましたら、以下までご連絡下さい。

連絡先

Vonage Japan合同会社
Mail: [e-mail]
URL: https://www.vonagebusiness.jp/communications-apis/