Skip to main content
The official Java SDK for the Vobiz Voice API. Make calls, manage SIP trunks, handle CDR, record calls, configure phone numbers, and more - natively from your Java or JVM backend, with a fully typed builder API. Source code: vobiz-ai/Vobiz-Java-SDK

Installation

The SDK is distributed from its GitHub repo (not Maven Central). Clone it and install it into your local Maven repository, then depend on ai.vobiz:vobiz-java. You need JDK 17 or later to build it. The compiled library runs on Java 8 and later.
Or include the cloned project as a module / built jar directly.

Authentication

All API calls require your Auth ID and Auth Token, available in the Vobiz Console. Pass your Auth ID to .apiKey() and your Auth Token to .authToken() - the SDK sends them as the X-Auth-ID and X-Auth-Token headers.

Quick start

Make an outbound call:

VobizXML

When a call is answered, Vobiz fetches VobizXML from your answerUrl webhook to control the call. The SDK ships a typed builder in the com.vobiz.api.vobizxml package so you can construct documents fluently instead of concatenating strings - each add* method returns the created child for nesting, and .attr(...) sets attributes in order:
This produces:
Return the serialized string from your webhook handler with Content-Type: application/xml. The builder covers all VobizXML verbs - addSpeak, addPlay, addWait, addGather (plus addGetDigits / addGetInput aliases), addDial (with addNumber / addUser / addRecord), addRecord, addConference, addDtmf, addRedirect, addHangup, addPreAnswer, and addStream - and handles XML escaping, booleans (true/false), and raw SSML passthrough via addSpeak().ssml("...").

Messaging (SMS, MMS and RCS)

The Java SDK includes the full Vobiz Messaging API under client.sms. Send a message with the client you created above:
Every Messaging operation has a matching method, for example client.sms().messages().previewMessageCost and client.sms().numbers().listNumbers. See Messaging in the SDKs for the full method list and error handling; each Messaging API reference page shows a complete Java example.

Resources