React to Message

.github/workflows/dependency-review.yml

@@ -15,6 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/php.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.2.0 - 2023-11-19
+
+### What's Changed
+
+- Updated default Graph version to v18
+- Retrieve and update business profile. Thanks @winkelco
+- Allow to reply messages. Thanks @johnflash4real
+- Add Interactive buttons. Thanks @derrickobedgiu1 and @ianrothmann
+- Retrieve a batch of notifications from Webhook. Thanks @arneee
+- Optional headers in interactive list messages. Thanks @horatiua
+- Fix non nullable variables when empty ENV variables are defined
+
 ## 2.1.0 - 2023-08-12
 
 ### What's Changed

README.md

@@ -222,6 +222,51 @@ $whatsapp_cloud_api->sendList(
 );
 ```
 
+### Send a button reply message
+
+```php
+<?php
+
+use Netflie\WhatsAppCloudApi\WhatsAppCloudApi;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\Button;
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\ButtonAction;
+
+$whatsapp_cloud_api = new WhatsAppCloudApi([
+  'from_phone_number_id' => 'your-configured-from-phone-number-id',
+  'access_token' => 'your-facebook-whatsapp-application-token' 
+]);
+
+$rows = [
+    new Button('button-1', 'Yes'),
+    new Button('button-2', 'No'),
+    new Button('button-3', 'Not Now'),
+];
+$action = new ButtonAction($rows);
+
+$whatsapp_cloud_api->sendButton(
+    '<destination-phone-number>',
+    'Would you like to rate us on Trustpilot?',
+    $action,
+    'RATE US', // Optional: Specify a header (type "text")
+    'Please choose an option' // Optional: Specify a footer 
+);
+```
+
+### Replying messages
+
+You can reply a previous sent message:
+
+```php
+<?php
+
+$whatsapp_cloud_api
+    ->replyTo('<whatsapp-message-id-to-reply>')
+    ->sendTextMessage(
+        '34676104574',
+        'Hey there! I\'m using WhatsApp Cloud API. Visit https://www.netflie.es'
+    );
+```
+
 ## Media messages
 ### Upload media resources
 Media messages accept as identifiers an Internet URL pointing to a public resource (image, video, audio, etc.). When you try to send a media message from a URL you must instantiate the `LinkID` object.
@@ -294,7 +339,11 @@ fwrite(STDOUT, print_r($payload, true) . "\n");
 // Instantiate the Webhook super class.
 $webhook = new WebHook();
 
+// Read the first message
 fwrite(STDOUT, print_r($webhook->read(json_decode($payload, true)), true) . "\n");
+
+//Read all messages in case Meta decided to batch them
+fwrite(STDOUT, print_r($webhook->readAll(json_decode($payload, true)), true) . "\n");
 ```
 
 The `Webhook::read` function will return a `Notification` instance. Please, [explore](https://github.com/netflie/whatsapp-cloud-api/tree/main/src/WebHook/Notification "explore") the different notifications availables.
@@ -341,6 +390,7 @@ Fields list: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/b
 - Send Locations
 - Send Contacts
 - Send Lists
+- Send Buttons
 - Upload media resources to WhatsApp servers
 - Download media resources from WhatsApp servers
 - Mark messages as read

src/Message/ButtonReply/Button.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+class Button
+{
+    private $id;
+    private $title;
+
+    public function __construct(string $id, string $title)
+    {
+        $this->id = $id;
+        $this->title = $title;
+    }
+
+    public function id(): string
+    {
+        return $this->id;
+    }
+
+    public function title(): string
+    {
+        return $this->title;
+    }
+}

src/Message/ButtonReply/ButtonAction.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message\ButtonReply;
+
+class ButtonAction
+{
+    private $buttons;
+
+    public function __construct(array $buttons)
+    {
+        $this->buttons = $buttons;
+    }
+
+    public function buttons(): array
+    {
+        $buttonActions = [];
+
+        foreach ($this->buttons as $button) {
+            $buttonActions[] = [
+                "type" => "reply",
+                "reply" => [
+                    "id" => $button->id(),
+                    "title" => $button->title(),
+                ],
+            ];
+        }
+
+        return $buttonActions;
+    }
+}

src/Message/ButtonReplyMessage.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message;
+
+use Netflie\WhatsAppCloudApi\Message\ButtonReply\ButtonAction;
+
+class ButtonReplyMessage extends Message
+{
+    protected string $type = 'button';
+
+    private ?string $header;
+
+    private string $body;
+
+    private ?string $footer;
+
+    private ButtonAction $action;
+
+    public function __construct(string $to, string $body, ButtonAction $action, ?string $header = null, ?string $footer = null, ?string $reply_to = null)
+    {
+        $this->body = $body;
+        $this->action = $action;
+        $this->header = $header;
+        $this->footer = $footer;
+
+        parent::__construct($to, $reply_to);
+    }
+
+    public function header(): ?string
+    {
+        return $this->header;
+    }
+
+    public function body(): string
+    {
+        return $this->body;
+    }
+
+    public function action(): ButtonAction
+    {
+        return $this->action;
+    }
+
+    public function footer(): ?string
+    {
+        return $this->footer;
+    }
+}

src/Message/ReactionMessage.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Message;
+
+final class ReactionMessage extends Message
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected string $type = 'reaction';
+
+    private $emoji;
+
+    private $message_id;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct(string $to, string $emoji, string $message_id)
+    {
+        $this->emoji = $emoji;
+        $this->message_id = $message_id;
+
+        parent::__construct($to, null);
+    }
+
+    public function emoji(): string
+    {
+        return $this->emoji;
+    }
+
+    public function message_id(): string
+    {
+        return $this->message_id;
+    }
+}

