You need to enable JavaScript to run this app.
导航
内容定制
  • 文档首页
    • /内容定制/API参考/内容搜索/SearchV2 - 内容搜索
SearchV2 - 内容搜索
最近更新时间：2024.06.04 10:34:01首次发布时间：2023.11.21 14:58:44
我的收藏

本接口主要用于有搜索场景需求的客户，通过搜索词查询相关内容，目前支持搜索的内容体裁包括图文、横版短视频、竖版小视频。
若不指定返回条数Count，则默认每次最多返回10条内容。返回的内容信息包括标题、封面图、发布时间、视频时长、作者名称与头像等，客户侧可使用这些数据，自定义实现搜索页UI。

请求说明

  • 请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
  • 请求地址：https://mercury.volcengineapi.com/?Action=SearchV2&Version=2021-01-01
  • 请求头：ServiceName:content

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

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

SearchV2

要执行的操作，取值：SearchV2。

Version
String
是

2021-01-01

API的版本，取值：2021-01-01。

Partner
String
是

xxx_default_content

渠道号。

AccessToken
String
是

AT6zTZuXzffKpQaxxxBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12

用户唯一标识。

Keyword
String
是

测试

搜索字符串。

Offset
Integer
否

0

分页起始。
默认为0，用于翻页，当HasMore为true时，Offset=当前偏移量+Count。

Count
Integer
否

10

每页数量。
指定返回数据条数，最大不超过20，默认返回10条。

SearchId
String
否

id001

搜索ID。
客户侧搜索id，代表本次搜索的唯一ID，若不传，则火山侧会自动生成一个唯一搜索id。

NeedGroupTypes
String
否

tuwen

内容类型。
用于指定搜索的内容类型。

  • 图文：tuwen；
  • 横版短视频：xigua_video；
  • 竖版小视频：short_video；
  • 多选用英文逗号分隔;
  • 默认输出所有内容类型。

返回参数

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

参数
类型
示例值
描述
SearchId
String

id001

搜索ID，代表本次搜索的唯一ID。

HasMore
Boolean

true

是否加载更多。

  • true：是，加载更多；
  • false：否，已全部加载完毕，没有更多。
Data
Array of SearchArticle

搜索内容列表。

请求示例

GET /?Action=SearchV2&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzffKpQaxxxBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&Keyword=%E6%B5%8B%E8%AF%95 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=SearchV2&Version=2021-01-01
X-Date: 20240603T084818Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240603/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202406031648401031600911103644EF",
    "Action": "SearchV2",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": {
    "SearchId": "id001",
    "HasMore": true,
    "Data": [
      {
        "Abstract": "-",
        "ArticleType": "小视频",
        "ArticleUrl": "https://feedcoop.douyin.com/d7269709590722314788/?a_t=AT6zTZxxxTT12&biz_log=B35nBnxxxAq8&group_id=7269709590722314788&isNews=1&item_id=7269709590722314788&label=search&platform_source=1&req_id=2024xxx3135628237D5D376F678A7DB7F9&utm_campaign=open&utm_medium=webview&utm_source=xxx_default_content",
        "CommentUrl": "https://feedcoop.douyin.com/d7269709590722314788/comment/?a_t=AT6zTZuxxxT12&biz_log=B3xxxAq8&group_id=7269709590722314788&isNews=1&label=search&platform_source=1&req_id=2024060xxx5628237D5D376F678A7DB7F9&utm_source=xxx_default_content",
        "CoverImages": [
          {
            "Url": "https://p6-open-sign.byteimg.com/tos-cn-i-pk90l89vgd/1c6a1776374c4486a46a5a5cbb145ffa~tplv-tt-cut:3216:1810.jpeg?scene=content&x-expires=1747815830&x-signature=ElLytAjeIfSe2O2WkFMqOBY2VUw%3D",
            "Width": 3216,
            "Height": 1810
          }
        ],
        "CoverMode": 1,
        "DiggCount": 10000,
        "GroupId": "7269709590722314788",
        "HasVideo": true,
        "PublishTime": 1692611022,
        "ShareCount": 10000,
        "ShareUrl": "https://feedcoop.douyin.com/d7269709590722314788/?a_t=AT6zxxxT12&biz_log=BAC6xxx1eA&group_id=7269709590722314788&isNews=1&label=share&platform_source=1&req_id=202xxx03135628237D5D376F678A7DB7F9&utm_campaign=open&utm_medium=webview&utm_source=xxx_default_content",
        "Title": "标题",
        "UserInfo": {
          "AvatarUrl": "-",
          "Description": "-",
          "HomePage": "-",
          "Name": "-",
          "Follow": true,
          "FollowerCount": 0,
          "UserId": "-",
          "UserVerified": true,
          "VerifiedContent": "-"
        },
        "VideoWatchCount": 10000,
        "VideoDetail": {
          "VideoDuration": 2230.115,
          "VideoList": [
            {
              "Definition": "360p",
              "Height": 360,
              "Width": 640,
              "Url": "http://mercury.snssdk.com/video/url/?param=ZvBxCxxxK2je&partner=xxx_default_content&version=2&trans_vdata_to_content=1"
            }
          ]
        }
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。