# 機能設計書 124-Instagram

## 概要

本ドキュメントは、ChatwootのInstagram DM連携機能の設計仕様を記載する。この機能は、Instagram Direct Messageを通じた顧客とのコミュニケーションをChatwootで一元管理するためのチャネル統合機能である。

### 本機能の処理概要

Instagram連携は、Instagram Graph APIを通じてダイレクトメッセージ（DM）を受信し、Chatwootの会話として管理する。エージェントはChatwootからInstagramユーザーへの返信を直接送信できる。Instagram Business/Creatorアカウントが必要。

**業務上の目的・背景**：Instagramは特に若年層やビジュアル重視のビジネスにおいて重要な顧客接点となっている。本機能により、Instagram DMでの問い合わせをChatwootの統合インターフェースで管理でき、SNSマーケティングとカスタマーサポートの連携を強化する。

**機能の利用シーン**：
- 顧客からのInstagram DMを受信・返信する場面
- 商品問い合わせや購入相談に対応する場面
- インフルエンサーとのコミュニケーション管理

**主要な処理内容**：
1. Instagram Business/Creatorアカウントとの認証・接続設定
2. Webhookを通じたDM・リアクション・既読通知の受信処理
3. Instagram Graph APIを使用したDM送信
4. アクセストークンの自動リフレッシュ
5. 連絡先（Instagramユーザー）の自動作成・更新

**関連システム・外部連携**：
- Instagram Graph API（メッセージ送受信）
- Instagram Webhook（イベント受信）
- Facebook Login（認証）

**権限による制御**：インボックスの作成・管理にはAdministrator権限が必要。メッセージの送受信はインボックスにアサインされたエージェントが実行可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 49 | チャネル設定画面 | 主画面 | Instagramチャネルの設定・認可フロー |
| 11 | 会話詳細画面 | 主画面 | Instagram DMの送受信 |

## 機能種別

データ連携 / メッセージング

## 入力仕様

### 入力パラメータ（チャネル作成時）

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| instagram_id | String | Yes | InstagramアカウントID | 一意性 |
| access_token | String | Yes | アクセストークン | 必須 |
| expires_at | DateTime | Yes | トークン有効期限 | 必須 |
| account_id | Integer | Yes | Chatwootアカウント | 必須 |

### 入力パラメータ（メッセージ送信時）

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| content | String | No | メッセージ本文 | - |
| attachments | Array | No | 添付ファイル | 画像のみ |

### 入力データソース

- Instagram OAuth認可フローからトークン取得
- Chatwoot会話画面からのメッセージ入力

## 出力仕様

### 出力データ（Webhook受信時）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| message | Message | 作成されたメッセージレコード |
| conversation | Conversation | 関連する会話 |
| contact | Contact | 送信者の連絡先 |

### 出力データ（メッセージ送信時）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| message_id | String | Instagram側のメッセージID（source_idとして保存） |

### 出力先

- Chatwootデータベース（messages, conversations, contacts）
- Instagram Graph API（送信メッセージ）

## 処理フロー

### 処理シーケンス（メッセージ受信）

```
1. Instagram Webhookからイベント受信
   └─ InstagramController#eventsで処理
2. イベントタイプの判定
   └─ messages / message_reactions / messaging_seen
3. エコーイベントの場合
   └─ 2秒遅延でジョブ実行（レース条件防止）
4. 通常イベントの場合
   └─ InstagramEventsJobで即座に処理
5. 連絡先・会話・メッセージの作成
```

### 処理シーケンス（メッセージ送信）

```
1. Chatwootでメッセージ作成
   └─ Message#after_create_commitコールバック
2. SendOnInstagramServiceの実行
   └─ チャネル検証
   └─ outgoingメッセージ判定
3. Instagram Graph APIへ送信
   └─ アクセストークン自動リフレッシュ
   └─ メッセージ送信
4. レスポンス処理
   └─ message_idをsource_idとして保存
```

### フローチャート

