List Web App visitor conversations

Query visitor conversations generated by the public app for the publisher’s agent.

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/agents/{agent_id}/webapp/conversations

Before you call this API

Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5; use the corresponding product API URL for a dedicated deployment.

Prepare publication management identity and objects.

Request

curl --request GET \
  "$BASE_URL/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/webapp/conversations?status=all&limit=50&offset=0" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"

Next-page example:

curl --request GET \
  "$BASE_URL/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/webapp/conversations?status=all&limit=50&offset=50" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"

Parameter

Location

Type

Required

Description

workspace_id

Path

string

Yes

Publication workspace ID in the same environment.

agent_id

Path

string

Yes

Target agent ID.

status

Queries

string

No

Default active; accepts active, archived, or all.

limit

Queries

integer

No

Default 50, maximum 200. Invalid/nonpositive values use 50.

offset

Queries

integer

No

Default 0; negative values use 0.

Limited to purpose=webapp and visible conversations. Does not exclude other visitors by the currently signed-in administrator’s user ID. Read permission is agent.read; disabling a link does not hide all history. In ordinary pagination, stop when offset + items.length reaches total or items is empty. Concurrent changes may affect the result set.

Successful response

{
  "code": 0,
  "data": {
    "items": [
      {
        "conversation_id": "conversation-example",
        "title": "公开访问对话",
        "status": "active",
        "end_user_id": "visitor-example",
        "message_count": 2,
        "created_at": "2026-11-12T01:00:00Z",
        "updated_at": "2026-11-12T01:00:00Z"
      }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

Field

Type

Description

code

integer

Success code.

data

object

Corresponding object.

Error responses

Errors and rereads distinguishes parameters, permissions, and write outcomes for this entry point.

Last updated on