# 概述本文档提供内容管理平台的火山回调接口，支持内容通用推送、个性化推送，以及内容关联标签变更、专题关联标签变更、标签树元数据变更、分发任务运营规则变更等事件的主动回调。 # 调前准备 1. 接口配置详见：[推送配置](https://www.volcengine.com/docs/6440/131246) # 请求方式 ``` POST application/json ``` # 签名校验内容管理平台在HTTP/HTTPS回调时增加特定签名头，以便消息接收服务端进行签名认证，可以用于防止非法请求或无效请求。 ## 鉴权参数 | 参数 | 描述 | | --- | --- | | timestamp | unix时间戳，单位：秒。为保证安全，与当前时间戳绝对值不要超过3600s。
从请求头中获取，键为：X-Cms-Timestamp | | nonce | 请求随机串。
从请求头中获取，键为：X-Cms-Nonce | | signature | 签名字符串。
从请求头中获取，键为：X-Cms-Signature | | payload | 业务数据。请求体body字节流。 | | secure\_key | 鉴权密钥。从 “控制台-高级管理-回调设置” 中可以查看鉴权密钥 | ## 签名步骤 1. 将 timestamp、nonce 和 payload 依次进行拼接； 2. 使用 secure\_key 对上述拼接的字符串进行 hmac sha256 加密，然后转成十六进制字符串； 3. 得到加密后的字符串可与 signature 对比，标识该请求来源于内容管理平台。 ## 签名示例 ```mixin-react const list = [ { "lang": "Golang", "text": `package main import ( "crypto/hmac" "crypto/sha256" "encoding/hex" "fmt" ) func main() { timestamp := "1657017150" nonce := "3218760" payload := "{\\"EventType\\": \\"push\_task\\",\\"EventTime\\": \\"2022-07-05T18:32:30+08:00\\",\\"Version\\": \\"1.0\\",\\"Data\\": {\\"TaskName\\": \\"测试任务\\",\\"TaskId\\": 7114859245769819692,\\"GroupId\\": 1736502630758487,\\"GenerateType\\": \\"source\_id2\\",\\"SourceName\\": \\"source\_id2\\",\\"PushTitle\\": \\"测试标题\\",\\"PushAbstract\\": \\"测试摘要\\",\\"ExpectExecuteTime\\": 1656560797,\\"TargetPeople\\": \\"all\\",\\"TargetAppId\\": 229586,\\"TargetAppName\\": \\"cms测试\\"}}" data := timestamp + nonce + payload secure_key := "mysecret" h := hmac.New(sha256.New, []byte(secure_key)) h.Write([]byte(data)) genSignature := hex.EncodeToString(h.Sum(nil)) fmt.Println("genSignature: " + genSignature) } `, "selected": true, }, { "lang": "Java", "text": `import javax.crypto.Mac; import javax.crypto.spec.SecretKeySpec; import java.nio.charset.StandardCharsets; public class HMacDemoRaw { public static final String ALGORITHM = "HmacSHA256"; public static String calculateHMac(String key, String data) throws Exception { Mac mac = Mac.getInstance(ALGORITHM); mac.init(new SecretKeySpec(key.getBytes(StandardCharsets.UTF_8), ALGORITHM)); return byteArrayToHex(mac.doFinal(data.getBytes(StandardCharsets.UTF_8))); } public static String byteArrayToHex(byte[] a) { StringBuilder sb = new StringBuilder(a.length * 2); for (byte b : a) { sb.append(String.format("%02x", b)); } return sb.toString(); } public static void main(String[] args) throws Exception { String timestamp = "1657017150"; String nonce = "3218760"; String payload = "{\\"EventType\\": \\"push\_task\\",\\"EventTime\\": \\"2022-07-05T18:32:30+08:00\\",\\"Version\\": \\"1.0\\",\\"Data\\": {\\"TaskName\\": \\"测试任务\\",\\"TaskId\\": 7114859245769819692,\\"GroupId\\": 1736502630758487,\\"GenerateType\\": \\"source\_id2\\",\\"SourceName\\": \\"source\_id2\\",\\"PushTitle\\": \\"测试标题\\",\\"PushAbstract\\": \\"测试摘要\\",\\"ExpectExecuteTime\\": 1656560797,\\"TargetPeople\\": \\"all\\",\\"TargetAppId\\": 229586,\\"TargetAppName\\": \\"cms测试\\"}}"; String data = timestamp + nonce + payload; String secureKey = "mysecret"; System.out.println(calculateHMac(secureKey, data)); } }`, }, ] return (); ``` # 请求参数 | 参数 | 类型 | 说明 | | --- | --- | --- | | EventType | string | 推送类型。
push\_task：通用推送
push\_indi\_task：个性化推送
group\_tag\_change：内容关联标签变更 |\ ||| topic\_tag\_change：专题关联标签变更 |\ ||| tag\_tree\_change：标签树元数据变更 |\ ||| distribute\_task\_rule\_change：分发任务运营规则变更 |\ ||| audit_task_change：质检任务数据变更 |\ ||| audit_retrace_change：质检回查数据变更 |\ ||| group\_status\_change：内容状态变更 |\ ||| topic\_status\_change：专题状态变更 |\ ||| topic\_info\_change：专题内容变更 |\ ||| article\_sim：内容判重能力识别 |\ ||| media\_recognition: 画面/音频文字识别 | | EventTime | string | 事件产生时间，格式 RFC3339，如：2022-08-10T10:29:16+08:00 | | Version | string | 版本号 | | BizPrimaryKey | string | 任务ID，可以在控制台查看回调记录 | | Data | object | 具体格式根据 EventType 而定。
push\_task：通用推送，对应 PushTaskData
push\_indi\_task：个性化推送，对应 PushIndiTaskData |\ ||| group\_tag\_change：内容关联标签变更，对应 GroupTagChangeData |\ ||| topic\_tag\_change：专题关联标签变更，对应 GroupTagChangeData |\ ||| tag\_tree\_change：标签树元数据变更，对应 TagTreeChangeData |\ ||| distribute\_task\_rule\_change：分发任务运营规则变更，对应 DistributeTaskRuleChangeData |\ ||| audit_task_change：质检任务数据变更，对应AuditTaskChangeData |\ ||| audit_retrace_change：质检回查数据变更，对应AuditRetraceChangeData |\ ||| group\_status\_change：内容状态变更，对应GroupStatusChangeData |\ ||| topic\_status\_change：专题状态变更，对应TopicStatusChangeData |\ ||| topic\_info\_change：专题内容变更，对应TopicInfoChangeData | \ ||| article\_sim：内容判重能力识别，对应ArticleSimilarData | \ ||| media\_recognition: 画面/音频文字识别，对应ArticleRecognitionData | ## PushTaskData 通用推送任务的数据格式。 | 参数 | 类型 | 说明 | | --- | --- | --- | | TaskId | int | 任务ID | | TaskName | string | 任务名称 | | GroupId | int | 内容ID | | GroupOpenId | string | 内容OpenId | | GenerateType | string | 内容来源标识 | | SourceName | string | 内容来源名称 | | PushTitle | string | 推送标题 | | PushAbstract | string | 推送摘要 | | ExpectExecuteTime | int | 推送时间，unix时间戳，单位：秒 | | TargetPeople | string | 推送模式。all：通用推送 | | TargetAppId | int | 推送应用ID | | TargetAppName | string | 推送应用名称 | | IsTestData | bool | 是否是测试数据 | ## PushIndiTaskData 个性化推送任务的数据格式。 | 参数 | 类型 | 说明 | | --- | --- | --- | | TaskId | int | 任务ID | | TaskVersion | int | 任务版本号 | | TaskName | string | 任务名称 | | TargetAppId | int | 推送应用ID | | TargetAppName | string | 推送应用名称 | | PushTime | int | 推送时间，unix时间戳，单位：秒 | | PushCount | int | 推送数量 | | PushItem | string | 推送内容链接，csv文件，格式如下 | | IsTestData | bool | 是否是测试数据 | **PushItem csv 文件格式：** ``` task_id,task_version,uniq_user_id,group_id,group_open_id,push_title,push_abstract,generate_type,source_name, 178123,421321,111,12312341,341,推送标题,推送摘要,来源标识,来源名称, ``` **csv文件头各字段含义**： | 字段 | 说明 | | --- | --- | | task\_id | 任务ID | | task\_version | 任务版本号 | | uniq\_user\_id | 用户ID | | group\_id | 文章ID | | group\_open\_id | 文章OpenId | | push\_title | 推送标题 | | push\_abstract | 推送摘要 | | generate\_type | 来源标识 | | source\_name | 来源名称 | ## GroupTagChangeData 内容关联标签变更和专题关联标签变更数据格式。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'ChangeTags', type: 'list', description: '变更的标签', children: [ { key: '3', name: 'ChangeType', type: 'string', description: '变更类型。add：新增，del：删除，edit：编辑', }, { key: '4', name: 'Tags', type: 'list', description: '变更的标签', children: [ { key: '5', name: 'TagId', type: 'string', description: '标签ID', }, { key: '6', name: 'TagIdentity', type: 'string', description: '标签标识', }, { key: '7', name: 'TagName', type: 'string', description: '标签名称', }, { key: '8', name: 'OldTagName', type: 'string', description: '旧标签名称', }, { key: '9', name: 'TagLevel', type: 'int', description: '标签级别', }, { key: '10', name: 'TagType', type: 'string', description: '标签类型
custom：自定义标签
custom_read：自定义只读标签
custom_hide：自定义隐藏标签
system：系统标签', }, { key: '11', name: 'ParentTagId', type: 'string', description: '父标签ID', }, { key: '12', name: 'ParentTagIdentity', type: 'string', description: '父标签标识', }, { key: '13', name: 'TagScore', type: 'float', description: '内容关联的标签分值，注意：被删除关联的标签不返回分值', }, ], }, ], }, { key: '14', name: 'TagList', type: 'list', description: '文章或专题当前标签', children: [ { key: '15', name: 'TagId', type: 'string', description: '标签ID', }, { key: '16', name: 'TagIdentity', type: 'string', description: '标签标识', }, { key: '17', name: 'TagName', type: 'string', description: '标签名称', }, { key: '18', name: 'OldTagName', type: 'string', description: '旧标签名称', }, { key: '19', name: 'TagLevel', type: 'int', description: '标签级别', }, { key: '20', name: 'TagType', type: 'string', description: '标签类型
custom：自定义标签
custom_read：自定义只读标签
custom_hide：自定义隐藏标签
system：系统标签', }, { key: '21', name: 'ParentTagId', type: 'string', description: '父标签ID', }, { key: '22', name: 'ParentTagIdentity', type: 'string', description: '父标签标识', }, { key: '23', name: 'TagScore', type: 'float', description: '内容关联的标签分值，注意：被删除关联的标签不返回分值', }, ], }, { key: '24', name: 'ObjectId', type: 'string', description: '文章ID或专题ID', }, { key: '25', name: 'ObjectOpenId', type: 'string', description: '文章OpenId或专题OpenId', }, ]; return (); ``` ## TagTreeChangeData 标签树元数据变更。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'ChangeTags', type: 'list', description: '变更的标签', children: [ { key: '3', name: 'ChangeType', type: 'string', description: '变更类型。add：新增，del：删除，edit：编辑', }, { key: '4', name: 'Tags', type: 'list', description: '变更的标签', children: [ { key: '5', name: 'TagId', type: 'string', description: '标签ID', }, { key: '6', name: 'TagIdentity', type: 'string', description: '标签标识', }, { key: '7', name: 'TagName', type: 'string', description: '标签名称', }, { key: '8', name: 'OldTagName', type: 'string', description: '旧标签名称', }, { key: '9', name: 'TagLevel', type: 'int', description: '标签级别', }, { key: '10', name: 'TagType', type: 'string', description: '标签类型
custom：自定义标签
custom_read：自定义只读标签
custom_hide：自定义隐藏标签
system：系统标签', }, { key: '11', name: 'ParentTagId', type: 'string', description: '父标签ID', }, { key: '12', name: 'ParentTagIdentity', type: 'string', description: '父标签标识', }, ], }, ], }, ]; return (

); ``` ## DistributeTaskRuleChangeData 分发任务运营规则变更。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'DistributeTaskId', type: 'string', description: '分发任务ID', }, { key: '3', name: 'DistributeTaskName', type: 'string', description: '分发任务名称', }, { key: '4', name: 'DistributeRule', type: 'DistributeRuleData', description: '分发任务运营规则', children: [ { key: '5', name: 'TopRules', type: 'list', description: '置顶规则', children: [ { key: '6', name: 'ObjectType', type: 'string', description: '类型，article：文章，collection：集合，topic：专题', }, { key: '7', name: 'ObjectId', type: 'string', description: '文章ID、集合ID或者专题ID，取决于ObjectType的取值', }, { key: '8', name: 'ObjectName', type: 'string', description: '文章标题、集合名称或者专题名称，取决于ObjectType的取值', }, { key: '9', name: 'ExpireTime', type: 'string', description: '失效日期，格式：yyyy-MM-dd hh:mm:ss', }, { key: '10', name: 'NeedImpression', type: 'bool', description: '是否开启展现消重，默认不开启', }, ], }, { key: '11', name: 'ReplaceRules', type: 'list', description: '强插规则', children: [ { key: '12', name: 'ObjectType', type: 'string', description: '类型，article：文章，collection：集合，topic：专题', }, { key: '13', name: 'ObjectId', type: 'string', description: '文章ID、集合ID或者专题ID，取决于ObjectType的取值', }, { key: '14', name: 'ObjectName', type: 'string', description: '文章标题、集合名称或者专题名称，取决于ObjectType的取值', }, { key: '15', name: 'OrderNum', type: 'int', description: '强插位置，顺序从0开始', }, ], }, ], }, ]; return (

); ``` ## AuditTaskChangeData 质检任务数据变更。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'GroupId', type: 'string', description: '文章ID', }, { key: '3', name: 'GroupOpenId', type: 'string', description: '文章openId', }, { key: '4', name: 'GenerateType', type: 'string', description: '内容源标识', }, { key: '5', name: 'AuthorStrategyHit', type: 'string', description: '作者黑白名单命中信息，只有命中黑白名单会返回
BlackList: 命中黑名单;
WhiteList：命中白名单', }, { key: '6', name: 'TaskInfo', type: 'AuditTaskInfo', description: '任务信息，若是命中黑白名单的流程，不存在任务信息', children: [ { key: '7', name: 'ProjectId', type: 'string', description: '队列ID', }, { key: '8', name: 'ProjectTitle', type: 'string', description: '队列名称', }, { key: '9', name: 'ProjectStrategyType', type: 'string', description: '队列类型：

