Skip to main content
The official PHP SDK repository includes runnable Composer projects that mirror the flows documented in this guide.

​
GitHub repository

All examples live in the examples/ folder: github.com/VZaps/vzaps-sdk-php Each numbered folder is a standalone project with its own composer.json, config.example.php, and run.php. See examples/README.md in the repository for the full module list.

​
What’s included

FolderTopic
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-php/examples/07-send-text-message vzaps-php-send-text
cd vzaps-php-send-text
  1. Configure and run:
cp config.example.php config.php
composer install
php run.php
Edit config.php with your clientToken, clientSecret, instanceId, and instanceToken before running.

​
Option B — sparse checkout

Download only part of the repository with Git: 
git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-php.git
cd vzaps-sdk-php
git sparse-checkout set examples/07-send-text-message
cd examples/07-send-text-message
cp config.example.php config.php
composer install
php run.php

​
Option C — full repository clone

Use this when you want every example locally or you are contributing to the SDK: 
git clone https://github.com/VZaps/vzaps-sdk-php.git
cd vzaps-sdk-php/examples/07-send-text-message
cp config.example.php config.php
composer install
php run.php

​
Next steps