api-config.json 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  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 内)",
  42. "note": "顶层 {code:200, data:{code, data, extra, message}}。data.data 是用户列表数据,结构取决于 V2 接口返回。",
  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": "用户列表,每项含 user_info 对象(uid, nickname, unique_id, sec_uid, follower_count, signature 等)"
  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_info.uid": "用户 ID",
  73. "data.data[].user_info.nickname": "用户昵称",
  74. "data.data[].user_info.sec_uid": "可传入 douyin-user-profile 获取详情",
  75. "data.data[].user_info.unique_id": "用户抵音号",
  76. "data.data[].user_info.follower_count": "粉丝数",
  77. "data.data[].user_info.signature": "个人简介"
  78. }
  79. },
  80. "usageExamples": [
  81. {
  82. "name": "品类达人批量筛选",
  83. "input": {
  84. "keyword": "香薰蜡烛达人",
  85. "cursor": 0
  86. },
  87. "description": "搜索香薰蜡烛品类达人,得到候选名单后用 douyin-user-profile 获取粉丝数评估化"
  88. },
  89. {
  90. "name": "竞品品牌账号搜索",
  91. "input": {
  92. "keyword": "竞品品牌名+官方旗舰店",
  93. "cursor": 0
  94. },
  95. "description": "搜索竞品品牌在抖音的官方账号,用于监控其运营动态"
  96. }
  97. ],
  98. "workflow": {
  99. "description": "推荐调用链",
  100. "steps": [
  101. "本步: douyin-user-search(keyword) → 搜索达人/品牌 → 得到 uid、nickname、sec_uid、follower_count",
  102. "下游: douyin-user-profile(sec_user_id) → 获取账号完整数据和统计",
  103. "筛选: 按 follower_count 筛选符合粉丝规模要求的达人"
  104. ]
  105. },
  106. "reportMapping": {
  107. "slides": [
  108. "社媒聆听(Slide14)"
  109. ],
  110. "dataPoints": [
  111. "品类达人候选列表",
  112. "粉丝规模分布(头部/腰部/尾部达人)",
  113. "竞品代言人定位"
  114. ]
  115. },
  116. "timeout": 60000,
  117. "retry": {
  118. "maxAttempts": 3,
  119. "delay": 1500,
  120. "backoffMultiplier": 2
  121. },
  122. "tokenConfig": {
  123. "type": "bearer",
  124. "configFile": "~/.openclaw/voc-credentials.json",
  125. "tokenField": "vocToken",
  126. "resolutionOrder": [
  127. "configFile"
  128. ],
  129. "apigId": "Vo3ROWEvDy",
  130. "paymentUrlResolution": {
  131. "description": "动态构建充值URL:在已存在 session token 时查出用户 objectId,拼接到专属充值页面",
  132. "steps": [
  133. "1. 从 voc-credentials.json 获取当前 session token",
  134. "2. 调用 GET https://server.fmode.cn/parse/users/me (Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token})获取用户 objectId",
  135. "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  136. "4. 将该URL展示给用户,引导扫码支付"
  137. ],
  138. "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
  139. "userResolveHeaders": {
  140. "X-Parse-Application-Id": "ncloudmaster",
  141. "X-Parse-Session-Token": "{vocToken}"
  142. },
  143. "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
  144. "paymentParams": {
  145. "user": "{resolvedUserId}",
  146. "apigid": "Vo3ROWEvDy",
  147. "fun_id": "HOkkX72PMF"
  148. },
  149. "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
  150. },
  151. "onMissing": {
  152. "action": "showPaymentQR",
  153. "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  154. "title": "扫码开通 VOC-AI 数据服务",
  155. "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值;当用户提供 session token 后,请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段,再重试当前 Skill。",
  156. "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
  157. "tokenSetupInstructions": "当用户完成登录和充值后,如果用户把 session token 发给你,请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json,然后重试当前 Skill。"
  158. },
  159. "onBalanceInsufficient": {
  160. "action": "resolveUserThenShowPayment",
  161. "title": "VOC-AI Token 余额不足,请扫码充值",
  162. "message": "当前 Token 余额不足,我将为你生成专属充值链接,扫码支付后即可继续使用。"
  163. }
  164. },
  165. "errorHandling": {
  166. "balanceInsufficient": {
  167. "conditions": [
  168. {
  169. "responseField": "code",
  170. "operator": "in",
  171. "value": [
  172. -2,
  173. -3,
  174. -10,
  175. 402,
  176. 429
  177. ]
  178. },
  179. {
  180. "responseField": "msg",
  181. "operator": "contains",
  182. "value": [
  183. "余额不足",
  184. "insufficient",
  185. "balance",
  186. "quota",
  187. "没有开通",
  188. "权限或余额"
  189. ]
  190. },
  191. {
  192. "responseField": "mess",
  193. "operator": "contains",
  194. "value": [
  195. "余额不足",
  196. "insufficient",
  197. "balance",
  198. "quota",
  199. "没有开通",
  200. "权限或余额"
  201. ]
  202. },
  203. {
  204. "responseField": "message",
  205. "operator": "contains",
  206. "value": [
  207. "余额不足",
  208. "insufficient",
  209. "balance",
  210. "没有开通",
  211. "权限或余额"
  212. ]
  213. }
  214. ],
  215. "matchMode": "any",
  216. "trigger": "tokenConfig.onBalanceInsufficient"
  217. },
  218. "unauthorized": {
  219. "conditions": [
  220. {
  221. "responseField": "code",
  222. "operator": "in",
  223. "value": [
  224. 401,
  225. 403
  226. ]
  227. },
  228. {
  229. "responseField": "msg",
  230. "operator": "contains",
  231. "value": [
  232. "unauthorized",
  233. "token",
  234. "invalid",
  235. "auth"
  236. ]
  237. }
  238. ],
  239. "matchMode": "any",
  240. "trigger": "tokenConfig.onMissing"
  241. }
  242. }
  243. }