# 证据报告 API

> 使用证据报告 API 从频道或私信对话中获取选定消息。

使用证据报告 API 从服务器中获取选定消息。

下面是文本证据管理请求的格式设置示例：

```text
curl "https://services.api.unity.com/vivox/text-evidence-management/v1/organizations/:yourOrgID/projects/:yourProjectID/text-evidence-report?target_uri=add-your-vivox-channel-uri" -u service-acct-username:service-account-password
```

`target_uri` 是必需的参数。它映射到 Vivox 频道 ID 或私信请求的用户 ID。私信请求必须包含一个 `target_uri` 和一个 `sender_uri`，这两个值都是用户 URI。`target_uri` 和 `sender_uri` 的顺序无关紧要，因为私信请求会返回两个用户之间的整个对话。

该请求接受以下可选查询参数：

| 参数             | 描述                                        |
| -------------- | ----------------------------------------- |
| `sender_uri`   | Vivox 用户 URI，用于按消息发送方过滤响应。请注意，私信请求需要此值。   |
| `target_uri`   | 接收消息的实体（频道或用户）的 URI。                      |
| `start_ts`     | 在采用 Unix 时间格式的此时间戳及其后上报的所有消息。             |
| `end_ts`       | 在此时间戳（采用 Unix 时间格式）时以及此时间戳之前上报的所有消息。      |
| `as_file`      | 以 true 或 false 值指明是否以文件形式返回响应。            |
| `file_type`    | 如果 as\_file 为 true，请指定文件类型。默认值为 CSV。      |
| `num_messages` | 要返回的消息的数量。如果未给出具体数量，则每次查询请求最多可返回 500 条消息。 |

> **Note:**
>
> 对于包含特定消息数的请求，如果还有更多消息可返回，则该请求将返回一个包含 Unix 时间戳的 `next` 字段，其指向查询结果中的下一条消息。

无论存在多少条消息，每次查询最多返回 500 条消息 (message\_ids)。如果需要 500 条以上消息，则可以继续发送针对后续消息结果的新查询，直到不再有结果为止。

要获取下一页的消息结果，请使用结果中提供的 `next` 值，将其用作下一次查询的 `start_ts` 参数。如果 `next` 值为 null，则表示不再有要返回的消息。