zapmizer/laravel-notification-zapmizer

A Laravel package to send WhatsApp notifications using Zapmizer API

v1.0.1 2024-07-18 18:07 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.8
• illuminate/notifications: ~10.0 || ~11.0
• illuminate/support: ~10.0 || ~11.0

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^10.0

MIT

• Zapmizer

README

Installation

You can install the package via composer:

composer require zapmizer/laravel-notification-zapmizer

Now publish config file

php artisan vendor:publish --provider="Notification\Zapmizer\ZapmizerServiceProvider" --tag=config --force

Setting up your Zapmizer account

1. Create a API TOKEN.
2. Paste your API token in your zapmizer.php config file.
3. Add environment viariables with values

    ZAPMIZER_API_TOKEN="your-api-token"
    ZAPMIZER_FROM_NUMBER="558181643260"

Usage

In every Notification you wish to notify via WhatsApp, you must add a toZapmizer function and add 'zapmizer' drive into via's array:

    /**
     * Get the notification's delivery channels.
     *
     * @return array<int, string>
     */
    public function via(object $notifiable): array
    {
        return ['mail', 'zapmizer'];
    }

    /**
     * Get the WhatsApp representation of the notification.
     */
    public function toZapmizer(object $notifiable)
    {
        $message = 'This is a message!' . PHP_EOL;

        //WID must follow the WhatsApp pattern, example: 558181643260; [e-mail] [e-mail](groups)

        return ZapmizerMessage::create(from: config('zapmizer.from_number'), to: $notifiable->wid)->type('chat')->text($message)->send();
    }

Number verification

Mirroring Laravel's MustVerifyEmail: implement an interface and use a trait on your User model, and it gains the verification methods you'd expect. The user verifies through a hosted page on the Zapmizer domain — they message the team's WhatsApp number via wa.me and type back the code the bot replies with. Your app confirms the code (hosted page or your own input) and/or receives the terminal state on the team's webhooks. State lives in the package's own tables — your users table is never touched.

use NotificationChannels\Zapmizer\Contracts\MustVerifyWhatsapp as MustVerifyWhatsappContract;
use NotificationChannels\Zapmizer\MustVerifyWhatsapp;

class User extends Authenticatable implements MustVerifyWhatsappContract
{
    use MustVerifyWhatsapp;
}

<a href="{{ route('zapmizer.verify_number') }}">Verify your WhatsApp</a>

$user->hasVerifiedWhatsapp(); // true after the user completes the hosted page

See the full setup guide — credentials, env vars, migrations, User model, signed return URL, confirmation webhook and events — in docs/verify-number.md.