phattarachai/line-notify

PHP and Laravel API for Line application notification.

2.0.4 2022-11-22 05:02 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• phpunit/phpunit: ^9.5
• vlucas/phpdotenv: ^5.3

MIT

• Phattarachai Chaimongkol

• php
• line
• laravel
• phattarachai
• line-notify

README

The package for Laravel and PHP for Line application notification.

Line Notify is a package for Laravel and PHP application to easily send notification to Line messaging application users or groups. It builds on top of Line Notify API, that provides a fluent interface to send messages, images ,and stickers directly to Line service from Laravel and PHP.

Installing Line Notify

You need to use Composer to install Line-Notify into your project:

composer require phattarachai/line-notify

Laravel Usage

Add a LINE_ACCESS_TOKEN variable to your .env. You can get an access token for your application from Line Notify API

// .env
LINE_ACCESS_TOKEN=#Token Go here#

Send a message via Line Notify.

use Phattarachai\LineNotify\Facade\Line;

Line::send('message');

You can use setToken() to specify other ACCESS_TOKEN you want to use beside from the .env.

use Phattarachai\LineNotify\Facade\Line;

Line::setToken(/*...access token */)
    ->send('message');

Send a message with an image.

Line::imageUrl('https://lorempixel.com/1024/1024/')
    ->send('message');

You can also specify a thumbnail for your image

Line::thumbnailUrl('https://lorempixel.com/240/240/')
    ->imageUrl('https://lorempixel.com/1024/1024/')
    ->send('message');

You can upload an image from your local path

Line::imagePath('/path/to/your/image.png')
    ->send('message');

You can combine image uploading and image url together. The uploaded image will take precedence to image url.

Line::thumbnailUrl('https://lorempixel.com/240/240/')
    ->imageUrl('https://lorempixel.com/1024/1024/')
    ->imagePath('/path/to/your/image.png')
    ->send('message');

Send a message with sticker. You can find a list of Sticker Package ID and Sticker ID here https://devdocs.line.me/files/sticker_list.pdf

Line::sticker(1, 138)
    ->send('message');

Notice that Line require to have a message for each and every request whether you send an image or sticker you still required to provide a message for the API.

Publishing the configuration file

Alternatively to adding a variable into your .env, you can publish config/line-notify.php file and add your token there.

Run the following Artisan command in your terminal:

php artisan vendor:publish --provider="Phattarachai\LineNotify\LineNotifyServiceProvider"

You can set the token in this file.

// File: /config/line-notify.php
return [
    'access_token' => env('LINE_ACCESS_TOKEN'),
];

Configuring (Laravel)

Laravel 5.5 and newer

Line Notify wil register itself using Laravel's Auto Discovery.

Laravel 5.4 and older

You'll have to include LineNotifyServiceProvider in your config/app.php:

'providers' => [
    /*
     * Package Service Providers...
     */
    Phattarachai\LineNotify\LineNotifyServiceProvider::class,
]

PHP Usage (outside Laravel)

use Phattarachai\LineNotify\Line;

$line = new Line('YOUR-API-TOKEN-HERE');
$line->send('message');

Screenshot

สนับสนุนผู้พัฒนา

🙋‍♂️ สวัสดีครับ ผมอ๊อฟนะครับ เป็น Full Stack Web Developer มีสร้าง package ขึ้นมาใช้งานในโปรเจคตัวเองที่ใช้งานบ่อย ๆ ถ้ามีข้อเสนอแนะอยากให้ทำ package อะไรบน PHP / Laravel / NodeJS / Python หรือภาษาอื่น ๆ ทักทายมาได้เลยครับ

line: phat-chai

💻 รับงาน Freelance หากมีโปรเจคที่น่าสนใจ หาทีมงานร่วมงาน หาโปรแกรมเมอร์ที่มีประสบการณ์ช่วยแก้โจทย์ที่ท้าทาย ติดต่อมาได้เลยครับ ยินดีให้ความช่วยเหลือและรอสร้างผลงานที่ดีร่วมกันครับ

📄 เข้ามาดูประวัติและผลงานได้ที่ https://phattarachai.dev

License

The MIT License (MIT)