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

ScanSyncArticles - 扫描输出内容

最近更新时间2024.05.17 14:11:22

首次发布时间2024.04.18 10:52:16

该接口按同步时间升序,扫描该渠道下最近14天同步的内容,用于做增量内容拉取和数据回溯。

注意事项

  • 请求频率:该接口用于数据拉取,不建议直接承接线上流量,接口单客户限流10QPS
  • 前提条件:已在内容定制控制台,完成内容同步配置。

请求说明

  • 请求方式:POST
  • 请求地址:https://mercury.volcengineapi.com?Action=ScanSyncArticles&Version=2023-01-01
  • 请求头:
    • ServiceName:volc_torchlight_api
    • Content-Type:application/json

调试

请求参数

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

Query

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

ScanSyncArticles

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

Version
String

2023-01-01

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

Body

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

xxx_default_content

渠道号。

NextToken
String

1795299692261403

分页获取下一页内容的游标;
不传递则返回第一页的内容(最近14天内最早的一篇同步内容)。

MaxResults
Integer

20

每页返回的条数,默认值为10,最大值为30,不填或非法输入默认返回10条。

返回参数

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

参数
类型
示例值
描述
NextToken
String

1795299692261403

下一页内容的分页游标。

Articles
Array of SyncArticle

同步内容列表。

说明

  • 如何判断已经拉取到最新的数据?
    返回的Articles为空数组,NextToken和上次请求的一致。

请求示例

POST /?Action=ScanSyncArticles&Version=2023-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=ScanSyncArticles&Version=2023-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20240517T053421Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240517/cn-beijing/volc_torchlight_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UtmSource": "xxx_default_content"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023062111062364***29742C741A10485",
        "Action": "ScanSyncArticles",
        "Version": "2023-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "NextToken": "1795299692261403",
        "Articles": [
            {
                "GroupId": "73532649456***66025",
                "Title": "内容标题",
                "ArticleType": "feed_video",
                "PublishTime": 1692631106,
                "CreateTime": 1700450117,
                "ArticleUrl": "https://open.toutiao.com/a73532649456***66025/?biz_log=BCN***nAn&group_id=73532649456***66025&label=torchlight&utm_source=xxx_default_content",
                "CoverImages": [
                    {
                        "Width": 1280,
                        "Height": 720,
                        "Url": "http://p3-open-sign.onewsimg.com/motor-article-img/e8b***fd3f9c13~tplv-tt-cs0:1280:720.jpeg?scene=core&x-expires=1763522164&x-signature=RN97yC7ctsm%2BtYJI97pXmrHOq%2Fo%3D"
                    }
                ],
                "Author": {
                    "Name": "作者名称",
                    "AvatarUrl": "https://p9-open-sign.onewsimg.com/user-avatar/39fedeb0377f9***b146d57368f0083e~tplv-obj.jpeg?scene=core&x-expires=1763522164&x-signature=oFi2p6RN7wIngCMnJz0PhdK2jQU%3D"
                },
                "Video": {
                    "Duration": 197,
                    "VideoPlayInfos": [
                        {
                            "VideoUrl": "https://open.toutiao.com/video/url/?param=4f2Uq***hcm2Av92WrC&partner=xxx_default_content&version=3",
                            "Definition": "360p",
                            "Size": 12075872,
                            "Width": 640,
                            "Height": 360
                        },
                        ...
                    ]
                },
                "Interactions": {
                    "ReadCount": 357,
                    "DiggCount": 0,
                    "ShareCount": 0,
                    "CommentCount": 0,
                    "CommentUrl": "https://open.toutiao.com/a73532649456***66025/comment/?utm_source=xxx_default_content"
                },
                "Tags": {
                    "Categories": [
                        {
                            "Name": "汽车",
                            "SubCategories": [
                                {
                                    "Name": "汽车选买",
                                    "SubCategories": [
                                        {
                                            "Name": "新车资讯",
                                            "SubCategories": []
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "FinanceCategories": [],
                    "CarCategories": []
                },
                "Locations": [
                    {
                        "Code": "51",
                        "Name": "四川省"
                    },...
                ], 
                "Collection": {
                    "CollectionId": "17825998***4667",
                    "CollectionName": "***"
                }
            }
        ]
    }
}

错误码

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

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

通用参数错误,检查请求结构体,一般是字段类型错误。

200
600401
账号信息为空

账号信息为空,一般是身份信息存在问题。

200
600403
非法渠道号

非法渠道号,需要确保传入内容定制应用下的渠道号,属于当前的火山引擎账号。

200
600405
渠道号OpenAPI不可访问

渠道号OpenAPI不可访问,当前账号无API访问权限,一般是试用账号,需要联系商务。

200
600406
售卖方式与功能不匹配

售卖方式与功能不匹配,当前账号的售卖方式,不支持接口调用。

200
600500
默认内部错误

默认内部错误,兜底的服务端错误码,一般情况可以重试。