浏览文档目录

API

联享券

附属联享券能力:关联开放应用后,以机器人身份在会话中发券。

鉴权: Authorization: Bearer sbot_…

POST/api/v1/bots/vouchers/issue
Bot Token

issue发放联享券

附属能力:把关联开放应用的已发布联享券发送到机器人可访问的私聊。

  • 请求头:Authorization: Bearer sbot_...、唯一 Idempotency-Key;需要 vouchers:issue
  • 必填:template_id、external_issue_id、chat_id;可选 notify_user
  • 同一 Bot 的外部发放编号或幂等键重试返回同一发放结果
POST/api/v1/bots/vouchers/verify
Bot Token

verify验证联享券

在当前 Bot 范围内验证二维码 token 或六位券码。

  • 需要 vouchers:verify;body:credential: { type: "qr_token" | "redeem_code", value }
  • 券码输入忽略大小写、空格和连字符;不返回用户隐私信息
POST/api/v1/bots/vouchers/redeem
Bot Token

redeem核销联享券

使用条件更新完成单步原子核销,防止同一张券被重复使用。

  • 请求头必须含唯一 Idempotency-Key;需要 vouchers:redeem
  • 必填:credential、external_order_id;可选 store_id、operator_id、occurred_at
  • 同一幂等键重试返回原核销结果;同键不同请求返回 409