获取应用反馈列表
查询应用的反馈数据
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/application/v6/applications/:app_id/feedbacks |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | application:application.feedback.feedback_info 管理应用反馈数据 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.email:readonly 获取用户邮箱信息 contact:user.employee_id:readonly 获取用户 user ID contact:user.phone:readonly 获取用户手机号 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
app_id | string | 目标应用 ID(本租户创建的所有应用) 示例值:"cli_9f115af860f7901b" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
from_date | string | 否 | 查询的起始日期,格式为yyyy-mm-dd。不填则默认为当前日期减去180天。 示例值:2022-01-30 |
to_date | string | 否 | 查询的结束日期,格式为yyyy-mm-dd。不填默认为当前日期。 只能查询 180 天内的数据。 示例值:2022-01-30 |
feedback_type | int | 否 | 反馈类型,不填写则表示查询所有反馈类型。 示例值:1 可选值有: - 1: 故障反馈 - 2: 产品建议 |
status | int | 否 | 反馈处理状态,不填写则表示查询所有处理类型。 示例值:0 可选值有: - 0: 反馈未处理 - 1: 反馈已处理 - 2: 反馈处理中 - 3: 反馈已关闭 |
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:"7064688334618378259" |
page_size | int | 否 | 本次拉取反馈列表最大个数 示例值:100 默认值: 100数据校验规则: - 取值范围: 1 ~ 100 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ feedback_list | application.feedback\[\] | 应用的反馈列表 |
└ feedback_id | string | 应用反馈 ID,应用反馈记录唯一标识 |
└ app_id | string | 被反馈应用ID |
└ feedback_time | string | 反馈提交时间,格式为yyyy-mm-dd hh:mm:ss |
└ tenant_name | string | 反馈用户的租户名, 查询 isv 应用时返回 |
└ feedback_type | int | 反馈类型 可选值有: - 1: 故障反馈 - 2: 产品建议 |
└ status | int | 反馈处理状态 可选值有: - 0: 反馈未处理 - 1: 反馈已处理 - 2: 反馈处理中 - 3: 反馈已关闭 |
└ fault_type | int\[\] | 故障类型列表:1: 黑屏 2: 白屏 3: 无法打开小程序 4: 卡顿 5: 小程序闪退 6: 页面加载慢 7: 死机 8: 其他异常 |
└ fault_time | string | 故障时间,格式为yyyy-mm-dd hh:mm:ss |
└ source | int | 反馈来源:1: 小程序 2:网页应用 3:机器人 4:webSDK 可选值有: - 1: 小程序 - 2: 网页应用 - 3: 机器人 - 4: WebSDK |
└ contact | string | 用户联系方式,只有用户填写联系方式后返回 字段权限要求(满足任一): contact:user.email:readonly 获取用户邮箱信息 contact:user.phone:readonly 获取用户手机号 |
└ update_time | string | 反馈处理时间,格式为yyyy-mm-dd hh:mm:ss |
└ description | string | 反馈问题描述 |
└ user_id | string | 反馈用户id,租户内用户的唯一标识 ,ID值与查询参数中的user_id_type对应 |
└ operator_id | string | 操作者id,租户内用户的唯一标识, ID值与查询参数中的user_id_type 对应 |
└ images | string\[\] | 反馈图片url列表,url 过期时间三天 |
└ feedback_path | string | 反馈页面路径 - 如触发反馈的应用类型为小程序,则上报小程序当前页面的path信息 - 如触发反馈的应用类型为网页或网页应用,则上报当前网页的url信息 - 如为其他应用类型,则字段返回值为空 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"feedback_list": [
{
"feedback_id": "7057888018203574291",
"app_id": "cli_9b445f5258795107",
"feedback_time": "2022-01-30 11:30:12",
"tenant_name": "字节跳动",
"feedback_type": 1,
"status": 0,
"fault_type": [
1,
2,
3
],
"fault_time": "2022-01-30 11:30:12",
"source": 1,
"contact": "wang@bytedance.com",
"update_time": "2022-01-30 11:30:12",
"description": "反馈描述",
"user_id": "ou_9565b69967831233761cc2f11b4c089f",
"operator_id": "ou_9565b69967831233761cc2f11b4c089f",
"images": [
"https://p6-lark-openplatform-image-sign.byteimg.com/*"
],
"feedback_path": "index/page"
}
],
"has_more": true,
"page_token": "7064688334618378259"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 211005 | invalid app id | 检查 app id |
| 400 | 210504 | no such app in tenant | 当前租户中不存在目标应用。请检查被查询应用与当前调用接口应用是否在同一企业内 |
| 400 | 211007 | invalid date format | 检查 date 字段的格式是否符合"2021-07-01" |
| 403 | 211010 | invalid date range | 检查 date 的取值范围是否正确 |
| 404 | 211011 | data not found | 数据不存在。可能是该应用在目标查询日期范围内没有数据。请检查请求参数 |
