wi-api / php

v0.1.1 2026-09-04 01:15 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-json: *

Requires (Dev)

• phpunit/phpunit: ^11

MIT

• wi-api

• api
• sdk
• messaging
• whatsapp

Published on Packagist.org on 2026-09-04 01:16 UTC

README

PHP SDK for wi-api. Send and receive WhatsApp messages with no external dependencies.

Requires PHP 8.1+, ext-curl, and ext-json.

Install

composer require wi-api/php

Quick start

use WiApi\Wi;

$wi = new Wi(apiKey: $_ENV['WI_API_KEY']);
$msg = $wi->session('my-instance')->sendText(
    to:   '5511999999999',
    text: 'Hello from wi-api',
);
echo $msg['messageId'];

Sessions

$session = $wi->session('my-instance');

$session->connect();

$qr = $session->qr();
echo $qr['qr']; // base64 PNG

$pair = $session->pairPhone('5511999999999');
echo $pair['pairCode']; // 8-character code

$status = $session->status();
echo $status['connected'] ? 'connected' : 'disconnected';

$session->disconnect(); // keeps session keys
$session->logout();     // removes session keys

Sending messages

// Text
$session->sendText(to: '5511999999999', text: 'Hello!');

// Reply
$session->sendText(to: '5511999999999', text: 'Got it', quoted: $messageId);

// Image
$session->sendImage(
    to:      '5511999999999',
    url:     'https://example.com/photo.jpg',
    caption: 'Look at this',
);

// Voice note
$session->sendAudio(to: '5511999999999', url: 'https://example.com/audio.ogg', ptt: true);

// Document
$session->sendDocument(
    to:       '5511999999999',
    url:      'https://example.com/report.pdf',
    filename: 'report.pdf',
);

// Location
$session->sendLocation(
    to:        '5511999999999',
    latitude:  -23.5505,
    longitude: -46.6333,
    title:     'São Paulo',
);

// Poll
$session->sendPoll(
    to:       '5511999999999',
    question: 'Best stack?',
    options:  ['PHP', 'Go', 'Rust', 'Node.js'],
);

// Reaction
$session->react(to: '5511999999999', messageId: $messageId, emoji: '');

Webhooks

use WiApi\Webhook;
use WiApi\Exception\WiException;

$body = file_get_contents('php://input');
$sig  = $_SERVER['HTTP_X_WI_SIGNATURE'] ?? '';

try {
    $event = Webhook::verify(
        body:      $body,
        signature: $sig,
        secret:    $_ENV['WI_WEBHOOK_SECRET'],
    );

    match ($event['event']) {
        'message'   => handleMessage($event['data']),
        'connected' => handleConnected($event['data']),
        default     => null,
    };

    http_response_code(204);
} catch (WiException $e) {
    http_response_code($e->getStatusCode() ?: 400);
}

Laravel:

Route::post('/webhook', function (Request $request) {
    try {
        $event = Webhook::verify(
            body:      $request->getContent(),
            signature: $request->header('x-wi-signature', ''),
            secret:    config('services.wiapi.webhook_secret'),
        );
    } catch (WiException) {
        abort(401);
    }

    match ($event['event']) {
        'message' => MessageReceived::dispatch($event['data']),
        default   => null,
    };

    return response()->noContent();
});

Error handling

use WiApi\Exception\WiException;

try {
    $msg = $session->sendText(to: '5511999999999', text: 'Hello');
} catch (WiException $e) {
    echo $e->getMessage();
    echo $e->getStatusCode();
}

Configuration

$wi = new Wi(
    apiKey:  $_ENV['WI_API_KEY'],
    baseUrl: 'https://endpoint.wi.api.br', // default
    timeout: 30,                            // seconds
);

Resources

• Packagist
• Dashboard
• Docs
• Changelog