README

Laravel package to easily send WhatsApp messages using the WhatsApp Cloud API (Graph API).

Table of Contents

• Installation
• Environment variables
• Features
• Usage
  • Text messages
  • Sending templates
  • Interactive buttons
  • Interactive lists
  • Sending images
  • Sending video by URL
  • Uploading media
  • Raw messages
  • Querying registered templates on Meta
  • Test mode
  • toArray method
• API Reference
• License

Installation

composer require axolotesource/laravel-whatsapp-api

Publish the configuration file:

php artisan vendor:publish --provider="Axolotesource\LaravelWhatsappApi\LaravelWhatsappApiServiceProvider"

Environment variables (.env)

WHATSAPP_BUSINESS_ACCOUNT_ID=
WHATSAPP_BUSINESS_PHONE_NUMBER_ID=
WHATSAPP_BUSINESS_BEARER=
WHATSAPP_HOOK_VERIFY_TOKEN=
WHATSAPP_BUSINESS_API=https://graph.facebook.com/v23.0/
WHATSAPP_BUSINESS_TEST_NUMBER=
WHATSAPP_BUSINESS_TEST_MODE=false
DEFAULT_INITIAL_TEMPLETE=default
WHATSAPP_RAW_TEMPLETE=
TEMPLETE_IMAGEN_HEAD=
DISABLE_WHATSAPP_HOOK=false
REPLICATE_WHATSAPP_HOOK_URLS=[]

Features

Usage

Sending templates

The first message to a new contact must be a Meta-approved template.

WhatsAppMessages::templete('521234567890')
    ->language('es_MX')
    ->addComponents([
        BodyComponent::create([
            Params::text('This is a test message')
        ]),
        ButtonComponent::create([
            Params::button('yes')
        ]),
        ButtonComponent::create([
            Params::button('no')
        ]),
        ButtonComponent::create(
            [
                Params::button('history/login?folio=123ABC')
            ],
            ButtonComponent::SUB_TYPE_URL
        ),
        ButtonComponent::create([
            Params::button('never')
        ])
    ]);

If you don't pass a template name, it will use the default_initial_templete config value.

Template components

• BodyComponent – Message body
• HeaderComponent – Header
• ButtonComponent – Buttons (supports QUICK_REPLY and URL)

Parameters

Params::text(string $text, ?string $parameterName = null)
Params::button(string $payload)
Params::imageFromUrl(string $url)

Text messages

use Axolotesource\LaravelWhatsappApi\WhatsAppMessages\WhatsAppMessages;

WhatsAppMessages::text('521234567890')
    ->body('Hello, this is a text message')
    ->send();

// You can also disable URL previews
WhatsAppMessages::text('521234567890', false)
    ->body('Message without URL preview')
    ->send();

Using textMessage (replaces text, which is deprecated):

WhatsAppMessages::textMessage('521234567890')
    ->body('Hello world')
    ->send();

Interactive buttons

Up to 3 quick reply buttons.

WhatsAppMessages::interactiveButtons('521234567890')
    ->setHeaderText('Optional header')
    ->body('Message body')
    ->footer('Optional footer')
    ->addButton('Option 1', 1)
    ->addButton('Option 2', 2)
    ->addButton('Option 3', 3)
    ->send();

Also supports media headers:

WhatsAppMessages::interactiveButtons('521234567890')
    ->setHeaderImage('https://example.com/image.jpg')
    ->body('Message body')
    ->addButton('Yes', 'yes')
    ->addButton('No', 'no')
    ->send();

Interactive lists

WhatsAppMessages::interactiveList('521234567890')
    ->body('Choose an option:')
    ->button('View options')
    ->addSection('Section 1', [
        Row::create('Row title 1', 'id-1', 'Optional description'),
        Row::create('Row title 2', 'id-2'),
    ])
    ->addSection('Section 2', [
        Row::create('Row title 3', 'id-3'),
    ])
    ->send();

Sending images

By media ID (requires uploading the file first):

$media = WhatsAppMedia::image('/local/path/image.jpg')->upload();

WhatsAppMessages::image('521234567890', $media)
    ->send();

By URL:

WhatsAppMessages::imageByUrl('521234567890', 'https://example.com/image.jpg')
    ->send();

Sending video by URL

WhatsAppMessages::videoByUrl('521234567890', 'https://example.com/video.mp4')
    ->send();

Uploading media

use Axolotesource\LaravelWhatsappApi\WhatsAppMessages\WhatsAppMedia;

// Upload image
$media = WhatsAppMedia::image('/path/image.jpg')->upload();

// Upload video
$media = WhatsAppMedia::video('/path/video.mp4')->upload();

// Retrieve media metadata by ID
$media = WhatsAppMedia::retrieve('MEDIA_ID')->get();

Raw messages

For fully custom requests:

WhatsAppMessages::raw([
    'type' => 'text',
    'text' => [
        'body' => 'Hello {{name}}'
    ],
], '521234567890', ['name' => 'John'])
    ->send();

Querying registered templates on Meta

WhatsAppTemplate allows you to retrieve information about templates registered in your WhatsApp Business account.

use Axolotesource\LaravelWhatsappApi\WhatsAppMessages\WhatsAppTemplate;

Get all templates

$templates = WhatsAppTemplate::all(); // Collection of TemplateDTO

Filters

// By status
WhatsAppTemplate::where('status', 'APPROVED')->get();

// By category
WhatsAppTemplate::where('category', 'UTILITY')->get();

// By name
WhatsAppTemplate::where('name', 'my_template')->get();

// By language
WhatsAppTemplate::where('language', 'es_MX')->get();

// Multiple values
WhatsAppTemplate::whereIn('status', ['APPROVED', 'PENDING'])->get();

Selecting fields

WhatsAppTemplate::select(['name', 'status', 'category', 'language', 'components'])->get();

Available fields: id, name, status, category, language, components, last_updated_time, quality_score, rejected_reason.

Limit results

WhatsAppTemplate::limit(10)->get();

Pagination

$list = WhatsAppTemplate::list(); // TemplateList

foreach ($list->data() as $template) {
    echo $template->name . ' - ' . $template->status;
}

if ($list->hasNextPage()) {
    $nextPage = $list->nextPage();
}

TemplateDTO

Each template is returned as a TemplateDTO with the following properties:

Fake mode

WhatsAppMessages::fake();
WhatsAppTemplate::all(); // returns simulated data

Test mode

// Activate to send all messages to the test number
WhatsAppMessages::fake();

When WHATSAPP_BUSINESS_TEST_MODE=true, all messages are automatically redirected to WHATSAPP_BUSINESS_TEST_NUMBER.

toArray() method

You can get the payload without sending it:

$payload = WhatsAppMessages::text('521234567890')
    ->body('Hello')
    ->toArray();

API Reference

License

MIT