2024.05.29 2024.05.30

PHPでMattermostへメッセージ送信

hebishima.shogo

はい、hebiです。

PHPでMattermostへメッセージを送信する方法を記事にしたいと思います。

今回は、定期的なタスクの実行を行うcronを使ってMattermostへメッセージを送信してみます。

例えば、指定した時間に社員に向けて情報を発信したい場合などに有効です。

Contents

前提
Mattermostの設定
メッセージ送信処理実装
cronの実行
Mattermostへメッセージ送信確認
最後に

前提

以下の環境で動作確認を行います。

Mattermostの設定

Mattermostへメッセージを送信可能にするための設定を行います。

システムコンソールの表示

以下の操作でシステムコンソールを表示します。

パーソナルアクセストークンを有効にする

「統合機能」を選択し、パーソナルアクセストークンを有効にします。

アクセストークンの設定

プロフィールのセキュリティからアクセストークンを生成します。

Mattermostのバージョンによって操作が異なる可能性があります。

セキュリティーを見つけるのに一苦労でした(;’∀’)

アクセストークンをコピーしておきましょう。

送信するチャンネルのIDを取得

送信するチャンネルのIDを取得します。

コピーしておきましょう。

以上で設定完了です。

メッセージ送信処理実装

メッセージを送信する関数を実装します。

public function sendMessage()
{
    $mattermostUrl = "http://your-mattermost-server:8065";
    // ここに生成したアクセストークンを指定
    $apiToken = "9bb4owrd4t8dxcs5aooo4ezhrw";
    // ここに送信したいチャンネルのIDを指定
    $channelId = "4cki6gqt3fg1pepfzc86be8qaa";
    
    // 送信したいメッセージを指定
    $message = "Hello";

    $url = "$mattermostUrl/api/v4/posts";

    $data = [
        'channel_id' => $channelId,
        'message' => $message
    ];

    // cURLセッションの初期化
    $ch = curl_init($url);

    // cURLオプションの設定
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "Authorization: Bearer $apiToken",
        'Content-Type: application/json'
    ]);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

    // cURLリクエストの実行
    $response = curl_exec($ch);

    // HTTPステータスコードの取得
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    // cURLセッションのクローズ
    curl_close($ch);

    // レスポンスの確認
    if ($httpCode == 201) {
        return true;
    } else {
        return false;
    }
}

作成したsendMessageをcronのrunで呼び出します。

public function run(array $params)
{
    if ($this->sendMessage()){
        CLI::write('successfully.', 'green');
    }else{
        CLI::error('error');
    } 
}

以上で実装完了です。

実行してみましょう！