src/Request/MessageRequest/RequestButtonReplyMessage.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
+
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
+
+class RequestButtonReplyMessage extends MessageRequest
+{
+    public function body(): array
+    {
+        $body = [
+            'messaging_product' => $this->message->messagingProduct(),
+            'recipient_type' => $this->message->recipientType(),
+            'to' => $this->message->to(),
+            'type' => 'interactive',
+            'interactive' => [
+                'type' => 'button',
+                'body' => ['text' => $this->message->body()],
+                'action' => ['buttons' => $this->message->action()->buttons()],
+            ],
+        ];
+
+        if ($this->message->header()) {
+            $body['interactive']['header'] = [
+                'type' => 'text',
+                'text' => $this->message->header(),
+            ];
+        }
+
+        if ($this->message->footer()) {
+            $body['interactive']['footer'] = [
+                'text' => $this->message->footer(),
+            ];
+        }
+
+        if ($this->message->replyTo()) {
+            $body['context']['message_id'] = $this->message->replyTo();
+        }
+
+        return $body;
+    }
+}

src/Request/MessageRequest/RequestOptionsListMessage.php

@@ -18,15 +18,18 @@ public function body(): array
             'type' => 'interactive',
             'interactive' => [
                 'type' => $this->message->type(),
-                'header' => [
-                    'type' => 'text',
-                    'text' => $this->message->header(),
-                ],
                 'body' => ['text' => $this->message->body()],
                 'action' => $this->message->action(),
             ],
         ];
 
+        if ($this->message->header()) {
+            $body['interactive']['header'] = [
+                'type' => 'text',
+                'text' => $this->message->header(),
+            ];
+        }
+
         if ($this->message->footer()) {
             $body['interactive']['footer'] = ['text' => $this->message->footer()];
         }

src/Request/MessageRequest/RequestReactionMessage.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
+
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
+
+final class RequestReactionMessage extends MessageRequest
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function body(): array
+    {
+        $body = [
+            'messaging_product' => $this->message->messagingProduct(),
+            'recipient_type' => $this->message->recipientType(),
+            'to' => $this->message->to(),
+            'type' => $this->message->type(),
+            $this->message->type() => [
+                'message_id' => $this->message->message_id(),
+                'emoji' => $this->message->emoji(),
+            ],
+        ];
+
+        return $body;
+    }
+}

src/WebHook.php

@@ -31,4 +31,16 @@ public function read(array $payload): ?Notification
         return (new NotificationFactory())
             ->buildFromPayload($payload);
     }
+
+    /**
+     * Get all notifications from incoming webhook messages.
+     *
+     * @param  array  $payload Payload received in your endpoint URL.
+     * @return Notification[]    A PHP representation of WhatsApp webhook notifications
+     */
+    public function readAll(array $payload): array
+    {
+        return (new NotificationFactory())
+            ->buildAllFromPayload($payload);
+    }
 }

src/WebHook/Notification/MessageNotificationFactory.php

@@ -26,7 +26,7 @@ private function buildMessageNotification(array $metadata, array $message): Mess
                     $message['id'],
                     new Support\Business($metadata['phone_number_id'], $metadata['display_phone_number']),
                     $message['reaction']['message_id'],
-                    $message['reaction']['emoji'],
+                    $message['reaction']['emoji'] ?? '',
                     $message['timestamp']
                 );
             case 'sticker':