---
updatedAt: 2025-09-16T21:40:38.000Z
agentTools:
  projectIndex: https://developers.karte.io/llms.txt
---

# Message Hook

エンドユーザーのチャットメッセージ送信をトリガーに、メッセージに関する情報を hook することができます。\
ご利用いただく場合は、「hook設定」から「KARTE Talk: ユーザーからのメッセージ送信時」を選択してください。

## Required Scope

`talk.message.get`

## Request Body

```json
{
  "client_id": "{Client Id}",
  "api_key": "{Api Key}",
  "event_type": "talk/message/sendFromUser",
  "data": {
    "user_id": "{メッセージ送信元ユーザーのuser_id}",
    "visitor_id": "{メッセージ送信元ユーザーのvisitor_id}",
    "account_id": null,
    "date": "{メッセージ送信日時}",
    "content":{
      "text":"Hello."
    },
  },
  "extra": {
    "access_uri": {
      "url": "https://example.com/index.html",
      "protocol": "https",
      "host": "example.com",
      "path": "/index.html",
      "anchor": "hoge",
      "query": "",
      "queryKey": {}
    }
  },
}
```

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        data.user\_id
      </td>

      <td>
        メッセージを送信したエンドユーザーのuser\_id
      </td>
    </tr>

    <tr>
      <td>
        data.visitor\_id
      </td>

      <td>
        メッセージを送信したエンドユーザーのvisitor\_id
      </td>
    </tr>

    <tr>
      <td>
        data.account\_id
      </td>

      <td>
        メッセージを送信したオペレータの ID\
        エンドユーザーの送信時は必ず `null` になります
      </td>
    </tr>

    <tr>
      <td>
        data.content
      </td>

      <td>
        メッセージの内容
      </td>
    </tr>

    <tr>
      <td>
        data.content.text
      </td>

      <td>
        メッセージの本文
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri
      </td>

      <td>
        エンドユーザーがメッセージ送信したページの URI 情報
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.url
      </td>

      <td>
        エンドユーザーがメッセージ送信したページの URL
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.protocol
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのプロトコル
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.host
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのホスト
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.path
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのパス
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.anchor
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのアンカー
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.query
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのクエリ
      </td>
    </tr>

    <tr>
      <td>
        extra.access\_uri.queryKey
      </td>

      <td>
        エンドユーザーがメッセージ送信したページのObject 形式で表現されたクエリ
      </td>
    </tr>
  </tbody>
</Table>