oseias-isidoro/evoluiton-sdk

A SDK for https://github.com/EvolutionAPI/evolution-api

v1.1.1-beta 2024-03-08 05:38 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^7.7
• vlucas/phpdotenv: ^5.6

proprietary

• Oseias Isidoro

README

A simple SDK for https://github.com/EvolutionAPI/evolution-api.
This uses the BUILDER design pattern to create the message request.

Install

composer require "oseias-isidoro/evoluiton-sdk"

in your .env

EVOLUTION_TOKEN='{TOKEN}'
EVOLUTION_URL='https://evolution.com'

Quick start and examples

• just text

require __DIR__ . '/vendor/autoload.php';

use EvolutionSDK\Messages\MessageBuilder;
use EvolutionSDK\Messages\Messenger;

$builder = new MessageBuilder();

$message = $builder
    ->from('[instance]')
    ->to('[remoteJid]')
    ->text('simple text')
    ->getMessage();


if ((new Messenger())->send($message)) {
    echo "success";
} else {
    echo "error";
}

MessageBuilder methods available

Media:

    media(string $url, string $mediaType, string $fileName = null);
    
    $builder->media(
        'https://path_to_file',
        'document', // document, image, video
        'file_name' // Optional, just for document media type 
    );

Audio:

    audio(string $url);
    
    $builder->audio('https://path_to_file');

Mentions:

    mentions(bool $everyOne = true, array $data = []);
    
    $builder->mentions(false, [
        "[remoteJid]",
        "[remoteJid]",
    ]);

Reply:

    reply(array $data);
    
    $builder->reply([
        "key" => [
            "remoteJid" => "[remoteJid]@s.whatsapp.net",
            "fromMe" => "true",
            "id" => "BAE5766236A2AEFF",
            "participant" => "",
        ],
        "message" => [
            "conversation" => "Plain text message, sent with the _Evolution-API_ 🚀."
        ]
    ]);

Supported messages type

type	*
Send Text	✔
Send Buttons	❌
Send Template	❌
Send Media: audio - video - image - document - gif base64: true	✔
Send Media File	✔
Send Audio type WhatsApp	✔
Send Audio type WhatsApp - File	✔
Send Location	✔
Send List	❌
Send Link Preview	❌
Send Contact	✔
Send Reaction - emoji	✔