PHPackages                             sumihiro/laravel-line-works-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sumihiro/laravel-line-works-client

ActiveLibrary[API Development](/categories/api)

sumihiro/laravel-line-works-client
==================================

LINE WORKS API client for Laravel

v0.2.4(11mo ago)08MITPHPPHP ^8.1

Since Mar 15Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/sumihiro/laravel-line-works-client)[ Packagist](https://packagist.org/packages/sumihiro/laravel-line-works-client)[ RSS](/packages/sumihiro-laravel-line-works-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (9)Used By (0)

LINE WORKS API Client for Laravel
=================================

[](#line-works-api-client-for-laravel)

LINE WORKS APIをLaravelから簡単に利用するためのクライアントライブラリです。

機能
--

[](#機能)

- LINE WORKS APIの認証（JWT）
- Bot APIの利用
- Bot モニタリング機能（トーク内容ダウンロード）
- 複数のボット設定のサポート
- トークンのキャッシュ
- ログ機能

インストール
------

[](#インストール)

Composerを使用してインストールできます：

```
composer require sumihiro/laravel-line-works-client
```

設定
--

[](#設定)

### 設定ファイルの公開

[](#設定ファイルの公開)

以下のコマンドを実行して、設定ファイルを公開します：

```
php artisan vendor:publish --tag=lineworks-config
```

これにより、`config/lineworks.php`ファイルが作成されます。

### 環境変数の設定

[](#環境変数の設定)

`.env`ファイルに以下の設定を追加します：

```
# 基本認証に必須のパラメータ
LINEWORKS_SERVICE_ACCOUNT=your-service-account
LINEWORKS_PRIVATE_KEY=your-private-key
LINEWORKS_CLIENT_ID=your-client-id
LINEWORKS_CLIENT_SECRET=your-client-secret
LINEWORKS_DOMAIN_ID=your-domain-id
LINEWORKS_SCOPE=bot

# Bot機能を使用する場合に必須のパラメータ
LINEWORKS_BOT_ID=your-bot-id
LINEWORKS_BOT_SECRET=your-bot-secret

```

使用方法
----

[](#使用方法)

### ファサードの使用

[](#ファサードの使用)

```
use Sumihiro\LineWorksClient\Facades\LineWorks;

// デフォルトのボットを使用
$response = LineWorks::botClient()->message()->sendText('user123', 'こんにちは！');

// 特定のボットを指定
$response = LineWorks::botClient('another_bot')->message()->sendText('user123', 'こんにちは！');

// スコープを指定してAPIを呼び出す
$response = LineWorks::withScope('user')->get('users/info');
```

### DIの使用

[](#diの使用)

```
use Sumihiro\LineWorksClient\LineWorksManager;

class MyController
{
    protected $lineWorks;

    public function __construct(LineWorksManager $lineWorks)
    {
        $this->lineWorks = $lineWorks;
    }

    public function sendMessage()
    {
        $response = $this->lineWorks->botClient()->message()->sendText('user123', 'こんにちは！');

        if ($response->isSuccess()) {
            return 'メッセージを送信しました！ ID: ' . $response->getMessageId();
        }

        return 'メッセージの送信に失敗しました。';
    }

    public function getUserInfo()
    {
        // スコープを指定してAPIを呼び出す
        $response = $this->lineWorks->withScope('user')->get('users/info');
        return json_decode($response->getBody(), true);
    }
}
```

### LineWorksClientを単体で使用する場合

[](#lineworksclientを単体で使用する場合)

Laravelのサービスコンテナやファサードを使わずに、直接LineWorksClientを使用することもできます。使用目的に応じて必要なパラメータが異なります：

#### 1. Bot機能を使用する場合（BotClient使用時）

[](#1-bot機能を使用する場合botclient使用時)

```
use GuzzleHttp\Client;
use Sumihiro\LineWorksClient\Auth\JwtTokenGenerator;
use Sumihiro\LineWorksClient\Auth\AccessTokenManager;
use Sumihiro\LineWorksClient\LineWorksClient;
use Sumihiro\LineWorksClient\Bot\BotClient;

// ボットの設定（Bot機能を使用する場合）
$botConfig = [
    // 基本認証に必須のパラメータ
    'service_account' => 'your-service-account',
    'private_key' => 'your-private-key',
    'client_id' => 'your-client-id',
    'client_secret' => 'your-client-secret',
    'domain_id' => 'your-domain-id',
    'scope' => 'bot', // スコープを指定（デフォルトは 'bot'）

    // Bot機能を使用する場合に必須のパラメータ
    'bot_id' => 'your-bot-id',
    'bot_secret' => 'your-bot-secret',
];

// グローバル設定
$globalConfig = [
    'api_base_url' => 'https://www.worksapis.com/v1.0/',
    'cache' => [
        'enabled' => false,
    ],
    'logging' => [
        'enabled' => false,
    ],
];

// LineWorksClientのインスタンスを作成
$client = new LineWorksClient('default', $botConfig, $globalConfig);

// BotClientを使用する場合
$botClient = new BotClient($client);
$messageResponse = $botClient->message()->sendText('user123', 'こんにちは！');

if ($messageResponse->isSuccess()) {
    echo 'メッセージを送信しました！ ID: ' . $messageResponse->getMessageId();
} else {
    echo 'メッセージの送信に失敗しました。';
}
```

#### 2. Bot機能を使用しない場合（LineWorksClientのみ使用時）

[](#2-bot機能を使用しない場合lineworksclientのみ使用時)

```
use GuzzleHttp\Client;
use Sumihiro\LineWorksClient\Auth\JwtTokenGenerator;
use Sumihiro\LineWorksClient\Auth\AccessTokenManager;
use Sumihiro\LineWorksClient\LineWorksClient;

// 基本設定（Bot機能を使用しない場合）
$config = [
    // 基本認証に必須のパラメータ
    'service_account' => 'your-service-account',
    'private_key' => 'your-private-key',
    'client_id' => 'your-client-id',
    'client_secret' => 'your-client-secret',
    'domain_id' => 'your-domain-id',
    'scope' => 'user', // スコープを指定（例: 'user', 'admin', 'contact' など）

    // Bot機能を使用しない場合は不要
    // 'bot_id' => 'your-bot-id',
    // 'bot_secret' => 'your-bot-secret',
];

// グローバル設定
$globalConfig = [
    'api_base_url' => 'https://www.worksapis.com/v1.0/',
    'cache' => [
        'enabled' => false,
    ],
    'logging' => [
        'enabled' => false,
    ],
];

// LineWorksClientのインスタンスを作成
$client = new LineWorksClient('default', $config, $globalConfig);

// 一般的なAPIリクエストを送信
$response = $client->get('users/info');
$userData = json_decode($response->getBody(), true);

echo 'ユーザー情報: ' . print_r($userData, true);

// 実行時にスコープを変更する場合
$client->setScope('admin');
$adminResponse = $client->get('admin/users');
```

複数のボットの設定
---------

[](#複数のボットの設定)

`config/lineworks.php`ファイルで複数のボットを設定できます：

```
'bots' => [
    'default' => [
        // 基本認証に必須のパラメータ
        'service_account' => env('LINEWORKS_SERVICE_ACCOUNT'),
        'private_key' => env('LINEWORKS_PRIVATE_KEY'),
        'client_id' => env('LINEWORKS_CLIENT_ID'),
        'client_secret' => env('LINEWORKS_CLIENT_SECRET'),
        'domain_id' => env('LINEWORKS_DOMAIN_ID'),
        'scope' => env('LINEWORKS_SCOPE', 'bot'), // スコープを指定（デフォルトは 'bot'）

        // Bot機能を使用する場合に必須のパラメータ
        'bot_id' => env('LINEWORKS_BOT_ID'),
        'bot_secret' => env('LINEWORKS_BOT_SECRET'),
    ],
    'another_bot' => [
        // 基本認証に必須のパラメータ
        'service_account' => env('LINEWORKS_ANOTHER_SERVICE_ACCOUNT'),
        'private_key' => env('LINEWORKS_ANOTHER_PRIVATE_KEY'),
        'client_id' => env('LINEWORKS_ANOTHER_CLIENT_ID'),
        'client_secret' => env('LINEWORKS_ANOTHER_CLIENT_SECRET'),
        'domain_id' => env('LINEWORKS_ANOTHER_DOMAIN_ID'),
        'scope' => env('LINEWORKS_ANOTHER_SCOPE', 'bot'), // スコープを指定（デフォルトは 'bot'）

        // Bot機能を使用する場合に必須のパラメータ
        'bot_id' => env('LINEWORKS_ANOTHER_BOT_ID'),
        'bot_secret' => env('LINEWORKS_ANOTHER_BOT_SECRET'),
    ],
],
```

Bot APIの使用例
-----------

[](#bot-apiの使用例)

### メッセージ送信

[](#メッセージ送信)

```
use Sumihiro\LineWorksClient\Facades\LineWorks;

// テキストメッセージの送信
$response = LineWorks::botClient()->message()->sendText('user123', 'こんにちは！');

// 一般的なメッセージの送信
$response = LineWorks::botClient()->message()->sendMessage('user123', [
    'content' => [
        'type' => 'text',
        'text' => 'こんにちは！',
    ],
]);

// チャンネルへのメッセージ送信
$response = LineWorks::botClient()->channel()->sendMessage('channel123', [
    'content' => [
        'type' => 'text',
        'text' => 'チャンネルのみなさん、こんにちは！',
    ],
]);
```

### トークルーム（チャンネル）関連

[](#トークルームチャンネル関連)

```
use Sumihiro\LineWorksClient\Facades\LineWorks;

// トークルームの作成
$response = LineWorks::botClient()->channel()->create(
    ['user1@example.com', 'user2@example.com'],
    'プロジェクトA チーム'
);
$channelId = $response->getChannelId();

// トークルーム情報の取得
$channelInfo = LineWorks::botClient()->channel()->info($channelId);
echo 'チャンネル名: ' . $channelInfo->getName();

// トークルームのメンバーリスト取得
$members = LineWorks::botClient()->channel()->members($channelId);
foreach ($members->getMembers() as $member) {
    echo 'メンバー: ' . $member['accountId'];
}

// トークルームからの退室
$result = LineWorks::botClient()->channel()->leave($channelId);
if ($result) {
    echo 'チャンネルから退室しました';
}
```

### リッチメニュー関連

[](#リッチメニュー関連)

```
use Sumihiro\LineWorksClient\Facades\LineWorks;

// リッチメニューの作成
$richMenu = [
    'name' => 'マイリッチメニュー',
    'size' => [
        'width' => 2500,
        'height' => 1686,
    ],
    'areas' => [
        [
            'bounds' => [
                'x' => 0,
                'y' => 0,
                'width' => 1250,
                'height' => 1686,
            ],
            'action' => [
                'type' => 'message',
                'text' => 'アクション1',
            ],
        ],
        [
            'bounds' => [
                'x' => 1250,
                'y' => 0,
                'width' => 1250,
                'height' => 1686,
            ],
            'action' => [
                'type' => 'message',
                'text' => 'アクション2',
            ],
        ],
    ],
];

$response = LineWorks::botClient()->richMenu()->create($richMenu);
$richMenuId = $response->getRichMenuId();

// リッチメニューの詳細情報を取得
$richMenuInfo = LineWorks::botClient()->richMenu()->get($richMenuId);
echo 'リッチメニュー名: ' . $richMenuInfo->getName();

// リッチメニュー画像のアップロード
// 注意: 画像サイズはリッチメニューのサイズと一致する必要があります（この例では2500x1686ピクセル）
$result = LineWorks::botClient()->richMenu()->uploadImage($richMenuId, '/path/to/richmenu-image.jpg');

// リッチメニューをユーザーに設定
$result = LineWorks::botClient()->richMenu()->setForUser('user123', $richMenuId);

// ユーザーのリッチメニューを取得
$userRichMenu = LineWorks::botClient()->richMenu()->getForUser('user123');

// リッチメニューの削除
$result = LineWorks::botClient()->richMenu()->delete($richMenuId);

// デフォルトリッチメニューの設定
$result = LineWorks::botClient()->richMenu()->setDefault($richMenuId);

// デフォルトリッチメニューの取得
$defaultRichMenu = LineWorks::botClient()->richMenu()->getDefault();

// デフォルトリッチメニューの削除
$result = LineWorks::botClient()->richMenu()->deleteDefault();
```

### ボット管理関連

[](#ボット管理関連)

```
use Sumihiro\LineWorksClient\Facades\LineWorks;

// ボット情報の取得
$botInfo = LineWorks::botClient()->management()->info();
echo 'ボット名: ' . $botInfo->getName();
echo 'ステータス: ' . $botInfo->getStatus();

// ドメイン情報の取得
$domainInfo = LineWorks::botClient()->management()->domainInfo();
echo 'ドメインID: ' . $domainInfo['domainId'];
echo 'ドメイン名: ' . $domainInfo['domainName'];
```

スコープについて
--------

[](#スコープについて)

LINE WORKS APIでは、アクセストークンを取得する際に「スコープ」を指定する必要があります。スコープによって、アクセスできるAPIが異なります。

主なスコープ：

- `bot`: ボット関連のAPI（デフォルト）
- `user`: ユーザー情報関連のAPI
- `admin`: 管理者向けAPI

複数のスコープを指定する場合は、スペース区切りで指定します：

```
'scope' => 'bot user calendar', // 複数のスコープを指定
```

エラーハンドリング
---------

[](#エラーハンドリング)

```
use Sumihiro\LineWorksClient\Exceptions\ApiException;
use Sumihiro\LineWorksClient\Exceptions\AuthenticationException;
use Sumihiro\LineWorksClient\Exceptions\ConfigurationException;

try {
    $response = LineWorks::botClient()->message()->sendText('user123', 'こんにちは！');
} catch (ApiException $e) {
    // API呼び出しエラー
    $statusCode = $e->getStatusCode();
    $responseData = $e->getResponseData();

    Log::error('LINE WORKS APIエラー', [
        'status_code' => $statusCode,
        'response' => $responseData,
        'message' => $e->getMessage(),
    ]);
} catch (AuthenticationException $e) {
    // 認証エラー
    Log::error('LINE WORKS認証エラー', [
        'message' => $e->getMessage(),
    ]);
} catch (ConfigurationException $e) {
    // 設定エラー
    Log::error('LINE WORKS設定エラー', [
        'message' => $e->getMessage(),
    ]);
}
```

サンプルスクリプト
---------

[](#サンプルスクリプト)

このライブラリには、LINE WORKS APIの動作確認を行うためのサンプルスクリプトが含まれています。

### 設定

[](#設定-1)

1. `examples/config.example.php` をコピーして `examples/config.php` を作成します。
2. `examples/config.php` に実際の認証情報を設定します。

```
return [
    // 基本認証に必須のパラメータ
    'service_account' => 'your-service-account',
    'private_key' => 'your-private-key',
    'client_id' => 'your-client-id',
    'client_secret' => 'your-client-secret',
    'domain_id' => 'your-domain-id',
    'scope' => 'bot',

    // Bot機能を使用する場合に必須のパラメータ
    'bot_id' => 'your-bot-id',
    'bot_secret' => 'your-bot-secret',

    // テスト用のパラメータ
    'test_account_id' => 'test-user@example.com', // テスト用のアカウントID
    'test_channel_id' => 'test-channel-id', // テスト用のチャンネルID
];
```

### メッセージ送信

[](#メッセージ送信-1)

```
# テキストメッセージの送信
php examples/send_message.php user@example.com "こんにちは！"

# 設定ファイルに指定されたテストアカウントにメッセージを送信
php examples/send_message.php
```

### チャンネル（トークルーム）操作

[](#チャンネルトークルーム操作)

```
# チャンネルの作成
php examples/channel_operations.php create "テストチャンネル" user1@example.com user2@example.com

# チャンネル情報の取得
php examples/channel_operations.php info channel-id

# チャンネルのメンバーリスト取得
php examples/channel_operations.php members channel-id

# チャンネルにメッセージを送信
php examples/channel_operations.php send channel-id "こんにちは！"

# チャンネルから退室
php examples/channel_operations.php leave channel-id
```

### リッチメニュー操作

[](#リッチメニュー操作)

```
# リッチメニューの一覧取得
php examples/rich_menu_operations.php list

# リッチメニューの作成
php examples/rich_menu_operations.php create "テストメニュー"

# リッチメニューの詳細情報取得
php examples/rich_menu_operations.php get rich-menu-id

# リッチメニュー画像のアップロード
php examples/rich_menu_operations.php upload rich-menu-id /path/to/image.jpg

# ユーザーにリッチメニューを設定
php examples/rich_menu_operations.php set-user rich-menu-id user@example.com

# ユーザーのリッチメニュー取得
php examples/rich_menu_operations.php get-user user@example.com

# ユーザーのリッチメニュー削除
php examples/rich_menu_operations.php delete-user user@example.com

# デフォルトリッチメニューの設定
php examples/rich_menu_operations.php set-default rich-menu-id

# デフォルトリッチメニューの取得
php examples/rich_menu_operations.php get-default

# デフォルトリッチメニューの削除
php examples/rich_menu_operations.php delete-default

# リッチメニューの削除
php examples/rich_menu_operations.php delete rich-menu-id
```

ライセンス
-----

[](#ライセンス)

MIT

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance53

Moderate activity, may be stable

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~12 days

Recently: every ~3 days

Total

8

Last Release

334d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/698b613f5ef7d755d33628c3ad47a97bf341996fb6d176f21e478a4f33d81c5a?d=identicon)[sumihiro](/maintainers/sumihiro)

---

Top Contributors

[![sumihiro](https://avatars.githubusercontent.com/u/98380?v=4)](https://github.com/sumihiro "sumihiro (16 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/sumihiro-laravel-line-works-client/health.svg)

```
[![Health](https://phpackages.com/badges/sumihiro-laravel-line-works-client/health.svg)](https://phpackages.com/packages/sumihiro-laravel-line-works-client)
```

###  Alternatives

[laravel/socialite

Laravel wrapper around OAuth 1 & OAuth 2 libraries.

5.7k96.9M674](/packages/laravel-socialite)[simplestats-io/laravel-client

Client for SimpleStats!

4515.5k](/packages/simplestats-io-laravel-client)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)[njoguamos/laravel-plausible

A laravel package for interacting with plausible analytics api.

208.8k](/packages/njoguamos-laravel-plausible)[surface/laravel-webfinger

A Laravel package to create an ActivityPub webfinger.

113.8k](/packages/surface-laravel-webfinger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)