Introducing Our New Client Library for Android and iOS

We are excited to announce our Client Library for Android and iOS, a new SDK designed from scratch that allows developers to bypass WiFi and ensure specific API calls are sent exclusively over mobile networks. This Client Library replaces the Verify Silent Auth and Number Verification SDKs, which will no longer receive updates.

Why this Matters

Some Network APIs, such as Number Verification API or Verify API with Silent Authentication, only work over mobile networks. This is because mobile operators rely on network traffic data to verify users.

The new Client Library forces API GET requests to be sent via the cellular network without manually switching off WiFi connectivity on user devices.

How it Works

Integrating the Vonage Client Libary into your mobile application is simple. With just a few lines of code, developers can send their API requests through the mobile network, bypassing WiFi when necessary.

Let’s see it in action!

Android

To use the Client Library, add the following dependency to your build.gradle file:

implementation 'com.vonage:client-library:1.0.0'

Import the required packages and initialize the library before making API calls:

import com.vonage.clientlibrary.VGCellularRequestClient
import com.vonage.clientlibrary.VGCellularRequestParameters

VGCellularRequestClient.initializeSdk(this.applicationContext)

Create a VGCellularRequestClientParameters object with the necessary parameters:

val params = VGCellularRequestClientParameters(
    url = "http://www.vonage.com",
    headers = mapOf("x-my-header" to "My Value") ,
    queryParameters = mapOf("query-param" to "value"),
    maxRedirectCount = 10
)

Where:

• URL: corresponds with an API endpoint.

• Headers: a map of strings with the HTTP headers you want to include in your request.

• queryParameters: a map of strings (key-value pairs) with the query parameters to be included in our GET request.

• maxRedirectCount: optional and defaults to 10. This parameter sets the number of allowed redirects. TBC

Finally, call the startCellularGetRequest method to send the request over the mobile network:

val response = VGCellularRequestClient.getInstance().startCellularGetRequest(params)

The method supports a second boolean parameter to debug API calls. This parameter defaults to false, but it can be enabled as follows:

val response = 
VGCellularRequestClient.getInstance().startCellularGetRequest(params, true)

iOS

Similar to Android, add the Client Library as a dependency in your project:

let package = Package(
    dependencies: [
        .Package(url: "https://github.com/Vonage/vonage-ios-client-library.git")
    ]
)

You can also install the library via Cocoapods, using the pod VonageClientLibrary.

Import and initialize the library:

import VonageClientLibrary

let client = VGCellularRequestClient()



Create a VGCellularRequestClientParameters object with the necessary parameters:
let params = VGCellularRequestParameters(url: "http://www.vonage.com",
                                headers: ["x-my-header": "My Value"],
                                queryParameters: ["query-param" : "value"]
                                maxRedirectCount: 10)

Use the startCellularGetRequest method to send the request over the mobile network. The second parameter debug is optional and sets the debug flag (defaults to false):

let response = try await client.startCellularRequest(params: params, debug: true)

Responses

When a response is received from the URL endpoint, the startCellularGetRequest method returns an object containing the following properties:

{
    "http_status": string, // HTTP status code of the URL response
    "response_body" : {    // Optional, depending on the HTTP status
        ...                // The response body of the requested url
    },
    "debug" : {            // Present if the debug flag is set to true
        "device_info": string, 
        "url_trace" : string
    }
}

If there is no connectivity or there is an internal error in the Client Library, the response object includes the following properties:

{
    "error" : string,             // Error code
    "error_description": string,  // Error description
    "debug" : {                   // Present if debug flag is set to true
        "device_info": string, 
        "url_trace" : string
    }
}