VonageMessages.php

<?php

namespace Utopia\Messaging\Adapter\SMS;

use Utopia\Messaging\Adapter\SMS as SMSAdapter;
use Utopia\Messaging\Messages\SMS as SMSMessage;
use Utopia\Messaging\Response;

// Vonage Messages API SMS Adapter.
// This adapter uses the modern Vonage Messages API (V1) which is more cost-effective
// and versatile than the legacy SMS API.
// https://developer.vonage.com/en/api/messages
class VonageMessages extends SMSAdapter
{
    protected const NAME = 'Vonage Messages';

    public function __construct(
        private string $apiKey,
        private string $apiSecret,
        private ?string $from = null
    ) {
    }

    // Vonage Messages API endpoint.
    protected function getApiEndpoint(): string
    {
        return 'https://api.vonage.com/v1/messages';
    }

    // Generates the Basic Authorization header.
    protected function getAuthorizationHeader(): string
    {
        return 'Basic ' . \base64_encode("{$this->apiKey}:{$this->apiSecret}");
    }

    // Sets common headers for the API request.
    protected function getRequestHeaders(): array
    {
        return [
            "Authorization: {$this->getAuthorizationHeader()}",
            'Content-Type: application/json',
            'Accept: application/json',
            'User-Agent: Utopia Messaging',
        ];
    }

    // Get adapter name.
    public function getName(): string
    {
        return static::NAME;
    }

    // Get max messages per request.
    public function getMaxMessagesPerRequest(): int
    {
        return 1;
    }

    protected function process(SMSMessage $message): array
    {
        $to = \ltrim($message->getTo()[0], '+');
        $from = $this->from ?? $message->getFrom();
        $from = $from !== null ? \ltrim($from, '+') : null;

        $response = new Response($this->getType());

        if (empty($from)) {
            $response->addResult($message->getTo()[0], 'The "from" field is required for the Vonage Messages API.');
            return $response->toArray();
        }

        $result = $this->request(
            method: 'POST',
            url: $this->getApiEndpoint(),
            headers: $this->getRequestHeaders(),
            body: [
                'message_type' => 'text',
                'to' => $to,
                'from' => $from,
                'text' => $message->getContent(),
                'channel' => 'sms',
            ],
        );

        if ($result['statusCode'] === 202) {
            $response->setDeliveredTo(1);
            $response->addResult($message->getTo()[0]);
        } else {
            $errorMessage = "Error {$result['statusCode']}";

            if (\is_array($result['response'])) {
                if (isset($result['response']['detail'])) {
                    $errorMessage = $result['response']['detail'];
                } elseif (isset($result['response']['title'])) {
                    $errorMessage = $result['response']['title'];
                }
            } elseif (!empty($result['error'])) {
                $errorMessage = $result['error'];
            } elseif (\is_string($result['response']) && !empty($result['response'])) {
                $errorMessage = "Error {$result['statusCode']}: " . \mb_strimwidth(\strip_tags($result['response']), 0, 100, '...');
            }

            $response->addResult($message->getTo()[0], $errorMessage);
        }

        return $response->toArray();
    }
}