Line Api Laravel Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require chitanok/line-api-laravel
   

   Publish the config file:

   php artisan vendor:publish --provider="Chitanok\LineApiLaravel\LineServiceProvider" --tag="config"
   

2. Configuration Edit .env with your LINE Developer credentials:

   LINE_CHANNEL_SECRET=your_channel_secret
   LINE_CHANNEL_ACCESS_TOKEN=your_channel_access_token
   LINE_BOT_ID=your_bot_id
   LINE_BOT_SECRET=your_bot_secret
   

3. First Use Case: Webhook Setup Add the middleware to routes/web.php:

   Route::post('/line-webhook', [LineWebhookController::class, 'handle']);
   

   Register the webhook URL in the LINE Developers Console.

4. Sending a Simple Message

   use Chitanok\LineApiLaravel\Facades\Line;
   
   Line::sendMessage('User ID', 'Hello from Laravel!');
   

Implementation Patterns

Core Workflows

1. Handling Incoming Events Extend LineWebhookController to process events:

   public function handle(Request $request)
   {
       $events = Line::parseEvents($request->getContent());
   
       foreach ($events as $event) {
           if ($event->type === 'message') {
               $this->handleMessage($event);
           }
       }
   }
   

2. Rich Message Responses Use built-in message types:

   Line::sendMessage('user123', [
       'type' => 'flex',
       'altText' => 'Flex Message',
       'contents' => ['type' => 'bubble', ...],
   ]);
   

3. User Management Fetch user profiles:

   $user = Line::getProfile('user123');
   

4. Broadcasting to Groups

   Line::sendMessage('group123', 'Hello group!');
   

Integration Tips

• Middleware: Use LineAuthMiddleware to validate requests in protected routes.
• Events: Bind to line.event for global event handling:

  event(new LineEvent($event));
  

• Queue Jobs: Offload responses to LineMessageJob for async processing:

  dispatch(new LineMessageJob('user123', 'Delayed message'));
  

Gotchas and Tips

Common Pitfalls

1. Webhook Verification

   • Always validate X-Line-Signature in production:

     if (!Line::validateSignature($request->header('X-Line-Signature'), $request->getContent())) {
         abort(401);
     }
     

   • Test locally with LINE_DEBUG=true in .env.

2. Rate Limits

   • LINE API enforces rate limits. Cache frequent requests.

3. Message Failures

   • Implement retry logic for failed messages using Line::sendMessage()’s options:

     Line::sendMessage('user123', 'Message', ['retry' => 3]);
     

4. Flex Message Bubble Validation

   • Use the LINE Flex Message Editor to validate JSON before sending.

Debugging

• Enable debug mode in .env:

  LINE_DEBUG=true
  

• Log raw events for inspection:

  \Log::debug('LINE Event', ['event' => $event->toArray()]);
  

Extension Points

1. Custom Event Handlers Override LineEvent to add custom logic:

   class CustomLineEvent extends LineEvent {
       public function handle()
       {
           if ($this->type === 'sticker') {
               // Custom sticker logic
           }
       }
   }
   

2. Provider Extensions Bind custom services in AppServiceProvider:

   $this->app->bind('line.custom', function () {
       return new CustomLineService();
   });
   

3. Template Messages Use Line::sendTemplateMessage() for pre-designed templates (e.g., confirmations):

   Line::sendTemplateMessage('user123', 'template_id', ['key' => 'value']);