<span id="读取访客会话消息"></span>

# Read visitor conversation messages

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

Returns items/total/limit/offset; see common objects for message top-level fields and answer_versions. Advance offset by actual item count; stop at an empty page or total.


```http
GET https://api.moi.matrixorigin.cn/v5/public/webapp/conversations/{conversation_id}/messages
```

<span id="调用前准备"></span>

## Before you call this API

`BASE_URL` uses the product API prefix `https://api.moi.matrixorigin.cn/v5`. For a dedicated deployment, use its corresponding product API address.

[Prepare links and visitor identity in the same environment](identity-lifecycle.md#prepare). Do not supply a product PAT or Workspace request header.

<span id="请求"></span>

## Request

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} Request example

```bash
curl --request GET \
  "$BASE_URL/public/webapp/conversations/$CONVERSATION_ID/messages?webapp=$AGENT_ID&t=$WEBAPP_TOKEN&s=$WEBAPP_SESSION&role=user&limit=50&offset=0"
```

:::::
:::::{tab-item} Parameters

| Parameter | Location | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `webapp` | Query | string | Yes | Agent ID corresponding to the link. |
| `t` | Query | string | Yes | Current valid publication token. For short-code links, resolve first and use the short code as t. |
| `s` | Query | string | Yes | Visitor session credentials under the same publication. |
| `conversation_id` | Path | string | Yes | Active Web App conversation created by this visitor. |
| `limit` | Query | integer | No | Default 50, maximum 200. Invalid/nonpositive values use the default. |
| `offset` | Query | integer | No | Default 0; negative values use 0. |
| `role` | Query | string | No | user/agent/system/tool/assistant; omission disables role filtering. |

:::::
::::::
:::::::

<span id="成功响应"></span>

## Successful response

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} Response example

```json
{
  "code": 0,
  "data": {
    "items": [],
    "total": 0,
    "limit": 50,
    "offset": 0
  }
}
```

:::::
:::::{tab-item} Fields

Success returns HTTP 200 with numeric code=0. Read data's [Object descriptions](objects.md) with the example; the conversation-creation example shows a field excerpt only.

:::::
::::::
:::::::

<span id="错误响应"></span>

## Error response

[Public errors and identity handling](identity-lifecycle.md#errors) distinguishes unavailable links, disablement, invalid sessions, parameters, and system failures.

<span id="下一页"></span>

## Next page

When the first page has one item and total is not reached, the example uses offset=1. Advance by the actual returned count.

```bash
curl --request GET \
  "$BASE_URL/public/webapp/conversations/$CONVERSATION_ID/messages?webapp=$AGENT_ID&t=$WEBAPP_TOKEN&s=$WEBAPP_SESSION&role=user&limit=50&offset=1"
```
