# Chatwork APIを活用してSlack代替チャットBotを作ってみた

## 目次
1. はじめに
2. Chatwork APIの概要と基本設定
   1-1. Chatwork APIの準備
   1-2. APIキーの取得方法
   1-3. APIの基本的な使い方
3. チャットBotの設計
   3-1. 使用する技術スタック
   3-2. Botの基本機能
4. Botの実装
   4-1. メッセージ送受信の実装
   4-2. ユーザーインターフェースのデザイン
   4-3. 対応可能なコマンド一覧
5. テストとデプロイ
   5-1. テスト環境の構築
   5-2. デプロイ手順
6. まとめ

## 1. はじめに
企業環境におけるチャットツールとしてSlackは非常に人気がありますが、コストやセキュリティの問題で導入に踏み切れないケースも存在します。そこで、今回はChatwork APIを用いてSlackの代替となるチャットBotを開発しました。Chatworkは日本向けに最適化されたビジネスチャットツールで、APIを活用することで色々な機能を実現できます。

## 2. Chatwork APIの概要と基本設定

### 2-1. Chatwork APIの準備
Chatwork APIは、Chatworkのアカウントで作成したAPIキーを用いて、さまざまなサービスと連携することができます。まずは、Chatwork APIを使うための設定を行います。

### 2-2. APIキーの取得方法
APIキーはChatworkの「パーソナル設定」から取得できます。「API設定」のタブに移動し、「新しいAPIトークンを発行」でAPIキーを生成します。このキーは他者に見せないように注意し、環境変数でするなどしてセキュアに管理します。

### 2-3. APIの基本的な使い方
APIリクエストはHTTPを通じて行います。以下に、Pythonでの基本的なGETリクエストの例を示します。

![img](/mosaic-code.jpg)

## 3. チャットBotの設計

### 3-1. 使用する技術スタック
- プログラミング言語：Python
- Webフレームワーク：Flask
- データベース：SQLite
- サーバー：Heroku

### 3-2. Botの基本機能
- 指定したChatworkグループに自動でメッセージをポスト
- ユーザーの質問に対する自動応答
- 業務報告書の生成と送信

## 4. Botの実装

### 4-1. メッセージ送受信の実装
Chatwork APIを利用してメッセージを送信するには、`POST /rooms/room_id/messages`エンドポイントを使用します。

![img](/mosaic-code.jpg)

### 4-2. ユーザーインターフェースのデザイン
ユーザーインターフェースは簡単なウェブベースの管理画面を作成しました。ここから手動でメッセージを送ることも可能とし、Botの設定やログを見ることもできます。

### 4-3. 対応可能なコマンド一覧
- `/hello`: 挨拶を返す
- `/report`: 毎日の業務報告を送信
- `/help`: 使用できる全てのコマンドを表示

## 5. テストとデプロイ

### 5-1. テスト環境の構築
ローカル環境でBotの動作を確認するため、`pytest`を用いて単体テストを行いました。APIキーは仮のものを設定し、実際のデータの送受信はMockライブラリで処理します。

### 5-2. デプロイ手順
Herokuにデプロイすることで、外部からアクセス可能なBotを稼働させました。デプロイスクリプトを用意し、GitHub Actionsを使った継続的デプロイを設定しました。

## 6. まとめ
今回のプロジェクトを通じて、Chatwork APIの柔軟性と可能性を強く感じました。Slack等と比べると機能は限られますが、コストを抑えたい企業にとっては非常に有用な選択肢です。今後はさらに機能を拡張し、より多くの業務を自動化することで、さらなる効率化を図りたいと考えています。 [cv:issue_marketplace_engineer]

# Chatwork APIを活用してSlack代替チャットBotを作ってみた

## 目次
1. はじめに
2. Chatwork APIの概要と基本設定
   1-1. Chatwork APIの準備
   1-2. APIキーの取得方法
   1-3. APIの基本的な使い方
3. チャットBotの設計
   3-1. 使用する技術スタック
   3-2. Botの基本機能
4. Botの実装
   4-1. メッセージ送受信の実装
   4-2. ユーザーインターフェースのデザイン
   4-3. 対応可能なコマンド一覧
