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

TopicCreateFromImport - 专题内容引入

最近更新时间2024.03.01 10:48:25

首次发布时间2022.05.27 19:15:03

该接口用于客户侧引入自建专题内容。

使用场景

  • 如果您需要自有专题内容的引入,请调用该接口引入。
  • 若无,可忽略,直接在控制台新建专题即可,详见:新建专题
  • 若需引入火山来源的专题,联系火山人员开通相关功能。

注意事项

  • 前提条件:已完成专题配置,详见:专题配置

请求说明

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

调试

请求参数

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

Query

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

TopicCreateFromImport

要执行的操作,取值:TopicCreateFromImport

Version
String

2021-01-01

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

Body

参数
类型
是否必填
示例值
描述
Topics
Array of ImportTopicCreateDTO

专题列表,最大值:100。

返回参数

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

参数
类型
示例值
描述
Result
TopicCreateResult

响应数据。

请求示例

{
    "Topics": [
        {
            "OpenId": "ew324d",
            "TopicName": "duplicate topic",
            "CoverImgUrl": "https://testimage...",
            "ShareImgUrl": "https://testimage...",
            "Desc": "test description",
            "LandingPageUrl": "https://testlandingpage...",
            "ExtInfo": "other info",
            "HierarchyTags": [
                {
                    "TagName": "testTagName",
                    "TagIdentity": "testTagIdentity",
                    "ParentTagIdentity": "testParentTagIdentity",
                    "TagType": "custom"
                }
            ],
            "Status": "online",
            "PublishTime": 1678947745
        },
        {
            "OpenId": "jkl3md",
            "TopicName": "newTestTopic",
            "CoverImgUrl": "https://testimage...",
            "ShareImgUrl": "https://testimage...",
            "Desc": "test description",
            "LandingPageUrl": "https://testlandingpage...",
            "ExtInfo": "other info",
            "HierarchyTags": [
                {
                    "TagName": "testTagName",
                    "TagIdentity": "testTagIdentity",
                    "ParentTagIdentity": "testParentTagIdentity",
                    "TagType": "custom"
                }
            ],
            "Status": "offline"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052714534501021004103502946***",
        "Action": "TopicCreateFromImport",
        "Version": "2021-01-01",
        "Service": "volc_content_platform",
        "Region": "cn-north-1"
    },
    "Result": {
        "Topics": [
            {
                "Id": "1733961371358296",
                "TopicSource": "api",
                "OpenId": "jkl3md",
                "Name": "newTestTopic",
                "Description": "test description",
                "CoverImgUrl": "https://testimage...",
                "ShareImgUrl": "https://testimage...",
                "LandingPageUrl": "https://testlandingpage...",
                "Status": "offline",
                "ExtInfo": "other info"
            }
        ],
        "FailedList": [
            {
                "OpenId": "ew324d",
                "TopicName": "duplicate topic",
                "ErrorMsg": "专题已经存在"
            }
        ]
    }
}

错误码

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

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

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

200
600500
服务未知错误

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