メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Android用Twilio Verification SDK - SDKリファレンス

クイックスタートや手順を追ったガイドについては、Android用Twilio Verification SDK - 統合ガイドを参照してください。

技術情報

Downloadable via jCenter. 
Weight: 26KB (v1.0.0)
Method count: 218 methods.

Dependencies: retrofit2, gson, okhttp3.

電話番号の検証プロセスを開始するには、下記を呼び出します:

TwilioVerificationインスタンス

public void startVerification(String jwtToken, Via via);

Via.SMSを使用することに決めた場合、SDKは自動的にデバイス内のSMSの受信ボックスを調べ流ので、エンドユーザーを煩わせることなく処理を続けることができます。

それ以外の場合は、フォールバックとしてVia.CALLを使用できます。 この方法ではTwilioからの通話が発信され、音声でエンドユーザーにコードが配信されます。 JWTのペイロード内でlocaleパラメーターが使用されなかった場合、言語はAPIによって類推されます。

処理を完了するにはエンドユーザーは手動でApp内でコードを入力することが必要であり、それからAppはcheckVerificationPin()を呼び出すことが必要です。

public void checkVerificationPin(String pin);

BroadcastReceiverがインテントを受信したら、検証ステータスはgetVerificationStatusで展開されます。 結果はVerificationStatusオブジェクトとなります。

public static VerificationStatus getVerificationStatus(Intent verificationIntent);

VerificationStatus.java

VerificationStatus オブジェクト: 以下の3つのメソッドを含むレスポンスホルダーです:

public State getState();

下記の値を取りうるState enumを返します: [ STARTED | AWAITING_VERIFICATION | SUCCESS | ERROR ]

  • STARTED: 検証の開始が呼び出されましたが、SMSはまだ届いていません。
  • AWAITING_VERIFICATION: SMSが到着し、確認の呼び出しを待機しています
  • SUCCESS: 暗証番号が検証されました。 検証トークンはgetVerificationToken()メソッドを通じたVerificationStatusオブジェクト経由で利用できます。
  • ERROR: 検証時にエラーが発生しました。 例外はgetVerificationException()を通じて回復できます
public String getVerificationToken();

検証トークンは下記の構造になっています

{
    valid: <true|false>,
    iat: <timestamp>,
    exp: <timestamp>,
    verification: {
        uuid: <PV-uuid>,
        via: <sms|call>,
        phone_number:  <phonenumber>,
        code_length: <4-10>
  }
}

検証が成功したことを証明する検証トークンを返します。 バックエンドは後々このトークンをAUTHY_API_KEYで復号化し、これを検証できます。

public VerificationException getVerificationException();

このプロパティーは失敗時に検証の例外を保持しています。

Rate this page:

ヘルプが必要ですか?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.