---
title: "SDK PHP — WAME API Documentação"
description: "Documentação completa do SDK PHP para integração com a WAME API. Exemplos de envio de mensagens, botões, grupos, webhooks e mais."
url: "https://api-wa.me/docs/sdk/php"
language: "pt-BR"
og:type: "website"
og:site_name: "WAME API"
---

SDK OFICIAL

# SDK PHP

Documentação completa do SDK PHP para integração com a WAME API. Envie mensagens, gerencie grupos, configure webhooks e muito mais.

[Packagist](https://packagist.org/packages/raphaelvserafim/client-php-api-wa-me)[GitHub](https://github.com/raphaelvserafim/client-php-api-wa-me)

## Instalação

Requisitos: PHP >= 8.1 e ext-curl. Instale via Composer:

$`composer require raphaelvserafim/client-php-api-wa-me`

## Inicialização

Importe e inicialize o client:

php

copiar

```
use Api\Wame\Wame;

require 'vendor/autoload.php';

$wa = new Wame([
    'server' => 'https://server.api-wa.me',
    'key'    => 'YOUR_INSTANCE_KEY',
]);

$to = "559999999999"; // Grupo: "[email protected]"
```

A classe `WhatsApp` continua disponível como alias depreciado de `Wame` (`new WhatsApp([...])` funciona igual), mas prefira `Wame`.

## Gerenciar Instância

Conecte, configure e gerencie sua instância:

php

copiar

```
// Conectar via QR Code
$qr = $wa->instance->connect();

// Conectar via Pairing Code
$code = $wa->instance->connectPairingCode("559999999999");

// Informações da instância
$info = $wa->instance->getInfo();

// Logout, restart e resync
$wa->instance->logout();
$wa->instance->restart();
$wa->instance->resync();
```

#### Configurações

php

copiar

```
$wa->instance->updateSettings(
    markMessageRead: true,
    saveMedia: false,
    receiveStatusMessage: false,
    receivePresence: false,
);
```

#### Perfil

php

copiar

```
$wa->instance->updateProfileName("My Bot");
$wa->instance->updateProfileStatus("Online");
$wa->instance->updateProfilePicture("https://example.com/avatar.jpg");
$wa->instance->removeProfilePicture();
```

#### Proxy e MongoDB

php

copiar

```
$wa->instance->setProxy("http://user:pass@ip:port");
$wa->instance->addMongoDB("mongodb+srv://...", "mydb");
```

#### Conexão Mobile

php

copiar

```
$wa->instance->prepareMobileRegistration("55", "99999999999", "11");
$wa->instance->requestMobileCode("sms");
$wa->instance->verifyMobileCode("123456");
```

## Webhooks

Configure webhooks para receber eventos em tempo real:

php

copiar

```
$wa->instance->updateWebhook([
    'allowWebhook'          => true,
    'allowNumber'           => 'all',
    'webhookFormat'         => 'meta', // payloads no envelope Meta, consumidos por parseMeta()
    'webhookMessage'        => 'https://your-webhook.com/message',
    'webhookGroup'          => '',
    'webhookConnection'     => '',
    'webhookQrCode'         => '',
    'webhookMessageFromMe'  => '',
    'webhookHistory'        => '',
]);

// Estatísticas de webhooks
$stats = $wa->instance->getWebhookStatistics();
```

## Multicanal (Instagram / Messenger)

Além do WhatsApp, o SDK suporta o envio por outros canais (provider). Defina o provider padrão no client ou sobrescreva por chamada:

php

copiar

```
use Api\Wame\Provider;

// Provider padrão para todo o client
$wa = new Wame([
    'server'   => 'https://server.api-wa.me',
    'key'      => 'YOUR_INSTANCE_KEY',
    'provider' => Provider::INSTAGRAM,
]);

// Usa o provider padrão do client (Instagram)
$wa->message->sendText('IG_USER_ID', 'Oi');

// Sobrescreve o provider por chamada (último argumento)
$wa->message->sendText('5511999999999', 'Oi', Provider::WHATSAPP);
```

Constantes disponíveis: `Provider::WHATSAPP` (padrão), `Provider::INSTAGRAM` e `Provider::MESSENGER`. A injeção de provider aplica-se a `sendText`, `sendAudio`, `sendImage`, `sendVideo`, `sendDocument`, `sendButtonAction`/`sendButtonReply` e `sendTemplate`. Quando não definido, o campo é omitido e a API assume `whatsapp`.

## Enviar Texto

Envie mensagens de texto simples:

php

copiar

```
$wa->message->sendText($to, "Hello!");
```

## Enviar Mídia

#### Imagem

php

copiar

```
$wa->message->sendImage($to, "https://example.com/photo.jpg", "Caption");
```

#### Áudio

php

copiar

```
$wa->message->sendAudio($to, "https://example.com/audio.mp3");
```

#### Vídeo

php

copiar

```
$wa->message->sendVideo($to, "https://example.com/video.mp4", "Big Buck Bunny");
```

#### Documento

php

copiar

```
$wa->message->sendDocument($to, "https://example.com/file.pdf", "application/pdf", "Resume.pdf", "Meu documento");
```

#### Sticker

php

copiar

```
$wa->message->sendSticker($to, "https://example.com/sticker.webp");
```

#### Video Note (circular)

php

copiar

```
$wa->message->sendVideoNote($to, "https://example.com/video.mp4");
```

#### Envio via Base64

php

copiar

```
$wa->message->sendBase64Image($to, "data:image/png;base64,...", "Caption");
$wa->message->sendBase64Audio($to, "data:audio/mp3;base64,...");
$wa->message->sendBase64Document($to, "data:application/pdf;base64,...", "application/pdf", "file.pdf", "Meu documento");
```

## Enviar Contato

#### Contato único

php

copiar

```
$wa->message->sendContact($to, "Raphael", "559999999999", "api-wa.me");
```

#### Múltiplos contatos

php

copiar

```
$wa->message->sendContacts($to, "Meus Contatos", [
    ['fullName' => 'Raphael', 'phoneNumber' => '559999999999'],
    ['fullName' => 'João', 'phoneNumber' => '559888888888', 'organization' => 'WAME'],
]);
```

## Enviar Localização

#### Localização fixa

php

copiar

```
$wa->message->sendLocation($to, 37.7749, -122.4194, "San Francisco, CA");
```

#### Localização em tempo real

php

copiar

```
$wa->message->sendLiveLocation($to, 37.7749, -122.4194, "Estou aqui!");
```

## Enviar Link Preview

php

copiar

```
$wa->message->sendLink(
    $to,
    "API WhatsApp",
    "Check out our API",
    "https://example.com/thumb.jpg",
    "https://api-wa.me",
    "Powerful WhatsApp integration"
);
```

## Enviar Reação

php

copiar

```
$wa->message->sendReaction("👍", "MESSAGE_ID");
```

## Responder Mensagem

O SDK PHP tem métodos dedicados para responder mensagens:

php

copiar

```
// Responder com texto
$wa->message->replyText("ORIGINAL_MSG_ID", $to, "This is a reply!");

// Responder com imagem
$wa->message->replyImage("ORIGINAL_MSG_ID", $to, "https://example.com/photo.jpg", "Caption");

// Responder com vídeo
$wa->message->replyVideo("ORIGINAL_MSG_ID", $to, "https://example.com/video.mp4", "Caption");

// Responder com áudio
$wa->message->replyAudio("ORIGINAL_MSG_ID", $to, "https://example.com/audio.mp3");

// Responder com documento
$wa->message->replyDocument("ORIGINAL_MSG_ID", $to, "https://example.com/file.pdf", "application/pdf", "file.pdf", "Caption");

// Responder com contato
$wa->message->replyContact("ORIGINAL_MSG_ID", $to, "Raphael", "559999999999", "api-wa.me");

// Responder com localização
$wa->message->replyLocation("ORIGINAL_MSG_ID", $to, 37.7749, -122.4194, "San Francisco, CA");
```

#### Responder com Botões e Pix

php

copiar

```
// Responder com botões de resposta
$wa->message->replyButtonReply("ORIGINAL_MSG_ID", [
    'to' => $to,
    'header' => ['title' => 'Choose'],
    'text' => 'What do you prefer?',
    'buttons' => [
        ['type' => 'quick_reply', 'id' => '1', 'text' => 'Yes'],
        ['type' => 'quick_reply', 'id' => '2', 'text' => 'No'],
    ],
]);

// Responder com botões de ação
$wa->message->replyButtonAction("ORIGINAL_MSG_ID", [
    'to' => $to,
    'header' => ['title' => 'Actions'],
    'text' => 'Choose an action',
    'buttons' => [
        ['type' => 'cta_url', 'url' => 'https://api-wa.me', 'text' => 'Visit'],
    ],
]);

// Responder com título
$wa->message->replyTitle("ORIGINAL_MSG_ID", $to, "Order #123", "Ready!", "Thanks");

// Responder com Pix
$wa->message->replyPix("ORIGINAL_MSG_ID", [ /* body array */ ]);
```

## Presença (digitando...)

php

copiar

```
$wa->message->sendPresence($to, "composing");
// Opções: unavailable, available, composing, recording, paused
```

## Mensagem com Título

php

copiar

```
$wa->message->sendTitle($to, "Order #123", "Your order is ready", "Thank you!");
```

## Botões de Resposta

Envie mensagens com botões de resposta rápida:

php

copiar

```
$wa->message->sendButtonReply([
    'to' => $to,
    'header' => ['title' => 'Choose an option'],
    'text' => 'What do you prefer?',
    'footer' => 'Select one',
    'buttons' => [
        ['type' => 'quick_reply', 'id' => '1', 'text' => 'Yes'],
        ['type' => 'quick_reply', 'id' => '2', 'text' => 'No'],
    ],
]);
```

#### Com Imagem no Header

php

copiar

```
$wa->message->sendButtonReply([
    'to' => $to,
    'header' => [
        'title' => 'Check this out',
        'hasMediaAttachment' => true,
        'imageMessage' => ['url' => 'https://example.com/photo.jpg'],
    ],
    'text' => 'What do you think?',
    'buttons' => [
        ['type' => 'quick_reply', 'id' => '1', 'text' => 'Like'],
        ['type' => 'quick_reply', 'id' => '2', 'text' => 'Dislike'],
    ],
]);
```

## Botões de Ação (URL, Call, Copy)

Envie botões com ações como abrir URL, ligar ou copiar código:

php

copiar

```
$wa->message->sendButtonAction([
    'to' => $to,
    'header' => ['title' => 'Actions'],
    'text' => 'Choose an action',
    'footer' => 'Select one',
    'buttons' => [
        ['type' => 'cta_url', 'url' => 'https://api-wa.me', 'text' => 'Visit website'],
        ['type' => 'cta_call', 'phone_number' => '+559999999999', 'text' => 'Call us'],
        ['type' => 'cta_copy', 'copy_code' => 'PROMO2025', 'text' => 'Copy code'],
    ],
]);
```

## Lista / Menu

Envie menus interativos com seções e itens:

php

copiar

```
$wa->message->sendList([
    'to' => $to,
    'buttonText' => 'View Menu',
    'text' => 'Choose an item',
    'title' => 'Menu',
    'description' => 'Our products',
    'footer' => 'Prices may vary',
    'sections' => [
        [
            'title' => 'Pizzas',
            'rows' => [
                ['title' => 'Margherita', 'description' => 'Classic cheese pizza', 'rowId' => '1'],
                ['title' => 'Pepperoni', 'description' => 'Spicy pepperoni', 'rowId' => '2'],
            ],
        ],
        [
            'title' => 'Drinks',
            'rows' => [
                ['title' => 'Cola', 'description' => '350ml', 'rowId' => '3'],
            ],
        ],
    ],
]);
```

## Enquete / Poll

php

copiar

```
// Survey
$wa->message->sendSurvey($to, "Do you like PHP?", ["Yes", "No"]);

// Poll com selectableCount
$wa->message->sendPoll($to, "Favorite language?", ["PHP", "TypeScript", "Go"], 1);
```

## Cobrança via Pix

Envie cobranças via Pix com itens detalhados:

php

copiar

```
$wa->message->sendPix([
    'to' => $to,
    'title' => 'Pizza Order',
    'text' => 'Your order details',
    'referenceId' => 'order-123',
    'code' => '0020101021226700014br.gov.bcb.pix',
    'key' => '23711695000115',
    'merchantName' => 'MY STORE',
    'keyType' => 'CNPJ',
    'items' => [
        ['id' => '1', 'name' => 'Pizza G', 'price' => 45, 'quantity' => 2],
        ['id' => '2', 'name' => 'Soda', 'price' => 8, 'quantity' => 2],
    ],
    'subtotal' => '106',
    'totalAmount' => '106',
]);
```

## Evento, Pin e Call Link

#### Criar Evento

php

copiar

```
$wa->message->sendEvent(
    $to,
    "Team Meeting",
    "Weekly sync",
    "2025-01-15T14:00:00Z",
    "Office",
    "123 Main St"
);
```

#### Fixar / Desfixar Mensagem

php

copiar

```
$wa->message->pin("MESSAGE_ID", 604800); // 7 dias em segundos
$wa->message->unpin("MESSAGE_ID");
```

#### Link de Chamada

php

copiar

```
// Enviar link de chamada
$wa->message->sendCallLink($to, "video", "Join the meeting");

// Criar link de chamada (sem enviar)
$wa->message->createCallLink("video");
```

## Detalhes, Mídia e Outros

php

copiar

```
// Detalhes de uma mensagem
$details = $wa->message->getDetails("MESSAGE_ID");

// Download de mídia de uma mensagem
$media = $wa->message->downloadMedia("MESSAGE_ID", "json"); // json (base64) ou binary
```

#### Enviar Produto do Catálogo

php

copiar

```
$wa->message->sendProduct([
    'to' => $to,
    'businessOwnerJid' => '[email protected]',
    'productId' => 'product_id',
    'catalogId' => 'catalog_id',
    'body' => 'Confira este produto!',
    'footer' => 'WAME Store',
]);
```

#### Enviar Convite de Grupo

php

copiar

```
$wa->message->sendGroupInvite([
    'to' => $to,
    'groupJid' => '[email protected]',
    'groupName' => 'Developers',
    'inviteCode' => 'INVITE_CODE',
    'caption' => 'Entre no nosso grupo!',
]);
```

#### Solicitar Telefone

php

copiar

```
$wa->message->requestPhone($to);
```

## Gerenciar Chats

php

copiar

```
$chats = $wa->chat->getAll();
$msgs = $wa->chat->getMessages("[email protected]", 1, 20);

// Marcar como lido
$wa->chat->modify("[email protected]", "markRead", true);

// Fixar chat
$wa->chat->modify("[email protected]", "pin", true);

// Deletar chat
$wa->chat->delete("[email protected]");
```

#### Presença, Mensagens Temporárias e Privacidade

php

copiar

```
// Inscrever-se para receber atualizações de presença
$wa->chat->subscribePresence("[email protected]");

// Ativar mensagens temporárias
$wa->chat->setDisappearing("[email protected]", 604800); // 7 dias

// Consultar configurações de privacidade
$privacy = $wa->chat->getPrivacy();
```

## Chamadas

php

copiar

```
// Fazer chamada
$wa->call->make($to);

// Aceitar chamada
$wa->call->accept("CALL_ID", "[email protected]");

// Rejeitar chamada
$wa->call->reject("CALL_ID", "[email protected]");

// Encerrar chamada
$wa->call->end("CALL_ID", "[email protected]");
```

## Etiquetas / Labels

php

copiar

```
$labels = $wa->label->list();
$wa->label->create("VIP");
$wa->label->addToChat("label_id", $to);

$labeled = $wa->label->getChats("label_id");
$wa->label->removeFromChat("label_id", $to);

// Deletar etiqueta
$wa->label->delete("label_id");
```

## Contatos

php

copiar

```
$contacts = $wa->contact->list();
$profile = $wa->contact->getProfile("559999999999");

// Adicionar e remover contato
$wa->contact->add("559999999999", "Raphael");
$wa->contact->remove("559999999999");

// Bloquear / Desbloquear
$wa->contact->block("559999999999");
$wa->contact->unblock("559999999999");

// Listar contatos bloqueados
$blocked = $wa->contact->listBlocked();

// Status e sessão
$status = $wa->contact->getStatus("559999999999");
$wa->contact->clearSession("559999999999");

// Resolver LIDs
$wa->contact->resolveLids(["lid1", "lid2"]);

// Verificar se está registrado no WhatsApp
$check = $wa->contact->isRegistered("559999999999");
```

## Grupos

php

copiar

```
$groups = $wa->group->list();
$info = $wa->group->get("[email protected]");

// Criar grupo
$newGroup = $wa->group->create("Developers", ["559999999999"]);

// Atualizar grupo
$wa->group->update("[email protected]", "New Name", "New description");
```

#### Configurações do Grupo

php

copiar

```
$wa->group->changeSettings("[email protected]", "announcement");     // Somente admins enviam
$wa->group->changeSettings("[email protected]", "not_announcement"); // Todos enviam
$wa->group->changeSettings("[email protected]", "locked");           // Somente admins editam
$wa->group->changeSettings("[email protected]", "unlocked");         // Todos editam
```

#### Participantes

php

copiar

```
$wa->group->addParticipants("[email protected]", ["559999999999"]);
$wa->group->removeParticipants("[email protected]", ["559999999999"]);

// Promover / Rebaixar
$wa->group->promote("[email protected]", ["559999999999"]);
$wa->group->demote("[email protected]", ["559999999999"]);

// Aprovação de participantes
$pending = $wa->group->getRequestParticipants("[email protected]");
$wa->group->handleRequestParticipants("[email protected]", ["559999999999"], "approve");
```

#### Membros e Convites

php

copiar

```
$members = $wa->group->getMembers("[email protected]");
$invite = $wa->group->getInviteCode("[email protected]");
$inviteInfo = $wa->group->getInviteInfo("INVITE_CODE");
```

#### Outros

php

copiar

```
$wa->group->updatePicture("[email protected]", "https://example.com/photo.jpg");
$wa->group->removePicture("[email protected]");
$wa->group->leave("[email protected]");
```

## Comunidade

php

copiar

```
$communities = $wa->community->list();
$newComm = $wa->community->create("Minha Comunidade", "Assunto da comunidade"); // 2º arg = assunto (subject/descrição), não categoria
$commInfo = $wa->community->get("community_id");

$wa->community->update("community_id", "Updated", "New description");
$wa->community->updatePicture("community_id", "https://example.com/photo.jpg");

$commInvite = $wa->community->getInviteCode("community_id");
$wa->community->removeParticipants("community_id", ["559999999999"]);
$wa->community->leave("community_id");
```

#### Convites e Aprovação

php

copiar

```
// Aceitar convite de comunidade
$wa->community->acceptInvite("INVITE_CODE");

// Informações de convite
$inviteInfo = $wa->community->getInviteInfo("INVITE_CODE");

// Participantes pendentes de aprovação
$pending = $wa->community->getRequestParticipants("community_id");
$wa->community->handleRequestParticipants("community_id", ["559999999999"], "approve");
```

#### Grupos e Configurações

php

copiar

```
// Criar grupo dentro da comunidade
$wa->community->createGroup("community_id", "Novo Grupo", ["559999999999"]);

// Mensagens temporárias
$wa->community->setEphemeral("community_id", 604800);

// Configurações da comunidade
$wa->community->updateSettings("community_id", "announcement");
$wa->community->setMemberAddMode("community_id", "admin_add");
$wa->community->setJoinApproval("community_id", "on");
```

## Business / Catálogo

php

copiar

```
// Listar catálogo
$catalog = $wa->business->listCatalog();
$catalogPage = $wa->business->listCatalog(10, "cursor_token");

// Criar produto
$wa->business->createProduct([
    'name' => 'Premium T-Shirt',
    'description' => '100% cotton',
    'originCountryCode' => 'BR',
    'currency' => 'BRL',
    'price' => 79.90,
    'images' => [['url' => 'https://example.com/photo.jpg']],
]);

// Atualizar produto
$wa->business->updateProduct("product_id", [
    'name' => 'Premium T-Shirt v2',
    'price' => 89.90,
]);

// Deletar produto
$wa->business->deleteProduct("product_id");
```

## Newsletter / Canal

Gerencie canais/newsletters do WhatsApp:

php

copiar

```
// Criar newsletter
$wa->newsletter->create("Meu Canal", "Descrição do canal");

// Obter informações
$metadata = $wa->newsletter->getMetadata("invite", "NEWSLETTER_ID");
$subscribers = $wa->newsletter->getSubscribers("NEWSLETTER_ID");
$admins = $wa->newsletter->getAdmins("NEWSLETTER_ID");

// Seguir / Deixar de seguir
$wa->newsletter->follow("NEWSLETTER_ID");
$wa->newsletter->unfollow("NEWSLETTER_ID");
```

#### Atualizar Canal

php

copiar

```
$wa->newsletter->updateName("NEWSLETTER_ID", "Novo Nome");
$wa->newsletter->updateDescription("NEWSLETTER_ID", "Nova descrição");
$wa->newsletter->updatePicture("NEWSLETTER_ID", "https://example.com/photo.jpg");
$wa->newsletter->removePicture("NEWSLETTER_ID");
```

#### Administração

php

copiar

```
// Transferir propriedade
$wa->newsletter->transferOwnership("NEWSLETTER_ID", "[email protected]");

// Rebaixar admin
$wa->newsletter->demoteAdmin("NEWSLETTER_ID", "[email protected]");
```

#### Mensagens e Interação

php

copiar

```
// Listar mensagens do canal
$messages = $wa->newsletter->getMessages("NEWSLETTER_ID", 10);

// Reagir a uma mensagem
$wa->newsletter->react("NEWSLETTER_ID", "SERVER_ID", "👍");

// Silenciar / Ativar notificações
$wa->newsletter->mute("NEWSLETTER_ID");
$wa->newsletter->unmute("NEWSLETTER_ID");

// Deletar newsletter
$wa->newsletter->delete("NEWSLETTER_ID");
```

## Status / Stories

Publique e gerencie status (stories) do WhatsApp:

#### Texto

php

copiar

```
$wa->status->sendText("Olá! Este é meu status.", ["[email protected]"]);
// Segundo parâmetro opcional: limitar quem vê. Vazio = todos.
```

#### Imagem

php

copiar

```
$wa->status->sendImage("https://example.com/photo.jpg", "Minha foto");
```

#### Vídeo

php

copiar

```
$wa->status->sendVideo("https://example.com/video.mp4", "Meu vídeo");
```

#### Áudio

php

copiar

```
$wa->status->sendAudio("https://example.com/audio.mp3");
```

#### Menção

php

copiar

```
$wa->status->sendMention("[email protected]", "STATUS_MSG_ID");
```

## Webhook Parser

O SDK PHP inclui um parser de webhooks integrado para processar eventos recebidos. Use `parseMeta()`, que normaliza os payloads (WhatsApp, Instagram e Messenger) no envelope Meta:

php

copiar

```
$body = file_get_contents('php://input');

$events = $wa->webhook->parseMeta($body);

foreach ($events as $e) {
    // Campos normalizados
    $type       = $e['type'];        // text, image, audio, video, document, ...
    $provider   = $e['provider'];    // whatsapp, instagram, messenger
    $official   = $e['official'];    // bool
    $from       = $e['from'];        // número/JID do remetente
    $fromUserId = $e['fromUserId'];  // ID do usuário (Instagram/Messenger)
    $profile    = $e['profile'];     // dados do perfil

    if ($type === 'text') {
        $wa->message->sendText($from, 'Você disse: ' . $e['text']['body']);
    }

    if ($type === 'image') {
        $image = $e['image']; // payload específico da mídia
    }
}
```

O método `parse()` é legado/depreciado; prefira `parseMeta()`.

php

copiar

```
// Legado/depreciado — prefira parseMeta()
$parsed = $wa->webhook->parse();

if ($parsed && $parsed->messageType === 'text') {
    $wa->message->sendText($parsed->remoteJid, 'Você disse: ' . $parsed->text);
}

if ($parsed && $parsed->messageType === 'image') {
    $url = $parsed->mediaURL;
    $base64 = $parsed->mediaBase64;
    $caption = $parsed->caption ?? '';
}
```

#### Propriedades do Webhook

| Propriedade | Tipo | Descrição |
| --- | --- | --- |
| remoteJid | string | Número do remetente |
| msgId | string | ID da mensagem |
| pushName | string | Nome do remetente |
| messageType | string | text, image, audio, video, document, sticker, location, contact, button, list, reaction |
| text | string | Conteúdo de texto |
| mediaURL | string | URL de download de mídia |
| mediaBase64 | string | Mídia em Base64 |
| caption | string | Legenda da mídia |
| selectedId | string | ID do botão/lista selecionado |
| contact | array | Array de contatos com name e number |

## Contexto para AI

Use este arquivo de contexto para que assistentes de AI (Claude, ChatGPT, Copilot, etc.) entendam o SDK e possam te ajudar a programar com a WAME API.

#### llms.txt

Arquivo com toda a documentação do SDK PHP em formato otimizado para AI. Inclui estrutura, métodos, parâmetros e exemplos.

[Iniciar conversa com Claude](https://claude.ai/new?q=Leia%20a%20documenta%C3%A7%C3%A3o%20do%20SDK%20PHP%20em%20https%3A%2F%2Fraw.githubusercontent.com%2Fraphaelvserafim%2Fclient-php-api-wa-me%2Frefs%2Fheads%2Fmain%2Fllms.txt%20e%20me%20ajude%20a%20integrar%20a%20WAME%20API%20WhatsApp%20no%20meu%20projeto%20PHP.) Copiar conteúdo [Baixar llms.txt](https://raw.githubusercontent.com/raphaelvserafim/client-php-api-wa-me/refs/heads/main/llms.txt) [Visualizar](https://raw.githubusercontent.com/raphaelvserafim/client-php-api-wa-me/refs/heads/main/llms.txt)

#### Como usar

1Clique em **Iniciar conversa com Claude** para abrir o Claude já com o contexto do SDK

2Ou copie o conteúdo e cole no início da conversa com seu assistente de AI preferido

3Peça para a AI te ajudar a construir integrações com a WAME API

**Dica:** No Claude Code ou Cursor, salve o arquivo no seu projeto como `AGENTS.md` ou `CLAUDE.md` para que a AI tenha o contexto automaticamente.

## Tratamento de Erros

Todos os métodos retornam `?string` (JSON) ou `null` em caso de falha:

php

copiar

```
$result = $wa->message->sendText($to, "Hello");

if ($result) {
    $data = json_decode($result);
    echo "Mensagem enviada! ID: " . $data->data->key->id;
} else {
    echo "Erro ao enviar mensagem.";
}
```

WAME API SDK PHP — Documentação

[Começar Agora](https://portal.api-wa.me/)

## Structured data

```json
{
  "@context": "https://schema.org",
  "@type": "WebSite",
  "name": "WAME API",
  "alternateName": "API Oficial e Não Oficial de WhatsApp, Instagram e Messenger",
  "url": "https://api-wa.me",
  "inLanguage": "pt-BR",
  "publisher": {
    "@type": "Organization",
    "name": "WAME API",
    "url": "https://api-wa.me"
  }
}
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "WAME API",
  "alternateName": "API Oficial e Não Oficial de WhatsApp, Instagram e Messenger",
  "url": "https://api-wa.me",
  "logo": "https://api-wa.me/images/screenshot.png",
  "foundingDate": "2017",
  "slogan": "Parceira Oficial da Meta — WhatsApp, Instagram e Messenger numa instância só. Desde 2017.",
  "description": "Plataforma brasileira e Parceira Oficial da Meta (Meta Business Partner) para as APIs oficiais de WhatsApp (Cloud API), Instagram Direct e Messenger — os três numa única instância, com os mesmos endpoints e um único formato de webhook. Também oferece a API não oficial via QR Code, na mesma plataforma. No mercado desde 2017, com mais de 50 mil instâncias criadas, 99,9% de uptime e suporte humano 24/7 em português. SDKs oficiais para Node.js/TypeScript e PHP.",
  "knowsAbout": [
    "WhatsApp Cloud API oficial (Meta)",
    "API oficial de Instagram (Direct)",
    "API oficial de Messenger",
    "API multicanal Meta",
    "Meta Business Partner",
    "WhatsApp API",
    "API não oficial de WhatsApp",
    "automação de WhatsApp",
    "números virtuais",
    "webhooks"
  ],
  "sameAs": [
    "https://github.com/raphaelvserafim"
  ],
  "contactPoint": {
    "@type": "ContactPoint",
    "contactType": "customer support",
    "url": "https://api-wa.me/contact",
    "availableLanguage": [
      "Portuguese"
    ]
  }
}
{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [
    {
      "@type": "ListItem",
      "position": 0,
      "name": "Home",
      "item": "https://api-wa.me"
    },
    {
      "@type": "ListItem",
      "position": 1,
      "name": "Documentação",
      "item": "https://api-wa.me/docs"
    }
  ]
}
```