Skip to main content
The official Java SDK repository includes standalone Maven projects that mirror the flows documented in this guide.

​
GitHub repository

All examples live in the examples/ folder: github.com/VZaps/vzaps-sdk-java Each numbered folder is a standalone Maven project with an explicit com.vzaps:vzaps-sdk dependency. No parent project is required when you copy one folder elsewhere. See examples/README.md in the repository for prerequisites and the full module list.

​
What’s included

ModuleTopic
01-auth-and-list-instancesAuth and instance listing
02-create-instanceCreate instance
03-instance-subscriptionBilling subscription
04-session-and-pairingSession status, QR, and pairing code
05-configure-webhookWebhook configuration
06-realtime-subscribeRealtime WebSocket subscription
07-send-text-messageSend text message
08-send-media-and-interactiveMedia, buttons, and list
09-send-poll-reaction-and-chat-actionsPoll, reaction, and chat actions
10-queuesMessage and operation queues
11-typebot-and-chatwootTypeBot and Chatwoot
quickstartMinimal list + send text flow
worker-realtimeRealtime worker with deduplication
You do not need to clone the full SDK repository.
  1. Download only the example folder, for example 07-send-text-message, using Download ZIP on GitHub, or run:
npx --yes degit VZaps/vzaps-sdk-java/examples/07-send-text-message vzaps-java-send-text
cd vzaps-java-send-text
  1. Set credentials and run:
export VZAPS_CLIENT_TOKEN=your-client-token
export VZAPS_CLIENT_SECRET=your-client-secret
export VZAPS_INSTANCE_ID=VZ...
export VZAPS_INSTANCE_TOKEN=your-instance-token
mvn compile exec:java

​
Option B — sparse checkout

git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-java.git
cd vzaps-sdk-java
git sparse-checkout set examples/07-send-text-message
cd examples/07-send-text-message
mvn compile exec:java

​
Option C — full repository clone

git clone https://github.com/VZaps/vzaps-sdk-java.git
cd vzaps-sdk-java/examples/07-send-text-message
mvn compile exec:java

​
Next steps