Model：模型
Source：来源
Collection：集合

', }, { key: '10', name: 'TaskId', type: 'string', description: '任务ID', }, { key: '11', name: 'ProcessType', type: 'string', description: '质检流程类型：

OnlyMachine：仅机审
OnlyManual：仅人审
MachineAndManual：机审+人审

', }, { key: '12', name: 'TaskStatus', type: 'string', description: '任务状态：

Waiting：待质检
Completed：已完成
WaitSampling：待抽检

', }, { key: '13', name: 'TaskRound', type: 'string', description: '质检任务轮次：

MachineRound：机审
ManualRound：人审
SamplingRound：抽检
ReviseRound：修正

', }, { key: '14', name: 'TaskResult', type: 'string', description: '质检结果：

Approve：通过
Reject：未通过

', }, { key: '15', name: 'MachineAuditResult', type: 'string', description: '机审结果：

None：无机器质检流程
Normal：正常
Abnormal：异常

', }, { key: '16', name: 'ModelInfoList', type: 'List', description: '疑似 + 高危命中模型', children: [ { key: '17', name: 'ID', type: 'string', description: '模型ID', }, { key: '18', name: 'Name', type: 'string', description: '模型名称', }, { key: '19', name: 'Result', type: 'string', description: '判定结果

Normal 正常
Suspected 疑似
Danger 高危

