You need to enable JavaScript to run this app.
导航
BatchCreateSourceArticle - 内容同步
最近更新时间:2024.06.11 16:20:23首次发布时间:2021.07.05 21:23:10

客户侧研发人员,可通过该接口将自有内容同步至内容管理平台。

使用场景

适用于实时产生的增量内容的引入。

注意事项

  • 请求频率:本接口限制10QPS,每秒引入内容总条数(QPS*[Articles])建议不超过10条
  • 使用限制:
    • 测试阶段请勿大批量引入:   测试阶段有调用次数、内容理解、内容质检量的限制;
    • 产品上线前大批量引入:
      • 若需大批量或高QPS引入存量内容,请使用离线内容同步接口,避免影响线上。
      • 大批量引入会将内容理解、内容质检额度消耗完,走超量计费,因此产品上线前大批量引入自有内容,请提前与火山人员联系,以便进一步评估内容消耗额度和内容引入节奏等事宜;
      • 大批量引入的内容发文时间,不要全部为同一发文时间;
      • 默认不分发一年前的内容,不建议引入较早(一年前)的内容,避免造成内容额度的浪费;
  • 前提条件:调用该API前,请先新建Api源

请求说明

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

调试

请求参数

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

Query

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

BatchCreateSourceArticle

要执行的操作,取值:BatchCreateSourceArticle。

Version
String

2021-01-01

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

Body

参数
类型
是否必填
示例值
描述
Articles
Array of ArticleDTO

内容列表,最大值:100。

说明

  • 不支持已引入内容的修改:

返回参数

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

参数
类型
示例值
描述
Result
BatchArticleCreateResult

请求结果

请求示例

{
    "Articles": [
        {
            "OpenId": "",
            "Title": "今年可能是对房地产影响巨大的一年",
            "Abstract":"我买卖过好几次房,现在每个月也去看房,这个问题思考得也多,所以有点想法,跟大家分享下。",
            "GroupType": "article",
            "GroupSource": "api",
            "Link":"",
            "Tags":[
                ""
            ],
            "Author": {
                "AuthorName": "某某作者",
                "AuthorAvatarUrl":"https://is3-ssl.mzstatic.com/image/thumb/Purple71/v4/ef/4b/***.jpg"
            },
            "CoverImages":[
                {
                    "Url":"https://p1-tt.byteimg.com/origin/pgc-image/***"
                }
            ],
            "PublishTime":1626334737,
            "GroupImages": [
                 {
                    "Url":""
                }
            ],
            "SourceName": "某某作者",
            "GenerateType": "moumouzhengqvan",
            "Content":"<p data-track=\"121\"><span style=\"letter-spacing: 1px;\">1994年之前地方富,***。</span></p>"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202301021602014B3D96D54AC98B0A3***",
        "Action": "BatchCreateSourceArticle",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "BatchId": "1707961755910349"
    }
}

错误码

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

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

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

200
600413
批量导入文章数量为0或者超过限制

批量导入文章的数量为0,或者超过了单次导入上限100篇

200
600414
文章导入量超过当日上限

导入文章数量超过了当日上限50万篇

200
600497
账户已失效

账户已失效、请联系商务

200
600498
账号POC已结束

检查账户的poc用量情况和使用时长情况

200
600499
账户信息不可用

检查是否在内容管理平台开户,请联系商务开户

200
600500
服务未知错误

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