数字阅读解决方案提交接口
2021.09.28 14:13:37
接口地址
https://as.dun.163.com/v1/digital/submit
接口描述
适用于网文、电子书、漫画等线上电子阅读进行机审及人审的解决方案（可同时满足图文、音视频全媒体内容混合检测），支持作品或章节维度审核。建议您使用POST请求, 且仅接受 application/x-www-form-urlencoded 编码格式。
请求参数
公共参数已省略，详细见 请求公共参数，请求版本号如下：
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | Y | 4 | 版本号，目前版本号为 v1.1 |
私有参数如下
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| ip | String | N | 128 | 用户IP地址 |
| account | String | N | 128 | 用户唯一标识，如果无需登录则为空 |
| deviceId | String | N | 128 | 用户设备 id，与易盾设备画像库匹配，明文请转大写传入；MD5加密请明文转大写后MD5计算，再转大写传入，建议抄送 |
| deviceType | Number | N | 4 | 用户设备id的类型，0:其他，10:IMEI，11:AndroidID，12:IDFA，13:IDFV，14:MAC ，20:IMEI_MD5，21:AndroidID_MD5，22:IDFA_MD5，23:IDFV_MD5，24:MAC_MD5 |
| publishTime | Number | N | 13 | 发表时间，UNIX 时间戳(毫秒值) |
| dataId | String | N | 128 | 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询 |
| title | String | N | 512 | 标题，可作为章节名称或标题使用 |
| content | String(json数组) | Y | 150000 | json格式正文数据，详见下方content数据结构描述。支持多种类型内容同时过检，包括文本，图片，点播语音，点播视频，点播语音&点播视频，文档 |
| callback | String | N | 512 | 数据回调参数，调用方根据业务情况自行设计，当调用数字阅读解决方案离线接口获取结果时，该接口会原样返回该字段。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。 |
| callbackUrl | String | N | 1024 | 离线结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。 |
| token | String | N | 256 | 数字阅读解决方案支持将部分数据同步到反作弊并检测结果，此字段为反作弊SDK获取的token，接入流程可见防刷版接入流程 |
| chapterNumber | Number | N | 19 | 章节号，用于审核页面顺序展示章节 |
| totalChapters | Number | N | 19 | 章节总数，若抄送，审核页面将会展示正文的命中原因及关键词提取信息，会统计不通过章节数/已审核章节数/总章节数 |
| bookId | String | Y | 64 | 作品ID，以章节为主体抄送时，作品ID用于归类一个作品的章节 |
| bookName | String(jaosn数组) | N | 64 | 作品名称，可用于书籍、小说名称等 |
| bookCover | String(json数组) | N | 150000 | 作品封面图片，json格式，详见下方bookCover数据结构描述，支持提交图片内容 |
| bookInformation | String(json数组 | N | 150000 | 作品信息,json格式正文数据，详见下方bookInformation数据结构描述，默认支持提交文本内容，如果需要支持图片，点播语音，点播视频，点播语音&点播视频，文档业务，请联系易盾策略经理沟通配置 |
| authorName | String | N | 64 | 作者名 |
| totalBooks | Number | N | 19 | 作者作品总数 |
| totalFans | Number | N | 19 | 作者粉丝数 |
| totalCreationDays | Number | N | 19 | 作者创作天数 |
| authorRank | String | N | 64 | 作者等级 |
| type | String | Y | 64 | 场景分类 1 提交只包含书的一章，2 表示提交包含整本书内容 |
content 数据结构
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| type | String | Y | 10 | 类型，分别为text-文本，image-图片，audio-点播语音，video-点播视频，audiovideo-点播语音&点播视频，file-文档 |
| data | String | Y | 5000 | 检测数据，类型为text时最多传入20条文本内容，每条最长5000字符；类型为image时最多传入50张图片url，每张最长512字符；类型为audio时最多传入5条语音url，每条最长512字符；类型为video时最多传入5条视频url，每条最长512字符；类型为audiovideo时最多传入5条音视频url，每条最长512字符；类型为file时最多传入10个文档url，每个最长512字符 |
| dataId | String | N | 128 | 数据唯一标识 |
bookName数据结构
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| type | String | Y | 10 | 类型为text-文本 |
| data | String | Y | 5000 | 单次提交最多传入20条文本内容，每条最长5000字符； |
| dataId | String | N | 128 | 数据唯一标识 |
bookCover 数据结构
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| type | String | Y | 10 | 类型为image-图片 |
| data | String | Y | 5000 | 检测数据，类型为image时最多传入50张图片url，每张最长512字符； |
| dataId | String | N | 128 | 数据唯一标识 |
bookInformation数据结构
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| type | String | Y | 10 | 类型:text-文本，image-图片，video-视频，audio-音频，audiovideo-音视频，file-文档 |
| data | String | Y | 5000 | 检测数据，类型为text时最多传入20条文本内容，每条最长5000字符；如果开启其他检测类别，类型为image时最多传入50张图片url，每张最长512字符；类型为audio时最多传入5条语音url，每条最长512字符；类型为video时最多传入5条视频url，每条最长512字符；类型为audiovideo时最多传入5条音视频url，每条最长512字符；类型为file时最多传入10个文档url，每个最长512字符 |
| dataId | String | N | 128 | 数据唯一标识 |
响应结果
响应字段如下，响应通用字段已省略，详细见响应通用字段：
result 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | String | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| dataId | String | 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询 |
| result | JSON对象 | 如果开启了文本和图片在线返回可以支持在线返回结果，其他业务是异步检测的，检测结果需要在离线接口获取。在线返回的文本和图片结构和"离线结果获取"接口中的"result 数据结构"一样。默认情况或未配置的情况下，检测结果异步回调返回。 |
响应示例
默认返回结构
{
"code":200,
"msg":"ok",
"result":{
"taskId":"91096d5f987f4d7ebeb9ed6b323c640c",
"dataId":"1997602",
"callback":"1608795172"
}
}
开启文本和图片在线返回
{
"code":200,
"msg":"ok",
"result":{
"antispam":{
"taskId":"47cd56309c1247108ce190ad043ea99f",
"dataId":"4581941",
"callback":"1608794932",
"result":1,
"checkStatus":1,
"resultType":1,
"censorSource":2,
"evidences":{
"texts":[
{
"action":0,
"dataId":"972897",
"labels":[
],
"field":"other"
},
{
"action":0,
"dataId":"972197",
"labels":[
],
"field":"other"
},
{
"action":0,
"dataId":"9744897",
"labels":[
],
"field":"other"
}
],
"images":[
{
"name":"47cd56309c1247108ce190ad043ea99f",
"dataId":"975557",
"status":0,
"action":0,
"labels":[
{
"label":500,
"level":0,
"rate":0.96637547
},
{
"label":300,
"level":0,
"rate":1
},
{
"label":100,
"level":0,
"rate":0.99989283
},
{
"label":400,
"level":0,
"rate":1
},
{
"label":110,
"level":0,
"rate":0.9997302
},
{
"label":200,
"level":0,
"rate":1
},
{
"label":210,
"level":0,
"rate":1
},
{
"label":900,
"level":0,
"rate":1
}
],
"field":"other"
},
{
"name":"47cd56309c1247108ce190ad043ea99f",
"dataId":"973337",
"status":0,
"action":0,
"labels":[
{
"label":500,
"level":0,
"rate":0.9828871
},
{
"label":300,
"level":0,
"rate":1
},
{
"label":100,
"level":0,
"rate":0.99990004
},
{
"label":400,
"level":0,
"rate":1
},
{
"label":110,
"level":0,
"rate":0.9988941
},
{
"label":200,
"level":0,
"rate":1
},
{
"label":210,
"level":0,
"rate":1
},
{
"label":900,
"level":0,
"rate":1
}
],
"field":"other"
}
],
"audios":[
],
"videos":[
],
"audiovideos":[
],
"files":[
]
}
}
}
}
