Package com.vonage.client

Class VonageClient

java.lang.Object

com.vonage.client.VonageClient

public class VonageClient
extends Object

Top-level Vonage API client object.

Construct an instance of this object with one or more AuthMethods (providing all the authentication methods for the APIs you wish to use), and then call getVoiceClient() to obtain a client for the Vonage Voice API.

.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VonageClient.Builder	Builder for specifying the properties of the client.

Method Summary

Modifier and Type	Method	Description
static VonageClient.Builder	builder()	Entry point for constructing an instance of this class.
String	generateJwt()	Generate a JWT for the application the client has been configured with.
AccountClient	getAccountClient()	Returns the Account API client.
ApplicationClient	getApplicationClient()	Returns the Application API client.
ConversationsClient	getConversationsClient()	Returns the Conversations v1 client.
ConversionClient	getConversionClient()	Returns the Conversion API client.
InsightClient	getInsightClient()	Returns the Number Insight API client.
MeetingsClient	getMeetingsClient()	Deprecated. Support for this API will be removed in the next major release.
MessagesClient	getMessagesClient()	Returns the Messages v1 API client.
NumberInsight2Client	getNumberInsight2Client()	Returns the Fraud Detection API client.
NumbersClient	getNumbersClient()	Returns the Numbers API client.
NumberVerificationClient	getNumberVerificationClient()	Returns the CAMARA Number Verification API client.
ProactiveConnectClient	getProactiveConnectClient()	Deprecated. This API is sunset and will be removed in the next major release.
RedactClient	getRedactClient()	Returns the Redact API client.
SimSwapClient	getSimSwapClient()	Returns the CAMARA SIM Swap API client.
SmsClient	getSmsClient()	Returns the SMS API client.
SubaccountsClient	getSubaccountsClient()	Returns the Subaccounts API client.
UsersClient	getUsersClient()	Returns the Users API client.
Verify2Client	getVerify2Client()	Returns the Verify v2 API client.
VerifyClient	getVerifyClient()	Returns the Verify v1 API client.
VideoClient	getVideoClient()	Returns the Video API client.
VoiceClient	getVoiceClient()	Returns the Voice API client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAccountClient

public AccountClient getAccountClient()

Returns the Account API client.

Returns:

The AccountClient.

getApplicationClient

public ApplicationClient getApplicationClient()

Returns the Application API client.

Returns:

The ApplicationClient.

getInsightClient

public InsightClient getInsightClient()

Returns the Number Insight API client.

Returns:

The InsightClient.

getNumbersClient

public NumbersClient getNumbersClient()

Returns the Numbers API client.

Returns:

The NumbersClient.

getSmsClient

public SmsClient getSmsClient()

Returns the SMS API client.

Returns:

The SmsClient.

getVerifyClient

public VerifyClient getVerifyClient()

Returns the Verify v1 API client.

Returns:

The VerifyClient.

getVoiceClient

public VoiceClient getVoiceClient()

Returns the Voice API client.

Returns:

The VoiceClient.

getConversionClient

public ConversionClient getConversionClient()

Returns the Conversion API client.

Returns:

The ConversionClient.

getRedactClient

public RedactClient getRedactClient()

Returns the Redact API client.

Returns:

The RedactClient.

getMessagesClient

public MessagesClient getMessagesClient()

Returns the Messages v1 API client.

Returns:

The MessagesClient.

Since:

6.5.0

getProactiveConnectClient

@Deprecated
public ProactiveConnectClient getProactiveConnectClient()

Deprecated.

This API is sunset and will be removed in the next major release.

Returns the Proactive Connect API client.

Returns:

The ProactiveConnectClient.

Since:

7.6.0

getMeetingsClient

@Deprecated
public MeetingsClient getMeetingsClient()

Deprecated.

Support for this API will be removed in the next major release.

Returns the Meetings API client.

Returns:

The MeetingsClient.

Since:

7.6.0

getVerify2Client

public Verify2Client getVerify2Client()

Returns the Verify v2 API client.

Returns:

The Verify2Client.

Since:

7.4.0

getSubaccountsClient

public SubaccountsClient getSubaccountsClient()

Returns the Subaccounts API client.

Returns:

The SubaccountsClient.

Since:

7.5.0

getUsersClient

public UsersClient getUsersClient()

Returns the Users API client.

Returns:

The UsersClient.

Since:

7.7.0

getVideoClient

public VideoClient getVideoClient()

Returns the Video API client.

Returns:

The VideoClient.

Since:

8.0.0-beta1

getNumberInsight2Client

public NumberInsight2Client getNumberInsight2Client()

Returns the Fraud Detection API client.

Returns:

The NumberInsight2Client.

Since:

8.2.0

getConversationsClient

public ConversationsClient getConversationsClient()

Returns the Conversations v1 client.

Returns:

The Conversation client.

Since:

8.4.0

getSimSwapClient

public SimSwapClient getSimSwapClient()

Returns the CAMARA SIM Swap API client.

Returns:

The SimSwapClient.

Since:

8.8.0

getNumberVerificationClient

public NumberVerificationClient getNumberVerificationClient()

Returns the CAMARA Number Verification API client.

Returns:

The NumberVerificationClient.

Since:

8.9.0

generateJwt

public String generateJwt()
                   throws VonageUnacceptableAuthException

Generate a JWT for the application the client has been configured with.

Returns:

A String containing the token data.

Throws:

VonageUnacceptableAuthException - if no JWTAuthMethod is available

builder

public static VonageClient.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder with default initial configuration.