', }, { key: '20', name: 'Modular', type: 'string', description: '模型体裁：""文本质检模型""，""图片质检模型""，""视频质检模型""，""音频质检模型""', }, { key: '21', name: 'Category', type: 'List', description: '判定类别：""质量"",""低俗"",""谩骂"",""恶心"",""血腥"",""违法违规"",""暴力"",""涉黄"",""敏感词"",""广告"",""涉敏"",""色情"",""敏感内容"",""二维码"",""消保""；
示例：[""质量"",""低俗""]', }, { key: '22', name: 'Prob', type: 'float64', description: '模型得分', }, ], }, { key: '23', name: 'HitInfo', type: 'list', description: '命中词表', }, ], }, ]; return (

); ``` ## AuditRetraceChangeData 质检回查处理。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'GroupId', type: 'string', description: '文章ID', }, { key: '3', name: 'GroupOpenId', type: 'string', description: '文章openId', }, { key: '4', name: 'GenerateType', type: 'string', description: '内容源标识', }, { key: '5', name: 'TaskInfo', type: 'AuditRetraceTaskInfo', description: '回查任务信息', children: [ { key: '6', name: 'TaskId', type: 'string', description: '任务ID', }, { key: '7', name: 'TaskName', type: 'string', description: '任务名称', }, ], }, { key: '8', name: 'TaskResult', type: 'string', description: '回查处理；

Approve：上线
Reject：下线

', }, ]; return (

); ``` ## GroupStatusChangeData 内容状态变更数据格式。 | 参数 | 类型 | 说明 | | --- | --- | --- | | GroupId | string | 内容ID | | GroupOpenId | string | 内容openId | | FromStatus | string | 变更前状态，枚举请见： “内容状态枚举” | | ToStatus | string | 变更后状态，枚举请见： “内容状态枚举” | | GenerateType | string | 内容来源 | | ChangeTime | string | 变更时间例子： 2023-01-01 10:00:00 |\ ||| **内容状态枚举** | 枚举值 | 说明 | | --- | --- | | init | 初始化 | | import | 导入中 | | import\_failed | 导入失败 | | import\_timeout | 导入超时 | | online | 已上线 | | wait\_audit | 等待审核 | | reject\_audit | 审核驳回 | | offline | 已下线 | | delete | 已删除 | ## TopicStatusChangeData 专题状态变更数据格式。 | 参数 | 类型 | 说明 | | --- | --- | --- | | TopicId | string | 专题ID | | TaskOpenId | string | 专题openId | | FromStatus | string | 变更前状态，枚举请见： “专题状态枚举” | | ToStatus | string | 变更后状态，枚举请见： “专题状态枚举” | | TopicSource | string | 专题来源 |\ ||| 枚举值：

