README

Official PHP SDK for AraraHQ — the developer-first WhatsApp API. Simple, typed, and developer-first.

Installation

composer require ararahq/sdk

Configuration

use Arara\Arara;
use Arara\Config;

$config = new Config(
    apiKey: 'sk_live_...',
);

$sdk = new Arara($config);

Resources

1. Messages ($sdk->messages)

// Template standard
$response = $sdk->messages->send(
    receiver: 'whatsapp:+5511999999999',
    templateName: 'welcome',
    variables: ['John']
);

// Template com Mídia (Header de Imagem/PDF)
$response = $sdk->messages->send(
    receiver: 'whatsapp:+5511999999999',
    templateName: 'invoice_ready',
    variables: ['John', 'January'],
    mediaUrl: 'https://your-media.com/invoice.pdf'
);

// Mensagem de Sessão (Texto Livre)
$response = $sdk->messages->send(
    receiver: 'whatsapp:+5511999999999',
    body: 'Olá! Como posso ajudar?'
);

2. Templates ($sdk->templates)

$templates = $sdk->templates->list();

$details = $sdk->templates->get('template-name');

$sdk->templates->create([
    'name' => 'promo_christmas',
    'category' => 'MARKETING',
    'language' => 'pt_BR',
    'body' => 'Hi {{1}}, check our Christmas deals!',
    'samples' => ['John']
]);

$sdk->templates->delete('template-name');

3. Webhook Events

use Arara\Utils\WebhookUtils;

$payload = file_get_contents('php://input');
$data = json_decode($payload, true);

if (WebhookUtils::isMessageStatusEvent($data)) {
    $status = $data['data']['status'];
    // Handle status update
}

if (WebhookUtils::isInboundMessageEvent($data)) {
    $from = $data['data']['from'];
    $body = $data['data']['body'];
    // Handle inbound message
}

Error Handling

use Arara\Exceptions\AraraException;

try {
    $sdk->messages->send(...);
} catch (AraraException $e) {
    echo "Error {$e->statusCode}: {$e->getMessage()}";
    print_r($e->response);
}

License

MIT