```mermaid
flowchart TD
    A[Webhook受信] --> B{objectがinstagram?}
    B -->|No| C[422エラー]
    B -->|Yes| D{エコーイベント?}
    D -->|Yes| E[2秒遅延でJob実行]
    D -->|No| F[即座にJob実行]
    E --> G[InstagramEventsJob]
    F --> G
    G --> H[メッセージ処理]
    H --> I[連絡先作成/取得]
    I --> J[会話作成/取得]
    J --> K[メッセージ作成]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | トークンリフレッシュ | アクセストークン有効期限前に自動リフレッシュ | API呼び出し時 |
| BR-002 | HUMAN_AGENTタグ | グローバル設定有効時にメッセージタグを付与 | メッセージ送信時 |
| BR-003 | エコー遅延処理 | エコーイベントは2秒遅延で処理（レース条件防止） | Webhook受信時 |
| BR-004 | 認可エラー閾値 | 1回の認可エラーで再認可フラグを立てる | API呼び出し時 |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| チャネル作成 | channel_instagram | INSERT | Instagramチャネル情報保存 |
| トークン更新 | channel_instagram | UPDATE | access_token, expires_at更新 |
| メッセージ受信 | messages | INSERT | 受信メッセージ保存 |
| メッセージ送信 | messages | UPDATE | source_id更新 |
| 連絡先作成 | contacts | INSERT/UPDATE | 送信者情報保存 |

### テーブル別操作詳細

#### channel_instagram

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | instagram_id, access_token, expires_at, account_id | OAuth認可フローから取得 | 暗号化保存 |
| UPDATE | access_token, expires_at | リフレッシュ後の新トークン | 有効期限更新 |
| SELECT | access_token | チャネルID指定 | API呼び出し時に使用 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| token_expired | Auth Error | アクセストークン期限切れ | 自動リフレッシュ |
| authorization_error | Auth Error | 認可エラー（閾値超過） | チャネル再認可 |
| unprocessable_entity | Request Error | instagram以外のobject | 422エラー返却 |

### リトライ仕様

- トークン期限切れ時は自動リフレッシュ後に再試行
- その他のエラーは自動リトライなし

## トランザクション仕様

- メッセージ受信時：メッセージ・会話・連絡先の作成は単一トランザクション
- トークンリフレッシュ：独立したトランザクション

## パフォーマンス要件

- Webhook処理はバックグラウンドジョブで実行
- エコーイベントは2秒遅延で処理（レース条件防止）

## セキュリティ考慮事項

- access_tokenは暗号化して保存（Chatwoot.encryption_configured?時）
- Webhook検証トークン（IG_VERIFY_TOKEN / INSTAGRAM_VERIFY_TOKEN）で不正リクエスト防止
- OAuthフローによる安全な認可

## 備考

- AUTHORIZATION_ERROR_THRESHOLD = 1（1回の認可エラーで再認可要求）
- Reauthorizableモジュールで認可エラー時の再認可フロー対応
- RefreshOauthTokenServiceでトークン自動リフレッシュ

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | instagram.rb | `app/models/channel/instagram.rb` | チャネルモデルの構造、トークンリフレッシュ、Webhook購読 |

**読解のコツ**:
- `Reauthorizable`モジュールがAUTHORIZATION_ERROR_THRESHOLD=1で認可エラー処理を提供
- `access_token`メソッドがRefreshOauthTokenServiceを呼び出す

**主要処理フロー**:
- **17-23行目**: スキーマ構造とReauthorizable include
- **25行目**: AUTHORIZATION_ERROR_THRESHOLD = 1
- **27-28行目**: バリデーション
- **30-31行目**: 作成時にsubscribe、削除時にunsubscribe
- **45-57行目**: subscribeでInstagram Graph APIに購読登録
- **59-70行目**: unsubscribeで購読解除
- **72-74行目**: access_tokenメソッドでリフレッシュサービス呼び出し

#### Step 2: メッセージ送信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | base_send_service.rb | `app/services/instagram/base_send_service.rb` | 基底クラスの共通処理 |
| 2-2 | send_on_instagram_service.rb | `app/services/instagram/send_on_instagram_service.rb` | Instagram固有の送信処理 |

**主要処理フロー（SendOnInstagramService）**:
- **4-6行目**: channel_classでChannel::Instagramを指定
- **10-22行目**: send_messageでGraph APIへPOSTリクエスト
- **24-32行目**: merge_human_agent_tagでHUMAN_AGENTタグを条件付きで付与

#### Step 3: メッセージ受信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | instagram_controller.rb | `app/controllers/webhooks/instagram_controller.rb` | Webhook受信処理 |
| 3-2 | webhooks_base_service.rb | `app/services/instagram/webhooks_base_service.rb` | Webhook処理基底クラス |

**主要処理フロー（InstagramController）**:
- **4-22行目**: eventsアクションでWebhook受信
- **6-7行目**: objectがinstagramかチェック
- **9-15行目**: エコーイベントの場合2秒遅延、通常は即座にJob実行
- **26-34行目**: contains_echo_event?でエコーイベント判定

#### Step 4: トークンリフレッシュを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | refresh_oauth_token_service.rb | `app/services/instagram/refresh_oauth_token_service.rb` | トークンリフレッシュ処理 |

### プログラム呼び出し階層図

```
[メッセージ送信フロー]
Message#after_create_commit
    │
    └─ SendReplyJob.perform_later
           │
           └─ Instagram::SendOnInstagramService#perform
                  │
                  ├─ validate_target_channel
                  ├─ outgoing_message? チェック
                  ├─ invalid_message? チェック
                  │
                  └─ perform_reply
                         │
                         └─ send_message
                                │
                                ├─ channel.access_token
                                │      └─ RefreshOauthTokenService#access_token
                                │
                                └─ HTTParty.post (Instagram Graph API)