api：外部引入
cms：自建专题
toutiao_api：火山同步

| | ChangeTime | string | 变更时间例子： 2023-01-01 10:00:00 | **专题状态枚举** | 枚举值 | 说明 | | --- | --- | | offline | 下线 | | online | 上线 | | syncing | 同步中 | | delete | 已删除 | ## TopicInfoChangeData 专题内容变更数据格式。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'TopicId', type: 'string', description: '专题ID', }, { key: '3', name: 'TaskOpenId', type: 'string', description: '专题openId', }, { key: '4', name: 'TopicStatus', type: 'string', description: '专题状态，枚举请见： “专题状态枚举”', }, { key: '5', name: 'TopicSource', type: 'string', description: '专题来源
枚举值：

api：外部引入
cms：自建专题
toutiao_api：火山同步

', }, { key: '6', name: 'ChangeTime', type: 'string', description: '变更时间例子： 2023-01-01 10:00:00', }, { key: '7', name: 'BasicInfoChange', type: 'BasicInfoChange', description: '基本信息变更', children: [ { key: '8', name: 'From', type: 'TopicBasicInfo', description: '变更前基本信息', children: [ { key: '9', name: 'TopicName', type: 'string', description: '专题名称', }, { key: '10', name: 'CoverImgUrl', type: 'string', description: '封面图片', }, { key: '11', name: 'ShareImgUrl', type: 'string', description: '缩略图片', }, { key: '12', name: 'TopicDesc', type: 'string', description: '描述文案', }, { key: '13', name: 'ExtInfo', type: 'string', description: '扩展字段', }, ], }, { key: '14', name: 'To', type: 'TopicBasicInfo', description: '变更后基本信息', children: [ { key: '15', name: 'TopicName', type: 'string', description: '专题名称', }, { key: '16', name: 'CoverImgUrl', type: 'string', description: '封面图片', }, { key: '17', name: 'ShareImgUrl', type: 'string', description: '缩略图片', }, { key: '18', name: 'TopicDesc', type: 'string', description: '描述文案', }, { key: '19', name: 'ExtInfo', type: 'string', description: '扩展字段', }, ], }, ], }, { key: '20', name: 'LandingPageUrlChange', type: 'LandingPageUrlChange', description: '详情页链接变更', children: [ { key: '21', name: 'From', type: 'string', description: '变更前详情页链接', }, { key: '22', name: 'To', type: 'string', description: '变更前详情页链接', }, ], }, ]; return (

); ``` ## ArticleSimilarData 内容判重数据格式。 ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'GroupId', type: 'string', description: '文章ID', }, { key: '3', name: 'GroupOpenId', type: 'string', description: '文章外部ID', }, { key: '4', name: 'GenerateType', type: 'string', description: '内容源标识', }, { key: '5', name: 'SimId', type: 'string', description: '文章重复组ID', }, { key: '6', name: 'EarliestSimArticleInfos', type: 'List< SimArticleInfo >', description: '重复组列表', children: [ { key: '7', name: 'GroupId', type: 'string', description: '文章ID', }, { key: '8', name: 'GroupOpenId', type: 'string', description: '文章外部ID', }, { key: '9', name: 'GenerateType', type: 'string', description: '内容源标识', }, ], }, ]; return (

); ``` ## ArticleRecognitionData 画面/音频文字识别数据格式。 | **参数** | **类型** | **说明** | | --- | --- | --- | | GroupId | string | 文章ID | | GroupGenerateType | string | 内容源 | | GroupOpenId | string | 文章OpenID | | ResultUrl | string | 文件链接，链接有效期两个月。 |\ ||| - 文件中的详细内容格式见如下ArticleRecogtionJson |\ ||| - 文件内容的编码格式为UTF-8 |\ ||| - 示例文件： | **ArticleRecognitionJson** ```mixin-react const columns = [ { width: '22.5%', title: '参数', dataIndex: 'name', }, { width: '22.5%', title: '类型', dataIndex: 'type', }, { title: '说明', dataIndex: 'description', render:(val)=>, }, ]; const data = [ { key: '1', name: 'GroupId', type: 'string', description: '文章ID', }, { key: '3', name: 'GroupGenerateType', type: 'string', description: '内容源', }, { key: '4', name: 'GroupOpenId', type: 'string', description: '文章OpenID', }, { key: '5', name: 'ResultData', type: 'list', description: '', children: [ { key: '6', name: 'MediaType', type: 'string', description: '媒资类型，枚举值如下：

