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

{
  "name": "douyin-hashtag-search",
  "displayName": "抖音话题搜索 V2",
  "description": "按关键词搜索抖音话题（挑战/#标签），返回话题浏览量、参与人数、话题描述等。适用于品类话题热度分析、竞品话题监控、内容营销切入点发现。",
  "category": "douyin",
  "version": "1.3.0",
  "endpoint": {
    "method": "POST",
    "url": "https://server.fmode.cn/api/voc-social/douyin/search/fetch_challenge_search_v2",
    "headers": {
      "Authorization": "Bearer ${vocToken}",
      "Content-Type": "application/json",
      "Accept": "application/json"
    }
  },
  "parameters": {
    "type": "object",
    "required": [
      "keyword"
    ],
    "properties": {
      "keyword": {
        "type": "string",
        "description": "搜索关键词，如 '游戏'、'美食'"
      },
      "cursor": {
        "type": "integer",
        "description": "翻页游标，首次请求传 0",
        "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，首次请求传空，翻页时使用上次返回值",
        "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}}"
    }
  },
  "response": {
    "type": "object",
    "description": "话题搜索结果（双层包装：{code, data}，话题在 data.business_data 内）",
    "note": "顶层 {code:200, data:{...}}，data 内 business_data[] 是话题卡片列表，每张卡片的话题数据在 business_data[].data.challenge_info 内。",
    "properties": {
      "code": {
        "type": "integer",
        "description": "HTTP 状态码（200=成功）"
      },
      "data": {
        "type": "object",
        "description": "业务数据包装层",
        "properties": {
          "business_data": {
            "type": "array",
            "description": "话题卡片列表，每项含 type / card_id / data。话题数据在 data.challenge_info 内"
          },
          "extra": {
            "type": "object",
            "description": "翻页及日志信息"
          }
        }
      }
    },
    "keyFields": {
      "data.business_data[].data.challenge_info.cid": "话题 ID",
      "data.business_data[].data.challenge_info.cha_name": "话题名称",
      "data.business_data[].data.challenge_info.desc": "话题描述",
      "data.business_data[].data.challenge_info.user_count": "参与人数",
      "data.business_data[].data.challenge_info.view_count": "浏览量"
    }
  },
  "usageExamples": [
    {
      "name": "品类话题热度排名",
      "input": {
        "keyword": "香薰蜡烛",
        "cursor": 0,
        "sort_type": "1"
      },
      "description": "搜索香薰蜡烛相关话题，按浏览量排名，分析平台热门话题与流量入口"
    },
    {
      "name": "新兴话题发现",
      "input": {
        "keyword": "露营神器",
        "cursor": 0,
        "sort_type": "2",
        "publish_time": "7"
      },
      "description": "搜索最新白应话题，判断新兴趋势方向及内容营销切入机会"
    },
    {
      "name": "竞品品牌话题监控",
      "input": {
        "keyword": "竞品品牌名或标志性话题",
        "cursor": 0,
        "sort_type": "0"
      },
      "description": "搜索竞品相关话题，了解其话题流量规模和平台曝光程度"
    }
  ],
  "workflow": {
    "description": "推荐调用链",
    "steps": [
      "本步: douyin-hashtag-search(keyword) → 获取话题列表 → 得到 cha_name、view_count、user_count",
      "分析: 按 view_count 排序找到最大流量话题，评估内容营销切入横杆价値",
      "下游: 使用 douyin-general-search(话题名) 获取话题下的具体视频内容"
    ]
  },
  "reportMapping": {
    "slides": [
      "社媒聆听(Slide14)"
    ],
    "dataPoints": [
      "品类话题热度排名",
      "话题浏览量与参与人数（规模评估）",
      "新兴趋势话题发现",
      "竞品话题曝光对比"
    ]
  },
  "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"
    }
  }
}