You need to enable JavaScript to run this app.
导航

质检回查处理同步

最近更新时间2023.11.10 14:14:18

首次发布时间2023.11.10 14:14:18

概述

用户可以在内容管理平台创建回查任务,回查完成后可以对回查到的文章进行上下架处理,若客户侧需要感知到该处理可以调用本接口获取。

提前准备

  1. 接口鉴权
    详见:接口鉴权
  2. 调用接口
    注意参数 是否必填,并确保 ServiceName、Action、Version 等url信息正确,详见:下方接口信息。

请求接口

请求方式

post

请求url:

https://cms.volcengineapi.com?Action=ArticleEventNotify&Version=2021-01-01

请求header:

ServiceName: volc_content_platform

url组成:

Host: https://cms.volcengineapi.com

Action: ArticleEventNotify

Version: 2021-01-01

请求参数

字段名字段类型是否必填说明
GenerateTypestring内容源标识
EventTypestring事件类型,该接口应该固定为AuditRetraceChange
CursorTimeint64时间锚
SubEventTypeListlist< string>子事件类型列表
  • AuditRetraceApprove:上架
  • AuditRetraceReject:下架

注意

  • 无穷回溯影响性能,因此接口仅支持7日内的数据查询;
  • CursorTime是时间锚参数,如果没有该参数会返回前100条有关的数据,根据时间排序。返回结果会包含CursorTime,即下次请求应该传递的时间锚。循环上述操作,当返回结果数据量不足100条时,说明已没有更多数据;
  • 接口的请求时间间隔应至少2s;
  • CursorTime的初次请求传0或其他值,也会计算为一次请求,下一次请间隔至少2s再请求。

响应字段

字段名
字段类型
说明
ResponseMetadata
ResponseMetadata
Result
ArticleEventNotifyResult
业务请求结果

EventDetail

EventDetail类型为字符串,由以下结构JsonEncode得到。

{
    "GenerateType":"test_dong",
    "GroupId":"7263343130085294370",
    "GroupOpenId":"",
    "TaskInfo":{
        "TaskId":"26",
        "TaskName":"测试"
    },
    "TaskResult":"Reject" //任务结果 Approve:通过 Reject:未通过
}

请求示例

{
    "CursorTime": 0,
    "EventType": "AuditRetraceChange",
    "GenerateType": "zhihu"
}

响应示例

正常响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023081811245019216800006424568",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "Items": [
            {
                "EventType": "AuditRetraceChange",
                "SubEventType": "AuditRetraceReject",
                "EventTime": 1692254795,
                "ArticleId": 7263342116246454562,
                "GenerateType": "test_dong",
                "EventDetail": "\"{\\\"GenerateType\\\":\\\"test_dong\\\",\\\"GroupId\\\":\\\"7263342116246454562\\\",\\\"GroupOpenId\\\":\\\"\\\",\\\"TaskInfo\\\":{\\\"TaskId\\\":\\\"26\\\",\\\"TaskName\\\":\\\"测试\\\"},\\\"TaskResult\\\":\\\"Reject\\\"}\""
            },
            {
                "EventType": "AuditRetraceChange",
                "SubEventType": "AuditRetraceReject",
                "EventTime": 1692254796,
                "ArticleId": 7263343131712684322,
                "GenerateType": "test_dong",
                "EventDetail": "\"{\\\"GenerateType\\\":\\\"test_dong\\\",\\\"GroupId\\\":\\\"7263343131712684322\\\",\\\"GroupOpenId\\\":\\\"\\\",\\\"TaskInfo\\\":{\\\"TaskId\\\":\\\"26\\\",\\\"TaskName\\\":\\\"测试\\\"},\\\"TaskResult\\\":\\\"Reject\\\"}\""
            }
        ],
        "CursorTime": 1692275433
    }
}

异常响应示例

  • 参数错误
{
    "ResponseMetadata": {
        "RequestId": "20210817172205010225243147030tt4A8",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "参数错误"
        }
    },
    "Result": null
}
  • 请求频率超过限制
{
    "ResponseMetadata": {
        "RequestId": "20211201155037010211209131000091F6",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100027,
            "Code": "AccountFlowLimitExceeded",
            "Message": "Request was rejected because the request speed of this openAPI is beyond the current flow control limit."
        }
    }
}