GET/api/v4/reviewDetails

按 ID 获取互动

返回指定的一组互动 ID 对应的完整互动对象。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

查询

名称类型必填描述默认值
interactionIdsstring必填JSON-encoded array of interaction IDs to fetch, e.g. `["b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0"]`. Passed as a URL-encoded JSON string.—

响应

200Interaction details for the requested IDs. `data.interactionDetails.interactions` holds the array.
Response
{  "data": {    "interactionDetails": {      "interactions": [        {          "id": "b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0",          "source": "maps.google.com",          "content": "Great place for dessert!",          "authorName": "Jordan M.",          "category": "Review",          "type": "Review",          "rating": 5,          "date": "2026-05-12T09:22:41+00:00",          "responded": true,          "responseCount": 1,          "canRespond": true,          "responses": [            {              "id": "2090753a-ece6-4837-8336-8494ad308523",              "content": "Thank you so much for the kind words!",              "authorName": "Jenny Home",              "date": "2026-05-13T14:02:00+00:00",              "interactionStatus": "CONFIRMED",              "editedResponse": false            }          ]        }      ]    }  }}
401Unauthenticated, missing or invalid API key.

获取一个或多个指定互动 ID 对应的完整互动详情。如果您已存储互动 ID,需要获取它们的最新数据,又不想逐页浏览完整的互动列表,可以使用此端点。响应正文为 data.interactionDetails.interactions,即互动对象数组(请参阅互动属性参考)。

将 interactionIds 作为经过 URL 编码的 JSON 数组传入。当某个 ID 不属于您的账户时,端点返回 200,其中 data.interactionDetails 设为 null,并包含一个 errors 数组(例如 SY90001: Not Authorized to access this resource);完全省略该参数则返回 SY90006。

使用场景:刷新已存储的关注列表

如果您构建的通知系统会存储互动 ID(例如,用户加星标的评价的 ID),请定期调用此端点以重新获取这些互动的完整数据,并检测商家所有者新发布的 responses 或发生变化的 responded 标志,无需重新扫描整个评价列表。此处返回的 responses[].id 就是您传递给编辑回复或归档回复的 responseId。

Request
curl -X GET 'https://listingsapi.com/api/v4/reviewDetails?interactionIds=<interactionIds>' \  -H "Authorization: API $LISTINGSAPI_KEY"