Download the PHP package alresia/laravel-wassenger without Composer

On this page you can find all versions of the php package alresia/laravel-wassenger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
alresia/laravel-wassenger
Rate from 1 - 5
Rated 5.00 based on 4 reviews

Example code of alresia/laravel-wassenger

Informations about the package laravel-wassenger

LARAVEL WASSENGER DOCUMENTATION

WhatsApp Business Api for Larave Using Wassenger Api laravel-wassenger-logo

For more info about Wassenger follow https://www.wassenger.com.

INTRODUCTION

This API documentation provides detailed information about the LARAVEL WASSENGER and WASSENGER endpoints request/response API contracts.

You can easily connect, send request and recieve response on most usable and important endpoint in wassenger using php.

This Package has been built with expection to help ease the time connecting and intergrating WhatsApp on our Application.

With the help of Wassenger Api and it well structured to work on Laravel framework.

IF You like this package please consider supporting by adding a star and introduce this to your friends

INSTALLATION & SETUP

On Composer

Laravel Wassenger is available on Packagist (using semantic versioning), and installation via Composer is the recommended way to install this Package. Just add this line to your composer.json file:

or run

From Laravel Controller

Using Composer Directly

using composer directly require composer autoload file

Using Without Composer

Alternatively, if you're not using Composer or Laravel Application, you can download Laravel-Wassenger as a zip file, then copy the contents of the folder into the directory of your php application and load wassenger-loader.php':

CONFIGURATION

Laravel

Laravel Wassenger was made to work out-of-the-box, you can override the configuration by simply publishing the config file in laravel.

After that, you will receive the config/wassenger.php config file with an array like this:

Others Application

The Configuration file is Located at laravel-wassenger/src/Config.php

Api Keys

The WASSENGER_API_KEY is Required to use this package

To get Your API KEY go to Wassanger Console and Get a Api Key

if you are using Larevel just head over to your .env file to set your Api key and Default device

if you want the application to return a Json response instead of an Error Exception
Change the Return JSON Errors to true from the config file

This is usefull if you want to manage error responses

USAGE

This deals with four endpoint of Wassenger. Doh it only has the most used and important functions

Class Description
Wassenger::class* This is the main class of Laravel Wassenger. It contain most usefull methods controlling the packages
Messages::class* Send, browse and manage outbound messages
Devices::class * Manage Conneted Device and See status.
Session::class Manage WhatsApp session status synchronization.

Classes

Main Wassenger Class

To use include the LaravelWassenger\Wassenger namespace in your file;

The following available methods are:

Method Description Parameters
numberExist()
see example		 Check if a given phone number exists in WhatsApp and is able to receive messages. The number format must be in E164 format.
You can check one number at a time.		 @param String $phone *required
sessionSync()
see example		 Force WhatsApp session status synchronization of a device.
Note: if you do not specify an ID, will use default device id from config		 @param String|Null $deviceId *optional
syncAll()
see example		 Force synchronize all device session status.
Note: This method uses a loop in getting all devices then synchronize them. It will skip device that is already synchronized or last synchronize in less than 60 seconds.
Avoid running this function if you have too many device connected to your account.		 @param Null

Examples:

Number Exist

Sync device session

Sync all device session

Messages

To use include the LaravelWassenger\Messages namespace in your file;

The following available methods are available for sending messages in this package, which you can See the full details here:

