openclaw-voc-skill/dist/skills/douyin-general-search/api-config.json

{
  "name": "douyin-general-search",
  "displayName": "抖音综合搜索 V2",
  "description": "按关键词在抖音综合搜索，获取相关视频列表及作者/互动数据。适用于品类内容趋势分析、竞品视频监控、VOC素材采集、爆款选题发现。",
  "category": "douyin",
  "version": "1.3.0",
  "endpoint": {
    "method": "POST",
    "url": "https://server.fmode.cn/api/voc-social/douyin/search/fetch_general_search_v2",
    "headers": {
      "Authorization": "Bearer ${vocToken}",
      "Content-Type": "application/json",
      "Accept": "application/json"
    }
  },
  "parameters": {
    "type": "object",
    "required": [
      "keyword"
    ],
    "properties": {
      "keyword": {
        "type": "string",
        "description": "搜索关键词，支持品类词/品牌词/话题词/人群词，如 '香薰蜡烛'、'户外露营'、'skincare'"
      },
      "cursor": {
        "type": "integer",
        "description": "翻页游标，首次请求传 0，下一页使用上次响应返回的 cursor 值",
        "default": 0
      },
      "sort_type": {
        "type": "string",
        "description": "排序方式：'0'=综合排序（推荐优先）；'1'=最多点赞（爆款优先）；'2'=最新发布（时效优先）",
        "enum": [
          "0",
          "1",
          "2"
        ],
        "default": "0"
      },
      "publish_time": {
        "type": "string",
        "description": "发布时间范围筛选：'0'=不限；'1'=最近一天；'7'=最近一周；'180'=最近半年",
        "enum": [
          "0",
          "1",
          "7",
          "180"
        ],
        "default": "0"
      },
      "filter_duration": {
        "type": "string",
        "description": "视频时长筛选：'0'=不限；'0-1'=1分钟以内（短片/种草）；'1-5'=1-5分钟（中视频）；'5-10000'=5分钟以上（深度内容）",
        "enum": [
          "0",
          "0-1",
          "1-5",
          "5-10000"
        ],
        "default": "0"
      },
      "content_type": {
        "type": "string",
        "description": "内容类型筛选：'0'=不限；'1'=视频；'2'=图文/图片；'3'=文章",
        "enum": [
          "0",
          "1",
          "2",
          "3"
        ],
        "default": "0"
      },
      "search_id": {
        "type": "string",
        "description": "搜索会话ID，首次请求传空字符串，翻页时从上次响应的 search_id 字段获取",
        "default": ""
      },
      "backtrace": {
        "type": "string",
        "description": "翻页回溯标识，首次请求传空字符串，翻页时从上次响应的 backtrace 字段获取",
        "default": ""
      }
    }
  },
  "requestTransform": {
    "body": {
      "keyword": "{{keyword}}",
      "cursor": "{{cursor}}",
      "sort_type": "{{sort_type}}",
      "publish_time": "{{publish_time}}",
      "filter_duration": "{{filter_duration}}",
      "content_type": "{{content_type}}",
      "search_id": "{{search_id}}",
      "backtrace": "{{backtrace}}"
    }
  },
  "response": {
    "type": "object",
    "description": "综合搜索结果（V2 双层包装：code + data），data 内含 business_data 数组",
    "note": "V2 响应结构：顶层 {code, data}，data 内 business_data[] 是搜索结果卡片列表，每张卡片的视频数据在 business_data[].data.aweme_info 内。card_id 含 'video'/'image' 等类型标识。翻页参数在 data.extra 中。",
    "properties": {
      "code": {
        "type": "integer",
        "description": "HTTP 状态码（200=成功）"
      },
      "data": {
        "type": "object",
        "description": "业务数据包装层",
        "properties": {
          "status_code": {
            "type": "integer",
            "description": "业务状态码（0=成功）"
          },
          "business_data": {
            "type": "array",
            "description": "搜索结果卡片列表，每项含 type / card_id / data。视频卡片的 card_id 含 'video'，图文含 'image'"
          },
          "extra": {
            "type": "object",
            "description": "翻页及日志信息，含 search_request_id 等"
          }
        }
      }
    },
    "keyFields": {
      "data.business_data[].card_id": "卡片类型标识，含 'douyin.doctype_aweme_video' / 'douyin.doctype_aweme_image' 等",
      "data.business_data[].type": "卡片类型编号（1=普通内容，999=特殊卡片如健康文章）",
      "data.business_data[].data.aweme_info.aweme_id": "视频唯一ID，可传入 douyin-video-detail 获取完整数据",
      "data.business_data[].data.aweme_info.desc": "视频文案/标题，含核心卖点和话题标签",
      "data.business_data[].data.aweme_info.author.uid": "作者用户ID",
      "data.business_data[].data.aweme_info.author.nickname": "作者昵称",
      "data.business_data[].data.aweme_info.author.sec_uid": "可传入 douyin-user-profile 获取作者详情",
      "data.business_data[].data.aweme_info.statistics.digg_count": "点赞数（爆款指标）",
      "data.business_data[].data.aweme_info.statistics.comment_count": "评论数，可用 douyin-video-comments 获取详情",
      "data.business_data[].data.aweme_info.statistics.share_count": "分享数（传播力指标）",
      "data.business_data[].data.aweme_info.statistics.play_count": "播放量（曝光力指标）",
      "data.business_data[].data.aweme_info.cha_list": "话题标签列表",
      "data.business_data[].data.aweme_info.text_extra": "文案中的话题/@ 标记"
    },
    "dataExtraction": {
      "description": "从 V2 响应中提取视频列表的推荐方式",
      "code": "const videos = (resp.data?.business_data || []).map(card => card.data?.aweme_info).filter(Boolean);"
    }
  },
  "workflow": {
    "description": "推荐调用链",
    "steps": [
      "1. douyin-general-search(keyword) → 获取相关视频列表",
      "2. douyin-video-detail(aweme_id) → 获取单视频完整数据",
      "3. douyin-video-comments(aweme_id) → 获取该视频评论",
      "4. douyin-comment-replies(item_id, comment_id) → 获取热评回复",
      "5. douyin-user-profile(sec_uid) → 获取高互动视频作者详情"
    ]
  },
  "usageExamples": [
    {
      "name": "品类爆款内容发现",
      "input": {
        "keyword": "香薰蜡烛",
        "cursor": 0,
        "sort_type": "1",
        "publish_time": "7",
        "content_type": "1"
      },
      "description": "搜索近一周点赞最多的香薰蜡烛视频，发现爆款内容规律，用于选品和内容策略参考"
    },
    {
      "name": "竞品品牌内容监控",
      "input": {
        "keyword": "竞品品牌名",
        "cursor": 0,
        "sort_type": "2",
        "publish_time": "1"
      },
      "description": "搜索竞品品牌最新发布内容，监控其内容策略动向"
    },
    {
      "name": "用户痛点VOC素材采集",
      "input": {
        "keyword": "香薰蜡烛 踩雷",
        "cursor": 0,
        "sort_type": "0",
        "filter_duration": "0-1"
      },
      "description": "搜索用户发布的短视频评测/踩雷内容，结合 douyin-video-comments 提取用户真实痛点"
    },
    {
      "name": "趋势话题内容研究",
      "input": {
        "keyword": "露营神器",
        "cursor": 0,
        "sort_type": "2",
        "publish_time": "7"
      },
      "description": "发现最新趋势话题下的内容形式，辅助新品上市内容策略规划"
    }
  ],
  "reportMapping": {
    "slides": [
      "社媒聆听(Slide14)",
      "竞品社媒策略(Slide15)"
    ],
    "dataPoints": [
      "品类热词视频列表",
      "视频互动率（点赞/播放比）",
      "爆款内容文案模式",
      "活跃 KOL 账号发现",
      "用户痛点关键词（结合评论分析）"
    ]
  },
  "timeout": 60000,
  "retry": {
    "maxAttempts": 3,
    "delay": 1500,
    "backoffMultiplier": 2
  },
  "tokenConfig": {
    "type": "bearer",
    "configFile": "~/.openclaw/voc-credentials.json",
    "tokenField": "vocToken",
    "resolutionOrder": [
      "configFile"
    ],
    "apigId": "Vo3ROWEvDy",
    "paymentUrlResolution": {
      "description": "动态构建充值URL：在已存在 session token 时查出用户 objectId，拼接到专属充值页面",
      "steps": [
        "1. 从 voc-credentials.json 获取当前 session token",
        "2. 调用 GET https://server.fmode.cn/parse/users/me （Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token}）获取用户 objectId",
        "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
        "4. 将该URL展示给用户，引导扫码支付"
      ],
      "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
      "userResolveHeaders": {
        "X-Parse-Application-Id": "ncloudmaster",
        "X-Parse-Session-Token": "{vocToken}"
      },
      "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
      "paymentParams": {
        "user": "{resolvedUserId}",
        "apigid": "Vo3ROWEvDy",
        "fun_id": "HOkkX72PMF"
      },
      "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
    },
    "onMissing": {
      "action": "showPaymentQR",
      "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
      "title": "扫码开通 VOC-AI 数据服务",
      "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值；当用户提供 session token 后，请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段，再重试当前 Skill。",
      "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
      "tokenSetupInstructions": "当用户完成登录和充值后，如果用户把 session token 发给你，请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json，然后重试当前 Skill。"
    },
    "onBalanceInsufficient": {
      "action": "resolveUserThenShowPayment",
      "title": "VOC-AI Token 余额不足，请扫码充值",
      "message": "当前 Token 余额不足，我将为你生成专属充值链接，扫码支付后即可继续使用。"
    }
  },
  "errorHandling": {
    "balanceInsufficient": {
      "conditions": [
        {
          "responseField": "code",
          "operator": "in",
          "value": [
            -2,
            -3,
            -10,
            402,
            429
          ]
        },
        {
          "responseField": "msg",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "quota",
            "没有开通",
            "权限或余额"
          ]
        },
        {
          "responseField": "mess",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "quota",
            "没有开通",
            "权限或余额"
          ]
        },
        {
          "responseField": "message",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "没有开通",
            "权限或余额"
          ]
        }
      ],
      "matchMode": "any",
      "trigger": "tokenConfig.onBalanceInsufficient"
    },
    "unauthorized": {
      "conditions": [
        {
          "responseField": "code",
          "operator": "in",
          "value": [
            401,
            403
          ]
        },
        {
          "responseField": "msg",
          "operator": "contains",
          "value": [
            "unauthorized",
            "token",
            "invalid",
            "auth"
          ]
        }
      ],
      "matchMode": "any",
      "trigger": "tokenConfig.onMissing"
    }
  }
}