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

ArticleEventNotify-质检回查处理同步

最近更新时间2024.03.01 10:48:26

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

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

注意事项

  • 使用限制:
    • 接口查询范围: 无穷回溯影响性能,因此接口仅支持7日内的数据查询;
  • 请求频率:
    • 接口请求时间:间隔至少需超过 2s

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=ArticleEventNotify&Version=2021-01-01
  • 请求头:ServiceName: volc_content_platform

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

ArticleEventNotify

要执行的操作,取值:ArticleEventNotify

Version
String

2021-01-01

API的版本,取值:2021-01-01

Body

参数
类型
是否必填
示例值
描述
GenerateType
String

toutiao_api

查询指定Api来源的内容的同步状态,不传则不进行筛选查询,取值路径:控制台 - 内容引入 - 内容源管理 - Api源标识。

EventType
String

AuditRetraceChange

事件类型,固定值"AuditRetraceChange"。

CursorTime
Long

1638283523

时间锚。

说明

CursorTime使用方式:

  • 首次请求传 0,根据时间排序,返回前100条有关的数据;
  • 返回结果包含下次请求的 CursorTime 值,循环上述操作;
  • 当返回结果数据量不足100条时,说明已没有更多数据。

注意

  • CursorTime的初次请求传0或其他值,也会计算为一次请求,下一次请间隔至少2s再请求。
SubEventTypeList
Array of String

子事件类型列表。
枚举值:

SubEventType描述
AuditRetraceApprove上架
AuditRetraceReject下架

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
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": "2023081811245019216800006424***",
        "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": "20210817172205010225243147030tt***",
        "Action": "ArticleEventNotify",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 600400,
            "Code": "600400",
            "Message": "参数错误"
        }
    },
    "Result": null
}
  • 请求频率超过限制
{
    "ResponseMetadata": {
        "RequestId": "2021120115503701021120913100009***",
        "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."
        }
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
600400
参数错误

内容为空,或者是入参的类型是否与文档中不一致

200
600500
服务未知错误

服务内部异常,请联系商务