image
video

', }, { key: '7', name: 'MediaUrl', type: 'string', description: '媒资数据链接', }, { key: '8', name: 'Success', type: 'bool', description: '', }, { key: '9', name: 'FailReason', type: 'string', description: '失败原因说明，例如资源链接错误', }, { key: '10', name: 'OcrResult', type: 'list', description: '画面提取结果', children: [ { key: '11', name: 'Text', type: 'string', description: '文本汇总', }, { key: '12', name: 'Language', type: 'string', description: '语种', }, { key: '13', name: 'FrameOcrData', type: 'list', description: '逐帧详情', children: [ { key: '14', name: 'FrameNo', type: 'number', description: '帧号', }, { key: '15', name: 'CutTimeMill', type: 'double', description: '帧截取的时间(毫秒)', }, { key: '16', name: 'PatchOcrData', type: 'list', description: '该帧上，不同位置识别详情', children: [ { key: '17', name: 'Text', type: 'string', description: '文本', }, { key: '18', name: 'DetPoints', type: 'list', description: '位置信息，从左上角开始按顺时针顺序排布', children: [ { key: '19', name: 'X', type: 'double', description: '', }, { key: '20', name: 'Y', type: 'double', description: '', }, ], }, { key: '21', name: 'Prob', type: 'double', description: '置信度', }, ], }, ], }, ], }, { key: '22', name: 'AsrResult', type: 'AsrData', description: '音频提取结果', children: [ { key: '23', name: 'Text', type: 'string', description: '音频文本汇总', }, { key: '24', name: 'Utterances', type: 'list', description: '分句音频详情', children: [ { key: '25', name: 'Text', type: 'string', description: '音频文本（句）', }, { key: '26', name: 'StartTimeMill', type: 'number', description: '起始时间（单位：毫秒）', }, { key: '27', name: 'EndTimeMill', type: 'number', description: '结束时间（单位：毫秒）', }, { key: '28', name: 'Words', type: 'list', description: '分词音频详情', children: [ { key: '29', name: 'Text', type: 'string', description: '音频文本（词）', }, { key: '30', name: 'StartTimeMill', type: 'number', description: '起始时间（单位：毫秒）', }, { key: '31', name: 'EndTimeMill', type: 'number', description: '结束时间（单位：毫秒）', }, ], }, ], }, ], }, ], }, ]; return (

); ``` # 响应参数响应数据为 json 格式，各字段含义如下： | 参数 | 类型 | 说明 | | --- | --- | --- | | ret | int | 响应状态码。0：成功，非0：失败 | | msg | string | 响应结果说明。success：成功；失败的时候，在msg中提供相应的失败原因 | # 调用示例 ## 通用推送 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1657017150 X-Cms-Nonce: 3218760 X-Cms-Signature: 3ff837202591cde49e4212f511f1ba253cf634357eba567d39fb446652dfc55e Content-Type: application/json { "EventType": "push_task", "EventTime": "2022-07-05T18:32:30+08:00", "Version": "1.0", "Data": { "TaskName": "测试任务", "TaskId": 7114859245769819692, "GroupId": 1736502630758487, "GenerateType": "source_id2", "SourceName": "source_id2", "PushTitle": "测试标题", "PushAbstract": "测试摘要", "ExpectExecuteTime": 1656560797, "TargetPeople": "all", "TargetAppId": 229586, "TargetAppName": "cms测试" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 个性化推送 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1666346544 X-Cms-Nonce: 6208626 X-Cms-Signature: 7d2681c9fd6b835770b6aac708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "push_indi_task", "EventTime": "2022-10-21T18:02:24+08:00", "Version": "1.0", "Data": { "TaskId": 7156892213677606444, "TaskVersion": 7156892213677639212, "TaskName": "test task", "TargetAppId": 229586, "TargetAppName": "test app", "PushTime": 1666346401, "PushCount": 10000, "PushItem": "https://lf-volccms-sign.onewsstatic.com/test.csv", "IsTestData": false, } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 内容关联标签变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1683190242 X-Cms-Nonce: 6998626 X-Cms-Signature: 7d2681c9fd6b800770b6aac708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "group_tag_change", "EventTime": "2023-05-04T16:50:42+08:00", "Version": "1.0", "BizPrimaryKey": "1764225119429645_1683190241189", "Data": { "ObjectId": "1764225119429645", "ObjectOpenId": "5119429", "TagList": [ { "TagIdentity": "高级", "TagName": "高级-修改", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254139754510" }, { "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254146364430", "TagIdentity": "中级", "TagName": "中级-修改", "TagLevel": 1 }, { "TagIdentity": "低级", "TagName": "低级", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254154142733" }, { "TagIdentity": "custom.tag1", "TagName": "tag1", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1757436527251463" }, { "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1757880544795656", "TagIdentity": "testfinder", "TagName": "testfinder", "TagLevel": 1, "TagType": "custom" }, { "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1757882181023752", "TagIdentity": "1", "TagName": "12", "TagLevel": 1 }, { "TagId": "1758641991276552", "TagIdentity": "custom.测试", "TagName": "测试", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "" }, { "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1760528054520909", "TagIdentity": "custom.meimei", "TagName": "meimei", "TagLevel": 1 }, { "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1760852208628750", "TagIdentity": "222", "TagName": "222" }, { "TagId": "1762120939453448", "TagIdentity": "专题屏蔽标签", "TagName": "专题屏蔽标签", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "" }, { "TagIdentity": "文章标签屏蔽", "TagName": "文章标签屏蔽", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1762121143197704" } ], "ChangeTags": [ { "ChangeType": "del", "Tags": [ { "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1758641991276568", "TagIdentity": "custom.zidingyi", "TagName": "zidingyi", "TagLevel": 1, "TagType": "custom" } ] } ] } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 专题关联标签变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1683171064 X-Cms-Nonce: 6008626 X-Cms-Signature: 7d2681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "topic_tag_change", "EventTime": "2023-05-04T11:31:04+08:00", "Version": "1.0", "BizPrimaryKey": "1764389673043112_1683171063901", "Data": { "ChangeTags": [ { "ChangeType": "add", "Tags": [ { "TagIdentity": "高级", "TagName": "高级-修改", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254139754510" }, { "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254146364430", "TagIdentity": "中级", "TagName": "中级-修改" }, { "TagIdentity": "低级", "TagName": "低级", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254154142733" } ] } ], "ObjectId": "1764389673043112", "ObjectOpenId": "5164389673019429", "TagList": [ { "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254139754510", "TagIdentity": "高级", "TagName": "高级-修改" }, { "TagIdentity": "中级", "TagName": "中级-修改", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254146364430" }, { "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1756254154142733", "TagIdentity": "低级", "TagName": "低级" } ] } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 标签树元数据变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1683188922 X-Cms-Nonce: 6009826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "tag_tree_change", "EventTime": "2023-05-04T16:28:42+08:00", "Version": "1.0", "BizPrimaryKey": "1764951430147086_1683188921707", "Data": { "ChangeTags": [ { "ChangeType": "del", "Tags": [ { "TagName": "子用户1-改", "TagLevel": 1, "TagType": "custom", "ParentTagId": "", "ParentTagIdentity": "", "TagId": "1764951430147086", "TagIdentity": "子用户1" } ] } ] } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 分发任务运营规则变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "distribute_task_rule_change", "EventTime": "2023-06-12T16:28:42+08:00", "Version": "1.0", "BizPrimaryKey": "1766124001710135_1686558522101", "Data": { "DistributeTaskId": "1766124001710135", "DistributeTaskName": "个性化切换成高时效关闭去重", "DistributeRule": { "TopRules": [ { "ObjectType": "article", "ObjectId": "1764062806976542", "ObjectName": "test7", "ExpireTime": "2023-06-14 10:34:16", "NeedImpression": true }, { "ObjectType": "article", "ObjectId": "1766954816806951", "ObjectName": "测试文章", "ExpireTime": "2023-06-15 10:34:30", "NeedImpression": false } ], "ReplaceRules": [ { "ObjectType": "article", "ObjectName": "兜底测试", "ObjectId": "1714042758674462", "OrderNum": 0 }, { "ObjectType": "article", "ObjectName": "发文时间", "ObjectId": "1767945685849112", "OrderNum": 1 } ] } } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 质检任务数据变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType":"audit_task_change", "EventTime":"2023-08-17T15:57:07+08:00", "Version":"1.0", "BizPrimaryKey":"7268193281803157794_1692259027000", "Data":{ "GroupOpenId":"", "TaskInfo":{ "MachineAuditResult":"None", "ModelInfoList":[ ], "ProcessType":"OnlyManual", "ProjectTitle":"test_dong-图文", "HitInfo":null, "TaskRound":"ManualRound", "TaskResult":"Reject", "ProjectStrategyType":"Source", "ProjectId":"1687076699474067456", "TaskStatus":"Completed", "TaskId":"1692080666563522560" }, "AuthorStrategyHit":null, "GenerateType":"test_dong", "GroupId":"7268193281803157794" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 质检回查数据变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType":"audit_retrace_change", "EventTime":"2023-08-18T11:16:21+08:00", "Version":"1.0", "BizPrimaryKey":"1234551233_1692328581012", "Data":{ "GroupId":"1234551233", "GroupOpenId":"12988888", "GenerateType":"test_dong", "TaskInfo":{ "TaskId":"123456", "TaskName":"xxx指定内容回查" }, "TaskResult":"Reject" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 内容状态变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType":"group_status_change", "EventTime":"2023-08-18T11:16:21+08:00", "Version":"1.0", "BizPrimaryKey":"1234551233_1692328581012", "Data":{ "GroupId":"1234551233", "GroupOpenId":"12988888", "GenerateType":"test_dong", "FromStatus":"init", "ToStatus":"online", "ChangeTime":"2023-01-01 10:10:00" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 专题状态变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType":"topic_status_change", "EventTime":"2023-08-18T11:16:21+08:00", "Version":"1.0", "BizPrimaryKey":"1234551233_1692328581012", "Data":{ "TopicId":"1234551233", "TopicOpenId":"12988888", "FromStatus":"online", "ToStatus":"offline", "TopicSource":"api", "ChangeTime":"2023-01-01 10:10:00" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 专题内容变更 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType":"topic_info_change", "EventTime":"2023-08-18T11:16:21+08:00", "Version":"1.0", "BizPrimaryKey":"1234551233_1692328581012", "Data":{ "TopicId":"1234551233", "TopicOpenId":"12988888", "TopicStatus":"online", "TopicSource":"api", "BasicInfoChange":{ "From":{ "TopicName":"专题名1", "CoverImgUrl":"https://pic2.zhimg.com/v2-998d6350e0310199125669a438c574b6_", "ShareImgUrl":"https://pic2.zhimg.com/v2-998d6350e0310199125669a438c574b6_", "TopicDesc":"xxxx", "ExtInfo":"abc" }, "To":{ "TopicName":"专题名2", "CoverImgUrl":"https://pic2.zhimg.com/v2-998d6350e0310199125669a438c574b6_", "ShareImgUrl":"https://pic2.zhimg.com/v2-998d6350e0310199125669a438c574b6_", "TopicDesc":"xxxx", "ExtInfo":"abc" } }, "LandingPageUrlChange":{ "From":"https://pic2.zhimg.com/v2-998d6350e0310199125669a438c574b6_", "To":"https://pic1.zhimg.com/v2-998d6350e0310199125669a438c574b6_" } "ChangeTime":"2023-01-01 10:10:00" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 内容判重能力识别 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1686558522 X-Cms-Nonce: 6109826 X-Cms-Signature: 922681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c*** Content-Type: application/json { "EventType": "article_sim", "EventTime": "2024-04-10T15:29:41+08:00", "Version": "1.0", "BizPrimaryKey": "7356080384813073959", "Data": { "IsTestData": true, "GroupId": "1791480551822340", "GroupOpenId": "", "GenerateType": "cms_test", "SimId": "1791850737416308", "EarliestSimArticleInfos": [ { "GroupId": "1793150737416308", "GroupOpenId": "7931507000001", "GenerateType": "toutiao" }, { "GroupId": "1794178666711052", "GroupOpenId": "7931507000002", "GenerateType": "ugc" }, { "GroupId": "1794178207943738", "GroupOpenId": "7931507000003", "GenerateType": "cms_test" } ] } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` ## 画面/音频文字识别 ### 请求示例 ``` POST / HTTP/1.1 Host: xxx.xxx.xxx X-Cms-Timestamp: 1683171064 X-Cms-Nonce: 6008626 X-Cms-Signature: 7d2681c9fd6b800770b688c708c5a5702f94ecbf818b18bf910de4e8cb69c260 Content-Type: application/json { "EventType": "media_recognition", "EventTime": "2024-03-26T10:08:03+08:00", "Version": "1.0", "BizPrimaryKey": "1234567654321_1711418882743", "Data":{ "IsTestData": true, "GroupId": "1234567654321" "GroupGenerateType": "test_source" "GroupOpenId":"", "ResultUrl":"https://content.volccdn.com/obj/volc-content/cms/sample-data/recognition_sample.txt" } } ``` ### 响应示例 ``` { "ret":0, "msg":"success" } ``` # 注意事项 :::warning - **防重复推送说明**：建议客户侧服务端根据请求参数中的业务主键做防重复 - **请求超时说明**：默认10s超时。建议服务端收到回调请求后，先确认回调结果，再异步进行业务逻辑处理，避免回调超时。 ::: # 推送埋点事件适用于推送类型为push_task（通用推送）或push_indi_task（个性化推送）。 | 事件名称 | 事件 | 上报时机 | 核心参数 | 字段类型 | 字段描述 | 说明 | | :-: | :-: | :-: | :-: | :-: | :-: | :-: | | PUSH消息接收【服务端埋点】 | cms\_push\_receive | 客户侧服务端接收到push消息（成功时上报） | enter\_from | string | 入口 | 固定值，上报click\_category | | ^^ | ^^ | ^^ | group\_id | bigint | 内容 id | 对应内容推荐接口返回的GroupId | | ^^ | ^^ | ^^ | push\_id | string | push任务id | 对应的push任务id | | ^^ | ^^ | ^^ | push\_version\_id | string | push任务轮次id | 对应的push任务的轮次id | | ^^ | ^^ | ^^ | \_\_items | string | 用于内容特征分析 | \[{\\"group\_item\\":\[{\\"id\\":\\"xx\\"}\]}\]， id为GroupId | | ^^ | ^^ | ^^ | params\_for\_special | string | 用于标识内容管理平台 | 固定值，上报content\_manager\_system | | PUSH消息下发 | cms\_push\_send | 下发push内容 | category\_name | string | 场景id | 管理平台场景id，需创建PUSH场景 | | ^^ | ^^ | ^^ | enter\_from | string | 入口 | 固定值，上报click\_category | | ^^ | ^^ | ^^ | group\_id | bigint | 内容 id | 对应内容推荐接口返回的GroupId | | ^^ | ^^ | ^^ | push\_id | string | push任务id | 对应的push任务id | | ^^ | ^^ | ^^ | push\_version\_id | string | push任务轮次id | 对应的push任务的轮次id | | ^^ | ^^ | ^^ | \_\_items | string | 用于内容特征分析 | \[{\\"group\_item\\":\[{\\"id\\":\\"xx\\"}\]}\]， id为GroupId | | ^^ | ^^ | ^^ | params\_for\_special | string | 用于标识内容管理平台 | 固定值，上报content\_manager\_system | | PUSH消息展现 | cms\_push\_show | push内容在通知栏展示 | category\_name | string | 场景id | 管理平台场景id，需创建PUSH场景 | | ^^ | ^^ | ^^ | enter\_from | string | 入口 | 固定值，上报click\_category | | ^^ | ^^ | ^^ | group\_id | bigint | 内容 id | 对应内容推荐接口返回的GroupId | | ^^ | ^^ | ^^ | push\_id | string | push任务id | 对应的push任务id | | ^^ | ^^ | ^^ | push\_version\_id | string | push任务轮次id | 对应的push任务的轮次id | | ^^ | ^^ | ^^ | \_\_items | string | 用于内容特征分析 | \[{\\"group\_item\\":\[{\\"id\\":\\"xx\\"}\]}\]， id为GroupId | | ^^ | ^^ | ^^ | params\_for\_special | string | 用于标识内容管理平台 | 固定值，上报content\_manager\_system | | ^^ | ^^ | ^^ | req\_id | string | 请求id | 请求内容推荐接口返回的RequestId | | PUSH消息点击 | cms\_push\_click | 从通知栏点击push内容 | category\_name | string | 场景id | 管理平台场景id，需创建PUSH场景 | | ^^ | ^^ | ^^ | enter\_from | string | 入口 | 分享回流，上报click\_category | | ^^ | ^^ | ^^ | group\_id | bigint | 内容id | 对应内容推荐接口返回的GroupId | | ^^ | ^^ | ^^ | push\_id | string | push任务id | 对应的push任务id | | ^^ | ^^ | ^^ | push\_version\_id | string | push任务轮次id | 对应的push任务的轮次id | | ^^ | ^^ | ^^ | \_\_items | string | 用于内容特征分析 | \[{\\"group\_item\\":\[{\\"id\\":\\"xx\\"}\]}\]， id为GroupId | | ^^ | ^^ | ^^ | params\_for\_special | string | 用于标识内容管理平台 | 固定值，上报content\_manager\_system | | ^^ | ^^ | ^^ | req\_id | string | 请求id | 请求内容推荐接口返回的RequestId |