> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exemplos

> Exemplos executáveis do SDK PHP da VZaps no GitHub

O repositório oficial do SDK PHP inclui projetos Composer executáveis que espelham os fluxos documentados neste guia.

## Repositório no GitHub

Todos os exemplos ficam na pasta [`examples/`](https://github.com/VZaps/vzaps-sdk-php/tree/main/examples):

**[github.com/VZaps/vzaps-sdk-php](https://github.com/VZaps/vzaps-sdk-php)**

Cada pasta numerada é um projeto independente com `composer.json`, `config.example.php` e `run.php`.

Veja o [`examples/README.md`](https://github.com/VZaps/vzaps-sdk-php/blob/main/examples/README.md) no repositório para a lista completa de módulos.

## O que está incluído

| Pasta                                    | Tema                                        |
| ---------------------------------------- | ------------------------------------------- |
| `01-auth-and-list-instances`             | Autenticação e listagem de instâncias       |
| `02-create-instance`                     | Criar instância                             |
| `03-instance-subscription`               | Assinatura e billing                        |
| `04-session-and-pairing`                 | Status da sessão, QR e código de pareamento |
| `05-configure-webhook`                   | Configuração de webhook                     |
| `06-realtime-subscribe`                  | Assinatura realtime via WebSocket           |
| `07-send-text-message`                   | Enviar mensagem de texto                    |
| `08-send-media-and-interactive`          | Mídia, botões e lista                       |
| `09-send-poll-reaction-and-chat-actions` | Enquete, reação e ações de chat             |
| `10-queues`                              | Filas de mensagens e operações              |
| `11-typebot-and-chatwoot`                | TypeBot e Chatwoot                          |
| `quickstart`                             | Fluxo mínimo de listagem + envio de texto   |
| `worker-realtime`                        | Worker realtime com deduplicação            |

## Opção A — uma pasta de exemplo (recomendado)

Você **não** precisa clonar o repositório inteiro do SDK.

1. Baixe apenas a pasta do exemplo, por exemplo [`07-send-text-message`](https://github.com/VZaps/vzaps-sdk-php/tree/main/examples/07-send-text-message), com **Download ZIP** no GitHub, ou execute:

```bash theme={null}
npx --yes degit VZaps/vzaps-sdk-php/examples/07-send-text-message vzaps-php-send-text
cd vzaps-php-send-text
```

2. Configure e execute:

```bash theme={null}
cp config.example.php config.php
composer install
php run.php
```

Edite `config.php` com `clientToken`, `clientSecret`, `instanceId` e `instanceToken` antes de executar.

## Opção B — sparse checkout

Baixe só parte do repositório com Git:

```bash theme={null}
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
```

## Opção C — clone completo do repositório

Use quando quiser todos os exemplos localmente ou estiver contribuindo no SDK:

```bash theme={null}
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
```

## Próximos passos

* Siga o [Guia inicial](/pt-BR/sdk/php/starter-guide) para um passo a passo completo.
* Veja [Mensagens](/pt-BR/sdk/php/messages) para todos os tipos de envio.