Method Description Parameters
message()
see example		 Use to attached text and user phone number. phone(string:requires) , message (string:required), enqueue (bool:optional)(default:false)
messageGroup()
see example		 message a group. group_id(string:requires) , message (string:required), enqueue (bool:optional)
agent() Optional Agent ID to send the message on behalf of. The chat will not be assigned to the agent unless explicitly defined via message actions. The agent must have access permissions to the device. You can retrieve the agents ID from Here agent_id(string:optional)
contacts() Send one or multiple contact cards to a target phone or group chat. Contact is composed based on an E164 international phone number and contact name. Contact name can have spaces representing a person full name. You can send up to 10 contacts in a single message. Array ([ 1 .. 10 ] items)
phone string [ 6 .. 16 ] characters
- required.
name string [ 1 .. 40 ] characters
- required
device() Device ID to be used for message delivery. If not defined, the first created device will be used by default. You can use this to arbitrary send messages across multiple devices connected to your account. You can get the device ID from the Web Console > Devices deviceId (string required)
location() Send location details Array ([ 1 .. 10 ] items)
address string [ 3 .. 100 ] characters.
name string <= 100 characters characters
* coordinates
Array of numbers = 2 items [ items [ -180 .. 180 ] ]
expiration() Define a message time-to-live (ttl) expiration time. Use this if you want to automatically do not send a message if the delivery was not possible after a while. E.g: 1h. Object
seconds number [ 5 .. 8035200 ]
duration string [ 2 .. 5 ] characters
* date
string \
schedule()
see example		 Schedule a Message. delay(string required)
deliverAt()
see example		 Schedule to a given time. ISO_Date (required)
media()
see example		 Attach a file. file_array(arrays) ['file'=>'24 characters length file ID']
buttons()
see example		 Add action Buttons. butttons_array() Check documentation
findById()
see example		 Get a specific message by ID. string
header() Experimental: optional message header text, restricted to messages with reply buttons. Important: feature not yet available in Multi-Device enabled WhatsApp sessions. The API will return an error if message type is not supported in your linked WhatsApp number. string <= 60 characters
footer() Experimental: optional message footer text, restricted to messages with reply buttons. Important: feature not yet available in Multi-Device enabled WhatsApp sessions. The API will return an error if message type is not supported in your linked WhatsApp number. string <= 60 characters
raw() Direct use wassenger Api. if you are not satisfy with laraval-wassenger or you can't find what you want here. you can send request directly using this method Use add desires params Messages::raw($paramsArray)->send(); objects (required)
search()
[see example]()		 Searching from message list. arrays (required)
find() Alternatives for search(). arrays (required)
get() Get the Specified Resource. null
delete() Delete the specific resource. string null
send() This method initailizes and connect to the message to Wassenger endpoint. none

Example Usage

Send text message to a phone number

Send text message with high priority to a group

Send media message to user. Note the file must be updated first, see API endpoint: Files > Upload file

Send text message that should be delivered now

Send a scheduled messages with a custom delay.

See "schedule.delayTo" datetime notation shortcuts: https://i.ibb.co/g3DJLSH/datetime-shortcuts.png

Send a scheduled messages at a concrete date with a valid ISO 8601 date

If You want to attach action buttons to your message

Getting a Message

Updating a Message

Deleting a Message

Alternatively you can delete a message passing the message ID inside the delete() mothod with using the findById() method

Device

To use include the LaravelWassenger\Device namespace in your file;

The following available methods are:

Method Description Parameters
findById()
see example		 Retrieve device details by ID. @param String $deviceId *required
search()
see example		 Search devices by phone number, alias or ID. For multiple value searches use comma-separeted values. E.g: +2348113536471,61b37a069cba0c15d6c81000 @param String $values
status()
see example		 Search devices by status. E.g: operative, pending, disabled, removed @param String Default: "any" Enum: "any" "invalid" "banned" "removed" "disabled" "unpaid" "preload" "pending" "authorized" "verified" "operative"
session()
see example		 Search devices by session status. E.g: authorize, online, timeout, offline, error @param String Enum: "any" "online" "offline" "timeout" "timeout_sync" "conflict" "blocked" "error" "authorize" "authorizing" "new" "loading" "offline_panel"
limit()
see example		 Limiting the size of the result and get result by pages. This method helps when working with paginations @param String $page
\ [ 1 .. 100 ]
Default: 0
get()
see example		 Get the Specified Resource. @param [Arrays|Objects Null](#params) $data

Examples:

Get account devices

Get device by ID

Search devices by phone number, alias or IDs

Get only verified devices

Get only pending devices

Get device by session online

Get device session

Search devices by phone number, alias or IDs that is verified

Search devices by phone number, alias or IDs that is online

Search devices by phone number, alias or IDs that is online

Sorting Result

All method can be used after another

Also You can select or use all params incase not listed here using the get

Sessions

This function is already exist in other class methods

see https://app.wassenger.com/docs/#tag/Devices/operation/searchDevices to use this method properly

Contributing

All Contribution are welcome here. feel free to email me Fidelis E Peter.

Also you can drop an issue if you observe any

Thank you for considering contributing to the Laravel Wassenger!

Package

This package doesn't require any extra packages

You can also use these package for None Laravel App

NOTE: Changing host and version either from the Config.php or the wassenger.php is not neccessary unless if you know what you are doing

All versions of laravel-wassenger with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
ext-curl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package alresia/laravel-wassenger contains the following files

Loading the files please wait ....