api-config.json 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. {
  2. "name": "douyin-user-search",
  3. "displayName": "抖音用户搜索 V2",
  4. "description": "按关键词搜索抖音达人/用户,返回匹配的账号列表及基础数据。适用于红人库建设、品类达人批量筛选、竞品代言人定位。",
  5. "category": "douyin",
  6. "version": "1.3.0",
  7. "endpoint": {
  8. "method": "POST",
  9. "url": "https://server.fmode.cn/api/voc-social/douyin/search/fetch_user_search_v2",
  10. "headers": {
  11. "Authorization": "Bearer ${vocToken}",
  12. "Content-Type": "application/json",
  13. "Accept": "application/json"
  14. }
  15. },
  16. "parameters": {
  17. "type": "object",
  18. "required": [
  19. "keyword"
  20. ],
  21. "properties": {
  22. "keyword": {
  23. "type": "string",
  24. "description": "搜索关键词,如 '人工智能'、'美妆'"
  25. },
  26. "cursor": {
  27. "type": "integer",
  28. "description": "翻页游标,首次请求传 0",
  29. "default": 0
  30. }
  31. }
  32. },
  33. "requestTransform": {
  34. "body": {
  35. "keyword": "{{keyword}}",
  36. "cursor": "{{cursor}}"
  37. }
  38. },
  39. "response": {
  40. "type": "object",
  41. "description": "用户搜索结果(双层包装:{code, data},用户列表可能在 data.data[].user_list 内)",
  42. "note": "顶层 {code:200, data:{code, data, extra, message}}。实测 V2 可能返回 data.data[0].user_list[],每项使用 user_id 作为后续 sec_user_id。",
  43. "properties": {
  44. "code": {
  45. "type": "integer",
  46. "description": "HTTP 状态码(200=成功)"
  47. },
  48. "data": {
  49. "type": "object",
  50. "description": "业务数据包装层",
  51. "properties": {
  52. "code": {
  53. "type": "integer",
  54. "description": "业务状态码"
  55. },
  56. "data": {
  57. "type": "array",
  58. "description": "用户列表包装。常见结构为 data[0].user_list[],每项含 user_id、nick_name、fans_cnt、like_cnt、publish_cnt 等"
  59. },
  60. "extra": {
  61. "type": "object",
  62. "description": "翻页及日志信息"
  63. },
  64. "message": {
  65. "type": "string",
  66. "description": "业务消息"
  67. }
  68. }
  69. }
  70. },
  71. "keyFields": {
  72. "data.data[].user_list[].user_id": "实测可作为 sec_user_id,传入 douyin-user-profile / douyin-user-posts",
  73. "data.data[].user_list[].nick_name": "用户昵称",
  74. "data.data[].user_list[].fans_cnt": "粉丝数",
  75. "data.data[].user_list[].publish_cnt": "作品数",
  76. "data.data[].user_info.uid": "旧结构用户 ID",
  77. "data.data[].user_info.nickname": "旧结构用户昵称",
  78. "data.data[].user_info.sec_uid": "旧结构可传入 douyin-user-profile 获取详情",
  79. "data.data[].user_info.unique_id": "用户抵音号",
  80. "data.data[].user_info.follower_count": "粉丝数",
  81. "data.data[].user_info.signature": "个人简介"
  82. }
  83. },
  84. "usageExamples": [
  85. {
  86. "name": "品类达人批量筛选",
  87. "input": {
  88. "keyword": "香薰蜡烛达人",
  89. "cursor": 0
  90. },
  91. "description": "搜索香薰蜡烛品类达人,得到候选名单后用 douyin-user-profile 获取粉丝数评估化"
  92. },
  93. {
  94. "name": "竞品品牌账号搜索",
  95. "input": {
  96. "keyword": "竞品品牌名+官方旗舰店",
  97. "cursor": 0
  98. },
  99. "description": "搜索竞品品牌在抖音的官方账号,用于监控其运营动态"
  100. }
  101. ],
  102. "workflow": {
  103. "description": "推荐调用链",
  104. "steps": [
  105. "本步: douyin-user-search(keyword) → 搜索达人/品牌 → 得到 user_id/nick_name/fans_cnt 或旧结构 sec_uid",
  106. "下游: douyin-user-profile(sec_user_id) → 获取账号完整数据和统计",
  107. "筛选: 按 follower_count 筛选符合粉丝规模要求的达人"
  108. ]
  109. },
  110. "reportMapping": {
  111. "slides": [
  112. "社媒聆听(Slide14)"
  113. ],
  114. "dataPoints": [
  115. "品类达人候选列表",
  116. "粉丝规模分布(头部/腰部/尾部达人)",
  117. "竞品代言人定位"
  118. ]
  119. },
  120. "timeout": 60000,
  121. "retry": {
  122. "maxAttempts": 3,
  123. "delay": 1500,
  124. "backoffMultiplier": 2
  125. },
  126. "tokenConfig": {
  127. "type": "bearer",
  128. "configFile": "~/.openclaw/voc-credentials.json",
  129. "tokenField": "vocToken",
  130. "resolutionOrder": [
  131. "configFile"
  132. ],
  133. "apigId": "Vo3ROWEvDy",
  134. "paymentUrlResolution": {
  135. "description": "动态构建充值URL:在已存在 session token 时查出用户 objectId,拼接到专属充值页面",
  136. "steps": [
  137. "1. 从 voc-credentials.json 获取当前 session token",
  138. "2. 调用 GET https://server.fmode.cn/parse/users/me (Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token})获取用户 objectId",
  139. "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  140. "4. 将该URL展示给用户,引导扫码支付"
  141. ],
  142. "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
  143. "userResolveHeaders": {
  144. "X-Parse-Application-Id": "ncloudmaster",
  145. "X-Parse-Session-Token": "{vocToken}"
  146. },
  147. "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
  148. "paymentParams": {
  149. "user": "{resolvedUserId}",
  150. "apigid": "Vo3ROWEvDy",
  151. "fun_id": "HOkkX72PMF"
  152. },
  153. "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
  154. },
  155. "onMissing": {
  156. "action": "showPaymentQR",
  157. "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  158. "title": "扫码开通 VOC-AI 数据服务",
  159. "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值;当用户提供 session token 后,请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段,再重试当前 Skill。",
  160. "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
  161. "tokenSetupInstructions": "当用户完成登录和充值后,如果用户把 session token 发给你,请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json,然后重试当前 Skill。"
  162. },
  163. "onBalanceInsufficient": {
  164. "action": "resolveUserThenShowPayment",
  165. "title": "VOC-AI Token 余额不足,请扫码充值",
  166. "message": "当前 Token 余额不足,我将为你生成专属充值链接,扫码支付后即可继续使用。"
  167. }
  168. },
  169. "errorHandling": {
  170. "balanceInsufficient": {
  171. "conditions": [
  172. {
  173. "responseField": "code",
  174. "operator": "in",
  175. "value": [
  176. -2,
  177. -3,
  178. -10,
  179. 402,
  180. 429
  181. ]
  182. },
  183. {
  184. "responseField": "msg",
  185. "operator": "contains",
  186. "value": [
  187. "余额不足",
  188. "insufficient",
  189. "balance",
  190. "quota",
  191. "没有开通",
  192. "权限或余额"
  193. ]
  194. },
  195. {
  196. "responseField": "mess",
  197. "operator": "contains",
  198. "value": [
  199. "余额不足",
  200. "insufficient",
  201. "balance",
  202. "quota",
  203. "没有开通",
  204. "权限或余额"
  205. ]
  206. },
  207. {
  208. "responseField": "message",
  209. "operator": "contains",
  210. "value": [
  211. "余额不足",
  212. "insufficient",
  213. "balance",
  214. "没有开通",
  215. "权限或余额"
  216. ]
  217. }
  218. ],
  219. "matchMode": "any",
  220. "trigger": "tokenConfig.onBalanceInsufficient"
  221. },
  222. "unauthorized": {
  223. "conditions": [
  224. {
  225. "responseField": "code",
  226. "operator": "in",
  227. "value": [
  228. 401,
  229. 403
  230. ]
  231. },
  232. {
  233. "responseField": "msg",
  234. "operator": "contains",
  235. "value": [
  236. "unauthorized",
  237. "token",
  238. "invalid",
  239. "auth"
  240. ]
  241. }
  242. ],
  243. "matchMode": "any",
  244. "trigger": "tokenConfig.onMissing"
  245. }
  246. }
  247. }