交流
发布交流、回复与回应,保持团队沟通记录。
发布与维护
先查询 community-categories 获取可用 categoryId。parentPostId 用于发布回复,列表可用 parentId 查询回复。
content 最多 2,000 字符,允许仅媒体;单次最多 9 个媒体。上传后把返回的 media 对象组成数组并 JSON.stringify 到 uploadedMedia。
type 为 UPVOTE 或 DOWNVOTE,重复相同回应会取消。原作者的编辑删除时间窗口、管理员权限沿用网页规则。
接口参考
查询交流列表
/api/v1/workspaces/{workspaceId}/community
响应 data 字段(列表元素)
- id
- 交流 ID
- categoryId
- 栏目 ID
- authorId
- 作者 ID
- parentId
- 回复目标 ID,可为空
- content
- 交流内容
- createdAt
- 创建时间 ISO 8601
- updatedAt
- 更新时间 ISO 8601
- media
- 媒体数组,含 id、kind、mimeType、size、sortOrder、downloadUrl
- reactions
- 回应数组,含 userId、type
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community" \
--header "Authorization: Bearer $AGENT_API_KEY"成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
查询交流详情
/api/v1/workspaces/{workspaceId}/community/{id}
响应 data 字段
- id
- 交流 ID
- categoryId
- 栏目 ID
- authorId
- 作者 ID
- parentId
- 回复目标 ID,可为空
- content
- 交流内容
- createdAt
- 创建时间 ISO 8601
- updatedAt
- 更新时间 ISO 8601
- media
- 媒体数组,含 id、kind、mimeType、size、sortOrder、downloadUrl
- reactions
- 回应数组,含 userId、type
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/{id}" \
--header "Authorization: Bearer $AGENT_API_KEY"成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
查询可用栏目
/api/v1/workspaces/{workspaceId}/community-categories
响应 data 字段(列表元素)
- id
- 栏目 ID
- slug
- 栏目标识
- name
- 栏目名称
- description
- 栏目介绍,可为空
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community-categories" \
--header "Authorization: Bearer $AGENT_API_KEY"成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
发布交流或回复
/api/v1/workspaces/{workspaceId}/community
| 参数 | 类型 | 说明 |
|---|---|---|
| categoryId* | string | 沿用业务表单规则 |
| content | string | 沿用业务表单规则 |
| parentPostId | string | 沿用业务表单规则 |
| publishedAt | string | 沿用业务表单规则 |
| uploadedMedia | string | 附件上传返回的 media 数组序列化 JSON |
响应 data 字段
- id
- 目标业务记录 ID(有对应记录时返回)
- message
- 处理结果
- tag
- 新增标签时返回 { id, name, archivedAt, createdAt, updatedAt }
curl --request POST "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community" \
--header "Authorization: Bearer $AGENT_API_KEY" \
--header "Idempotency-Key: $REQUEST_KEY" \
--header "Content-Type: application/json" \
--data '{"categoryId":"<categoryId>","content":"请跟进首页文案调整"}'成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
编辑交流
/api/v1/workspaces/{workspaceId}/community/{id}
| 参数 | 类型 | 说明 |
|---|---|---|
| content* | string | 沿用业务表单规则 |
响应 data 字段
- id
- 目标业务记录 ID(有对应记录时返回)
- message
- 处理结果
- tag
- 新增标签时返回 { id, name, archivedAt, createdAt, updatedAt }
curl --request PATCH "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/{id}" \
--header "Authorization: Bearer $AGENT_API_KEY" \
--header "Idempotency-Key: $REQUEST_KEY" \
--header "Content-Type: application/json" \
--data '{"content":"请跟进首页文案调整"}'成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
删除交流
/api/v1/workspaces/{workspaceId}/community/{id}
响应 data 字段
- id
- 目标业务记录 ID(有对应记录时返回)
- message
- 处理结果
- tag
- 新增标签时返回 { id, name, archivedAt, createdAt, updatedAt }
curl --request DELETE "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/{id}" \
--header "Authorization: Bearer $AGENT_API_KEY" \
--header "Idempotency-Key: $REQUEST_KEY" \
--header "Content-Type: application/json" \
--data '{}'成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
切换回应
/api/v1/workspaces/{workspaceId}/community/{id}/reactions
| 参数 | 类型 | 说明 |
|---|---|---|
| type* | string | UPVOTE / DOWNVOTE |
响应 data 字段
- id
- 目标业务记录 ID(有对应记录时返回)
- message
- 处理结果
- tag
- 新增标签时返回 { id, name, archivedAt, createdAt, updatedAt }
curl --request POST "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/{id}/reactions" \
--header "Authorization: Bearer $AGENT_API_KEY" \
--header "Idempotency-Key: $REQUEST_KEY" \
--header "Content-Type: application/json" \
--data '{"type":"UPVOTE"}'成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。
上传附件
/api/v1/workspaces/{workspaceId}/community/attachments
响应 data 字段
- id
- 附件 ID
- objectKey
- 存储引用
- name
- 文件名
- mimeType
- MIME 类型
- size
- 字节数
- downloadUrl
- 需要 Bearer Key 的相对下载地址
- attachmentKey
- 跟进或收支所用的附件引用
- attachmentName
- 附件名称
- attachmentSize
- 字节数字符串
- attachmentMimeType
- MIME 类型
- media
- 仅交流上传:用于发布时关联的媒体对象
curl --request POST "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/attachments" \
--header "Authorization: Bearer $AGENT_API_KEY" \
--header "Idempotency-Key: $REQUEST_KEY" \
--form "file=@./example.png"成功返回 { data, meta?, requestId }。权限、字段类型与错误处理见本页业务说明及错误与重试。