You need to enable JavaScript to run this app.
导航
MGetSyncArticles - 批量获取输出内容
最近更新时间:2024.05.17 14:11:22首次发布时间:2023.06.27 18:54:03

该接口可查看历史同步过的全量内容,用于定向内容更新、状态更新、早期数据回溯。

注意事项

  • 请求频率:该接口用于数据拉取,不建议直接承接线上流量,接口单客户限流20QPS

请求说明

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

调试

请求参数

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

Query

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

MGetSyncArticles

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

Version
String

2023-01-01

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

Body

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

xxx_default_content

渠道号。

GroupIds
Array of String

["724626020xxx041459","725212278xxx880954"]

内容ID列表。一次性最多传入30条,超过30条会截取前30个ID。

返回参数

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

参数
类型
示例值
描述
Articles
Map

Map< String,SyncArticle >。
可访问内容及详情< GroupId,SyncArticle >

MissReasons
Map

{"72462602***0041459": 500001}

Map< String,Integer >。
不可访问内容及原因< GroupId,Reason >。
枚举值:

Reason说明
500001内容未同步;对应同步内容不在该租户下
500008内容因其他原因不可用,可以提供RequestId或GroupId协助查询
500009内容因合规问题被全局下架

请求示例

POST /?Action=MGetSyncArticles&Version=2023-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=MGetSyncArticles&Version=2023-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20240517T053729Z
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",
  "GroupIds": [
    "724626020xxx041459",
    "725212278xxx880954"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202311201116049E5B***9D49D7385CB18",
        "Action": "MGetSyncArticles",
        "Version": "2023-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "Articles": {
            "727312169***685988": {
                "GroupId": "727312169***685988",
                "Title": "内容标题",
                "ArticleType": "feed_video",
                "PublishTime": 1693405606,
                "CreateTime": 1700450117,
                "ArticleUrl": "https://open.toutiao.com/a727312169***685988/?biz_log=BCN4***j4G&group_id=727312169***685988&label=torchlight&utm_source=xxx_default_content",
                "CoverImages": [
                    {
                        "Width": 1920,
                        "Height": 1080,
                        "Url": "http://p6-open-sign.onewsimg.com/tos-cn-i-0004/oM***3tJgUjAf~tplv-tt-cs0:1920:1080.jpeg?scene=core&x-expires=1763522164&x-signature=tOi22YmMGyXMhJEoaj%2Fdts0UGfk%3D"
                    }
                ],
                "Author": {
                    "Name": "作者名称",
                    "AvatarUrl": "https://p6-open-sign.onewsimg.com/user-avatar/29dcbe***6ad24~tplv-obj.jpeg?scene=core&x-expires=1763522164&x-signature=LGlNQwHxqpGup8bXitwVYJLHbE4%3D"
                },
                "Video": {
                    "Duration": 198,
                    "VideoPlayInfos": [
                        {
                            "VideoUrl": "https://open.toutiao.com/video/url/?param=4G3KiZ***ptg7a&partner=xxx_default_content&version=3",
                            "Definition": "360p",
                            "Size": 11307462,
                            "Width": 640,
                            "Height": 360
                        },
                        {
                            "VideoUrl": "https://open.toutiao.com/video/url/?param=4f2VvmmkcpkWerQK3d9AfJwy9Xpe1u85SxcqM4KMferAmvC93MmbAozCuTWkuUEGGguip2Bg8u5yfi2J78kyecUqa4tLcq3YLL6f9JBRZ9P8jCkMPSiJryZzQn4p94Afayn7DooKMFAnn99dvWpxehhAFCo6dphQtKRP7vT2M96RH5nMxQ6NXxDwCPWTCG81scpnJ9aQNk&partner=xxx_default_content&version=3",
                            "Definition": "480p",
                            "Size": 16674282,
                            "Width": 854,
                            "Height": 480
                        }
           ]
                },
                "Interactions": {
                    "ReadCount": 518,
                    "DiggCount": 1,
                    "ShareCount": 0,
                    "CommentCount": 0,
                    "CommentUrl": "https://open.toutiao.com/a727312169***685988/comment/?utm_source=xxx_default_content"
                },
                "Tags": {
                    "Categories": [],
                    "FinanceCategories": [
                        {
                            "Name": "生活",
                            "SubCategories": [
                                {
                                    "Name": "汽车",
                                    "SubCategories": [
                                        {
                                            "Name": "新车测评",
                                            "SubCategories": []
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "CarCategories": []
                },
                "Locations": [
                    {
                        "Code": "51",
                        "Name": "四川省"
                    },
                    {
                        "Code": "510100",
                        "Name": "成都市"
                    }
                ],
                "Collection": {
                    "CollectionId": "727312169***685988",
                    "CollectionName": "横版-同步"
                }
            }
        },
        "MissReasons": {
            "7246260***20041459": 500001
        }
    }
}

错误码

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

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

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

200
600401
账号信息为空

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

200
600403
非法渠道号

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

200
600405
渠道号OpenAPI不可访问

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

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

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

200
600500
默认内部错误

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

200
500001
内容没有同步过

内容没有同步过,检查内容 GroupId 是否被同步过。