[メッセージ受信フロー]
Instagram Webhook
    │
    └─ Webhooks::InstagramController#events
           │
           ├─ [エコー] InstagramEventsJob.set(wait: 2.seconds)
           │
           └─ [通常] InstagramEventsJob.perform_later
                  │
                  └─ Instagram::WebhooksBaseService
                         ├─ 連絡先作成/取得
                         ├─ 会話作成/取得
                         └─ メッセージ作成
```

### データフロー図

```
[送信フロー]
[Chatwoot]              [処理]                    [Instagram]

Message作成     ───▶ SendReplyJob
                      │
                      ▼
                SendOnInstagramService
                      │
                      ▼
                channel.access_token
                      │
                      ├─▶ [期限切れ] RefreshOauthTokenService
                      │      └─ 新トークン取得・保存
                      │
                      └─▶ [有効] そのまま使用
                      │
                      ▼
                HTTParty.post               ───▶ Graph API
                (messages endpoint)
                      │
                      ▼
                message_id受信              ◀───  API Response
                      │
                      ▼
                source_id更新

[受信フロー]
[Instagram]             [処理]                    [Chatwoot]

Webhook Event   ───▶ InstagramController#events
                      │
                      ├─▶ [エコー] 2秒遅延
                      │
                      └─▶ InstagramEventsJob
                             │
                             └─▶ WebhooksBaseService
                                    ├─ Contact作成/取得
                                    ├─ Conversation作成/取得
                                    └─ Message作成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| instagram.rb | `app/models/channel/instagram.rb` | モデル | チャネル定義 |
| send_on_instagram_service.rb | `app/services/instagram/send_on_instagram_service.rb` | サービス | メッセージ送信処理 |
| base_send_service.rb | `app/services/instagram/base_send_service.rb` | サービス | 送信処理基底クラス |
| webhooks_base_service.rb | `app/services/instagram/webhooks_base_service.rb` | サービス | Webhook処理基底クラス |
| refresh_oauth_token_service.rb | `app/services/instagram/refresh_oauth_token_service.rb` | サービス | トークンリフレッシュ |
| read_status_service.rb | `app/services/instagram/read_status_service.rb` | サービス | 既読ステータス処理 |
| instagram_controller.rb | `app/controllers/webhooks/instagram_controller.rb` | コントローラー | Webhook受信 |
| instagram_events_job.rb | `app/jobs/webhooks/instagram_events_job.rb` | ジョブ | Webhook処理 |
| authorizations_controller.rb | `app/controllers/api/v1/accounts/instagram/authorizations_controller.rb` | コントローラー | OAuth認可 |
