README

A PHP SDK for the Wati.io WhatsApp API. Provides pre-built API classes for common operations.

Installation

This package requires PHP 8.3 or higher.

composer require "phpjuice/wati-sdk"

Setup

Get Your Credentials

1. Log in to your Wati Account
2. Navigate to API Docs in the top menu
3. Copy your API Endpoint URL and Bearer Token

Create a Client

<?php

use Wati\Http\WatiClient;
use Wati\Http\WatiEnvironment;
use Wati\Api\GetContacts;

// Get this URL from your Wati Dashboard (API Docs section)
// It includes your tenant ID: https://your-instance.wati.io/{tenantId}
$endpoint = "https://your-instance.wati.io/123456";
$bearerToken = "your-bearer-token";

// Create environment and client
$environment = new WatiEnvironment($endpoint, $bearerToken);
$client = new WatiClient($environment);

// Use pre-built API classes
$response = $client->send(new GetContacts());
$contacts = json_decode($response->getBody()->getContents(), true);

Usage with Laravel

The SDK includes a Laravel service provider for easy integration.

Configuration

Add the following to your config/services.php:

'wati' => [
    'endpoint' => env('WATI_ENDPOINT'),
    'token' => env('WATI_TOKEN'),
],

Add to your .env file:

WATI_ENDPOINT=https://your-instance.wati.io/123456
WATI_TOKEN=your-bearer-token

Usage in Laravel

The service provider is auto-discovered. Simply inject or resolve WatiClient:

use Wati\Http\WatiClient;
use Wati\Api\GetContacts;

class ContactController
{
    public function __construct(
        private readonly WatiClient $wati
    ) {}

    public function index()
    {
        $response = $this->wati->send(new GetContacts());
        return json_decode($response->getBody()->getContents(), true);
    }
}

Available API Classes

Contacts

Templates

Usage

Get Contacts

<?php

use Wati\Api\GetContacts;

// Get the first page with 50 contacts (default)
$response = $client->send(new GetContacts());

// Get a specific page with a custom page size
$response = $client->send(new GetContacts(pageNumber: 2, pageSize: 100));

Error Handling

<?php

use Wati\Http\Exceptions\AuthenticationException;
use Wati\Http\Exceptions\RateLimitException;
use Wati\Http\Exceptions\ValidationException;
use Wati\Http\Exceptions\WatiApiException;
use Wati\Http\Exceptions\WatiException;

try {
    $response = $client->send(new GetContacts());
} catch (AuthenticationException $e) {
    // Invalid bearer token - check credentials
} catch (RateLimitException $e) {
    // Rate limited - wait and retry
    $retryAfter = $e->getRetryAfter();
} catch (ValidationException $e) {
    // Invalid request parameters
    $errors = $e->getResponseData();
} catch (WatiApiException $e) {
    // Other API errors (4xx, 5xx)
    $statusCode = $e->getStatusCode();
} catch (WatiException $e) {
    // Connection or other HTTP errors
}

API Reference

For full API documentation, visit Wati API Docs.

Changelog

Please see the CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email the author instead of using the issue tracker.

License

Please see the License file.