psbhanu/whatsapi

Wrapper for Whatsapp messenger

Whatsapi

Wrapper for whatsapp/chat-api, that allows us send messages through WhatsApp. Thanks guys., _(*1)

Installation

Non Laravel users, _(*2)

If you're not a Laravel user you only need to run the composer require command in order to install the needed package., _(*3)

    composer require psbhanu/whatsapi

Laravel users, _(*4)

Assuming you already have composer installed on your system, install a new Laravel project into whatsapidemo folder, _(*5)

    composer create-project laravel/laravel whatsapidemo --prefer-dist

Ensure that you set webserver to use whatsapidemo/public as it's webroot. Now, if you visit http://localhost (or whatever domain name you are using) you should see a nice Laravel welcome message., _(*6)

Change into your new whatsapidemo folder., _(*7)

    cd whatsapidemo

Require the needed package., _(*8)

    composer require psbhanu/whatsapi

If you get [InvalidArgumentException] Could not find package psbhanu/whatsapi at any version for your minimum-stability (stable). Check the package spelling or your minimum-stability you must add these lines to your composer.json an then re-run previous command., _(*9)

    "minimum-stability": "dev",
    "prefer-stable" : true

We tell Laravel that there is a Whatsapi ServiceProvider. At the end of config/app.php file, in the providers array, add:, _(*10)

    'psbhanu\Whatsapi\WhatsapiServiceProvider'

Finally, Into the config/app.php file, add to aliases array each of these lines, _(*11)

    'Whatsapi' => 'psbhanu\Whatsapi\Facades\Laravel\Whatsapi',
    'WhatsapiTool' => 'psbhanu\Whatsapi\Facades\Laravel\Registration',

Configuration

Non Laravel users, _(*12)

If you're using another Framework, different from Laravel, you must put manually the config file Config/config.php on the right path., _(*13)

    // Include the composer autoload file
    include_once "vendor/autoload.php";

    // Import the necessary classes
    use psbhanu\Whatsapi\Facades\Native\Whatsapi;
    use psbhanu\Whatsapi\Facades\Native\Registration;

    // Or, if you want you can add a class alias
    // class_alias('psbhanu\Whatsapi\Facades\Native\Whatsapi', 'Whatsapi');
    // class_alias('psbhanu\Whatsapi\Facades\Native\Registration', 'Registration');

Now, we tell Whatsapi about the config values., _(*14)

    // Of course, you can use the Config class from your favorite Framework.
    $config = __DIR__ . 'config/whatsapi.php';

    Whatsapi::setConfig($config);

By default, the native implementation session use the $_SESSION global var, you can override this providing a instance that implements the contract psbhanu\Whatsapi\Sessions\SessionInterface., _(*15)

    # Codeigniter 3 example

    use CI_Session;
    use psbhanu\Whatsapi\Sessions\SessionInterface;

    class SessionManager implements SessionInterface{

        # The key used in the Session.
        protected $key = 'itnovado_whatsapi';

        # Session object.
        protected $session;

        public function __construct(CI_Session $session)
        {
            $this->session = $session;
        }

        public function getKey()
        {
            return $this->key;
        }

        public function put($value)
        {
            $this->session->set_userdata($this->getKey(), $value);
        }

        public function pull()
        {
            $data = $this->session->userdata($this->getKey());

            $this->session->unset_userdata($this->getKey());

            return $data;
        }
    }

    // Get some resources
    $ci =& get_instance();
    $ci->load->driver('session');

    $sessionManager = new SessionManager($ci->session);

    // Override the default session implementation
    Whatsapi::setSessionManager($sessionManager);

Laravel users, _(*16)

We need to publish the config file that will allow you to very easily add all your account numbers., _(*17)

    php artisan vendor:publish --provider="psbhanu\Whatsapi\WhatsapiServiceProvider" --tag="config"

Now everything has been installed, you just need to add your Whatsapp account details into the config file. There will now be a personal config file created for you in whatsapidemo/config/whatsapi.php. Open this file and edit the details with your account info. Once saved, you're good to use the API!, _(*18)

Usage

Note: You must create the data storage path specified in configuration file. The path must be writable for webserver., _(*19)

Request registration code, _(*20)

When requesting the code, you can do it via SMS or voice call, in both cases you will receive a code like 123-456, that we will use for register the number., _(*21)

    $number = '5219511552222'; # Number with country code
    $type = 'sms'; # This can be either sms or voice

    $response = WhatsapiTool::requestCode($number, $type);

Example response:, _(*22)

    stdClass Object
    (
        [status] => sent
        [length] => 6
        [method] => sms
        [retry_after] => 1805
    )

Registration, _(*23)

If you received the code like this 123-456 you should register like this '123456', _(*24)

    $number = '5219511552222'; # Number with country code
    $code = '132456'; # Replace with received code  

    $response = WhatsapiTool::registerCode($number, $code);

If everything went right, this should be the output:, _(*25)

    [status] => ok
    [login] => 34123456789
    [pw] => 0lvOVwZUbvLSxXRk5uYRs3d1E=
    [type] => existing
    [expiration] => 1443256747
    [kind] => free
    [price] => EUR€0.99
    [cost] => 0.89
    [currency] => EUR
    [price_expiration] => 1414897682

See the entire registration process on https://github.com/WHAnonymous/Chat-API/wiki/WhatsAPI-Documentation#number-registration, _(*26)

Send messages, _(*27)

    // Retrieve user data from database, web service, and so on.
    // Dummy method, fake data.
    $user = new stdClass;
    $user->name = 'Benjamín Martínez Mateos';
    $user->phone = '5219512222222';

    $message = "Hello $user->name and welcome to our site";

    $messages = Whatsapi::send($message, function($send) use ($user)
    {
        $send->to($user->phone);

        // Add an audio file
        $send->audio('http://itnovado.com/example.mp3');

        // Add an image file
        $send->image('http://itnovado.com/example.jpg', 'Cool image');

        // Add a video file
        $send->video('http://itnovado.com/example.mp4', 'Fun video');

        // Add a location (Longitude, Latitude)
        $send->location(-89.164138, 19.412405, 'Itnovado Location');

        // Add a VCard
        $vcard = new psbhanu\Whatsapi\Media\VCard();

        $vcard->set('data', array(
            'first_name' => 'John',
            'last_name' => 'Doe',
            'tel' => '9611111111',
            ));

        $send->vcard('Xaamin', $vcard);

        // Add new text message
        $send->message('Thanks for subscribe');
    });

    foreach($messages as $message)
    {
        ...
    }

Check for new messages, _(*28)

    $messages = $messages = Whatsapi::getNewMessages();

    if($messages)
    {
        foreach($messages as $message)
        {
            ...
        }
    }

Sync contacts, _(*29)

    $result = Whatsapi::syncContacts(['5219512222222', '5219512222223']);

    foreach ($result->existing as $number => $account)
    {
        ... 
    }

    foreach ($result->nonExisting as $number)
    {
        ...
    }

Example response, _(*30)

    SyncResult Object
    (
        [index] => 0
        [syncId] => 130926960960000000
        [existing] => Array
            (
                [+5219512222222] => 5219512222222@s.whatsapp.net
            )

        [nonExisting] => Array
            (
                [0] => 5219512222223
            )

    )

Missing methods, _(*31)

You can use all power of the whatsapp/chat-api getting and instance of Whatsprot class. Read the whatsapp/chat-api wiki for available methods., _(*32)

    $whatsprot = Whatsapi::gateway();

    // Do stuff...

You can use on routes, cli... you got the idea., _(*33)