5. テストとデプロイ
   5-1. テスト環境の構築
   5-2. デプロイ手順
6. まとめ

## 1. はじめに
企業環境におけるチャットツールとしてSlackは非常に人気がありますが、コストやセキュリティの問題で導入に踏み切れないケースも存在します。そこで、今回はChatwork APIを用いてSlackの代替となるチャットBotを開発しました。Chatworkは日本向けに最適化されたビジネスチャットツールで、APIを活用することで色々な機能を実現できます。

## 2. Chatwork APIの概要と基本設定

### 2-1. Chatwork APIの準備
Chatwork APIは、Chatworkのアカウントで作成したAPIキーを用いて、さまざまなサービスと連携することができます。まずは、Chatwork APIを使うための設定を行います。

### 2-2. APIキーの取得方法
APIキーはChatworkの「パーソナル設定」から取得できます。「API設定」のタブに移動し、「新しいAPIトークンを発行」でAPIキーを生成します。このキーは他者に見せないように注意し、環境変数でするなどしてセキュアに管理します。

### 2-3. APIの基本的な使い方
APIリクエストはHTTPを通じて行います。以下に、Pythonでの基本的なGETリクエストの例を示します。

```python
import requests

API_KEY = 'your_api_key'
headers = {
    'X-ChatWorkToken': API_KEY
}

response = requests.get('https://api.chatwork.com/v2/rooms', headers=headers)
print(response.json())
```

## 3. チャットBotの設計

### 3-1. 使用する技術スタック
- プログラミング言語：Python
- Webフレームワーク：Flask
- データベース：SQLite
- サーバー：Heroku

### 3-2. Botの基本機能
- 指定したChatworkグループに自動でメッセージをポスト
- ユーザーの質問に対する自動応答
- 業務報告書の生成と送信

## 4. Botの実装

### 4-1. メッセージ送受信の実装
Chatwork APIを利用してメッセージを送信するには、`POST /rooms/room_id/messages`エンドポイントを使用します。

```python
def send_message(room_id, message):
    url = f'https://api.chatwork.com/v2/rooms/{room_id}/messages'
    headers = {'X-ChatWorkToken': API_KEY}
    data = {'body': message}

    response = requests.post(url, headers=headers, data=data)
    return response.json()
```

### 4-2. ユーザーインターフェースのデザイン
ユーザーインターフェースは簡単なウェブベースの管理画面を作成しました。ここから手動でメッセージを送ることも可能とし、Botの設定やログを見ることもできます。

### 4-3. 対応可能なコマンド一覧
- `/hello`: 挨拶を返す
- `/report`: 毎日の業務報告を送信
- `/help`: 使用できる全てのコマンドを表示

## 5. テストとデプロイ

### 5-1. テスト環境の構築
ローカル環境でBotの動作を確認するため、`pytest`を用いて単体テストを行いました。APIキーは仮のものを設定し、実際のデータの送受信はMockライブラリで処理します。

### 5-2. デプロイ手順
Herokuにデプロイすることで、外部からアクセス可能なBotを稼働させました。デプロイスクリプトを用意し、GitHub Actionsを使った継続的デプロイを設定しました。

## 6. まとめ
今回のプロジェクトを通じて、Chatwork APIの柔軟性と可能性を強く感じました。Slack等と比べると機能は限られますが、コストを抑えたい企業にとっては非常に有用な選択肢です。今後はさらに機能を拡張し、より多くの業務を自動化することで、さらなる効率化を図りたいと考えています。 [![image](https://firebasestorage.googleapis.com/v0/b/issue-pro-42602.appspot.com/o/topics%2F17fa658b-53c7-4ca0-a28b-e588ed1bd371?alt=media&token=2c00afff-85ff-4428-8d15-696ab676dcb0)](https://i-ssue.com/lp/check_salary)

Chatwork APIを活用してSlack代替チャットBotを作ってみた

目次

続きは、単価診断を受けたエンジニア限定で公開中（30秒）

続きは、
単価診断を受けたエンジニア限定で公開中（30秒）