API Docs for: 1.4.7
Show:

CalloutVerification Class

Defined in: src/SDK/FlashCallVerification.js:2
Module: SinchInternal

Provides Verification using Callout.

Note: Do not instantiate Verification, rather use the createCalloutVerification() method in SinchClient. See the example below.

Constructor

CalloutVerification

(
  • sinch
  • number
  • [custom]
)

Defined in src/SDK/FlashCallVerification.js:2

Parameters:

  • sinch SinchClient

    The parent object

  • number String

    The phone number to verify

  • [custom] String optional

    Custom string to pass to your backend through callback. Useful for identifying user session, or similar. Max size is 4 kbyte.

Example:

// Get verificationClient from sinchClient
var sinchClient = new SinchClient(...);
var verification = sinchClient.createCalloutVerification('+46123456789'); // Verification to telephone +46123456789

// Initiate verification, using promises 
verification.initiate().then(function() {
    // Handle successful verification
}).fail(function(error) {
    // Handle failed verification   
});

Item Index

Methods

Methods

initiate

(
  • success
  • fail
)
chainable

Defined in src/SDK/CalloutVerification.js:42

Initiate verification by callout to the phone number provided earlier. Returns promise which is resolved when verified or failed.

Parameters:

  • success Function

    Optional success callback, method also returns a promise for chaining

  • fail Function

    Optional fail callback, method also returns a promise for chaining

Returns:

promise Promise which resolves when verified, fail resolves with VerificationError

Example:

To be written..

initiate

(
  • success
  • fail
)
chainable

Defined in src/SDK/FlashCallVerification.js:42

Initiate verification by callout to the phone number provided earlier. Returns promise which is resolved when verified or failed.

Parameters:

  • success Function

    Optional success callback, method also returns a promise for chaining

  • fail Function

    Optional fail callback, method also returns a promise for chaining

Returns:

promise Promise which resolves when verified, fail resolves with VerificationError

Example:

To be written..

verify

(
  • code
  • success
  • fail
)
chainable

Defined in src/SDK/FlashCallVerification.js:98

Verify a code retrieved over a secondary channel. Pass in code, success and fail callbacks, or rely on promises.

Note: The code for a particular verification session can only attempt verification at most five times.

Parameters:

  • code String

    Mandatory code to verify, this code should have been retrieved from the user (who got it through SMS)

  • success Function

    Optional success callback, method also returns a promise for chaining

  • fail Function

    Optional fail callback, method also returns a promise for chaining

Returns:

promise Promise which resolves when verified, fail resolves with VerificationError

Example:

//Get verificationClient from sinchClient
var sinchClient = new SinchClient(...);
var verification = sinchClient.createSmsVerification(+46123456789); // Verification to telephone +46123456789

//Send a verification code 
verification.initiate().then(function() {
    //Ask user to enter secret CODE
}).fail(function(error) {
    //Infom user of error sending SMS (more info in error.message)
});

//Verification of code
verification.verify(CODE).then(function() {
    //Perform action on successful verification
}).fail(function(error) {
    //Perform action on unsuccessful verification
});