Webhookコールバックイベント
会話の作成
ユーザーがAPIを呼び出して新しい会話を正常に作成すると、APIチャネルに設定されたWebhook URLに会話作成コールバックイベントが送信されます。
（JSONサンプルは原文のまま）
会話作成イベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | アカウントおよびプロジェクト情報 |
| id | Number | No | プロジェクトID |
| name | String | No | プロジェクト名 |
| additional_attributes | Object | No | 追加属性 |
| can_reply | Boolean | No | 返信を送信できるかどうか |
| channel | String | No | api や email などのチャネルタイプ |
| contact_inbox | Object | No | コンタクト情報 |
| id | Number | No | contact_inbox レコードのID。コンタクトとチャネルの関係を記録します |
| contact_id | Number | No | コンタクトID |
| inbox_id | Number | No | チャネルID |
| source_id | String | No | 会話ソースID（TelegramユーザーIDなど） |
| created_at | String | No | 作成時刻 |
| updated_at | String | No | 更新時刻 |
| hmac_verified | Boolean | No | HMAC検証ステータス |
| pubsub_token | String | No | パブリッシュ／サブスクライブトークン |
| id | Number | No | 会話ID |
| inbox_id | Number | No | チャネルID |
| messages | Array | No | メッセージリスト |
| labels | Array | No | ラベルリスト |
| meta | Object | No | メタデータ |
| sender | Object | No | 送信者情報 |
| additional_attributes | Object | No | 送信者の追加属性 |
| custom_attributes | Object | No | 送信者のカスタム属性 |
| String | No | 送信者のメールアドレス | |
| id | Number | No | 送信者のLiveDesk内部ID |
| identifier | String | No | 送信者識別子 |
| name | String | No | 送信者名 |
| phone_number | String | No | 送信者の電話番号 |
| thumbnail | String | No | 送信者のアバター |
| blocked | Boolean | No | 送信者がブロックされているかどうか |
| type | String | No | 送信者タイプ |
| assignee | Object | No | 割り当てられたカスタマーサービス担当者の情報 |
| team | Object | No | 割り当てられたカスタマーサービスチームの情報 |
| hmac_verified | Boolean | No | HMAC検証ステータス |
| channel | String | No | チャネルタイプ |
| status | String | No | 会話ステータス（open や closed など） |
| custom_attributes | Object | No | カスタム属性 |
| snoozed_until | String | No | 会話のスヌーズが解除される時刻 |
| unread_count | Number | No | 未読メッセージ数 |
| first_reply_created_at | String | No | 最初の返信が作成された時刻 |
| priority | String | No | 優先度 |
| waiting_since | Number | No | 待機を開始した時刻 |
| conversation_category | String | No | 会話カテゴリ |
| chat_mode | String | No | チャットモード |
| ticket_info | Object | No | チケット情報 |
| agent_last_seen_at | Number | No | 担当者が最後に会話を閲覧した時刻 |
| contact_last_seen_at | Number | No | コンタクトが最後に会話を閲覧した時刻 |
| last_activity_at | Number | No | 最後にアクティビティが発生した時刻 |
| timestamp | Number | No | タイムスタンプ |
| created_at | Number | No | 作成時刻 |
| updated_at | Number | No | 更新時刻 |
| event | String | No | イベントタイプ |
会話の更新
会話のいずれかの属性が更新されると、このイベントがトリガーされます。
会話更新イベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| event | String | No | イベントタイプ |
| changed_attributes | Array | No | 変更された属性のリスト |
| field_name | Object | No | 変更されたフィールド名 |
| previous_value | String | No | 変更前の値 |
| current_value | String | No | 変更後の値 |
会話ステータスの変更
会話のステータスが変更されると、このイベントがトリガーされます。
メッセージの作成
ユーザーまたはカスタマーサービス担当者がメッセージを送信すると、このイベントがトリガーされます。
メッセージ作成イベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | アカウント情報 |
| id | Number | No | プロジェクトID |
| name | String | No | プロジェクト名 |
| additional_attributes | Object | No | 追加属性 |
| content_attributes | Object | No | コンテンツ属性 |
| content_type | String | No | コンテンツタイプ |
| content | String | No | メッセージ内容 |
| conversation | Object | No | 会話情報 |
| created_at | String | No | 作成時刻 |
| id | Number | No | メッセージID |
| inbox | Object | No | チャネル情報 |
| id | Number | No | チャネルID |
| name | String | No | チャネル名 |
| message_type | String | No | メッセージタイプ |
| conversation_topic_id | String | No | 会話トピックID |
| private | Boolean | No | メッセージが非公開かどうか |
| sender | Object | No | 送信者情報 |
| id | Number | No | 送信者ID |
| name | String | No | 送信者名 |
| String | No | 送信者のメールアドレス | |
| type | String | No | 送信者タイプ |
| availability | String | No | 送信者の対応可能ステータス |
| source_id | String | No | ソースID |
| participants | Object | No | 参加者情報 |
| event | String | No | イベントタイプ |
メッセージの更新
会話内のメッセージの内容が更新されると、このイベントがトリガーされます。
メッセージのピン留め
カスタマーサービス担当者がメッセージをピン留め、またはピン留め解除すると、このイベントがトリガーされます。
メッセージピン留めイベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| pinned | Boolean | No | メッセージがピン留めされているかどうか。true はピン留め、false はピン留め解除を示します |
| pinned_at | String | No | ピン留めした時刻。メッセージがピン留めされていない場合は空になることがあります |
| pinned_by_id | Number | No | ピン留め操作を実行したカスタマーサービス担当者のID |
| additional_attributes | Object | No | 追加属性 |
| source_id | String | No | ソースID |
| participants | Object | No | 参加者情報 |
| event | String | No | イベントタイプ |
メッセージの編集
メッセージの内容が編集されると、このイベントがトリガーされます。なお、編集できるのは、カスタマーサービス担当者自身が送信したメッセージのみです。
メッセージ編集イベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| edited_at | String | No | 内容が編集された時刻 |
| original_content | String | No | 編集前の元の内容 |
| processed_message_content | String | No | 処理済みメッセージの内容 |
メッセージの取り消し
カスタマーサービス担当者がメッセージを取り消すと、このイベントがトリガーされます。
メッセージ取り消しイベントのパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| revoked_at | String | No | 取り消し時刻 |
| revoked_by_id | String | No | 取り消し操作を実行したカスタマーサービス担当者のID |
