wishbest BUSINESSEnglish
API 预览 · 正式发送待开通

让用心的联系,融入日常业务

重要时刻之后,
送出一份专属心意。

成交、项目交付、客户的重要纪念日。把业务系统连接到 Wishbest,通过邮件或短信送出带有企业品牌的祝福。

当前为可测试的 API 预览,线上发送服务尚未开通。正式发送需要配置企业账号和发送渠道;测试密钥只生成预览,不发送消息。

查看接入方式
01 / BRAND

保存企业品牌

保存 Logo、企业名称与落款,调整 Logo 大小,以及左、中、右对齐。

02 / SEND

邮件或短信

邮件内展示贺卡图片和祝福;短信发送文字及在线贺卡链接。

03 / FOLLOW THROUGH

每个事件,一次发送

用固定请求标识防止重复任务,查询排队、测试预览和服务商接收状态。

从一笔房产成交开始。

记录成交 → CRM 调用 Wishbest → 品牌贺卡 → 邮件或短信

成交触发和周年日期由 CRM 或自动化工具管理。当前接口接收已导出的贺卡图片;自动生成图片和现成 CRM 插件尚未包含。

DEVELOPER GUIDE

接入一次,用心送达。

从企业服务端调用,API 密钥不要放入网页或手机 App。可先在本地测试: http://localhost:8787.

1. 提交一张贺卡
POST /v1/deliveries
Authorization: Bearer YOUR_TEST_KEY
Content-Type: application/json
Idempotency-Key: closing-customer-42-email

{
  "channel": "email",
  "to": "client@example.com",
  "recipient_name": "Sarah & James",
  "heading": "A new home. A new chapter.",
  "message": "Thank you for trusting me with your next chapter.",
  "image_url": "https://wishbest.app/assets/app-business-landscape.webp",
  "consent": {
    "confirmed": true,
    "source": "CRM customer preferences",
    "obtained_at": "2026-11-12T10:00:00Z"
  }
}

将示例图片换成已导出、托管在获准 HTTPS 域名上的贺卡。授权信息应对应客户真实的接收偏好。不同事件或渠道使用不同标识,重试沿用原标识。

短信将 channel 改为 sms,to 使用 +14155550123 这样的国际格式号码。短信携带贺卡链接,暂不包含 MMS 图片附件。

2. 保存品牌设置
PUT /v1/brand
Authorization: Bearer YOUR_TEST_KEY
Content-Type: application/json

{
  "name": "Emma Realty",
  "signature": "Warmly, Emma Chen",
  "logo_url": "https://your-approved-asset-host.example/logo.png",
  "logo_width": 120,
  "logo_align": "left"
}

Logo 宽度为 40–220 像素,对齐可选 left、center、right。图片域名需先为企业配置。设置保存在 API 中,尚未与网页或手机编辑器同步。

3. 查询或取消请求
GET /v1/account
GET /v1/deliveries/{id}
DELETE /v1/deliveries/{id}

账号接口显示渠道是否就绪和每日额度。发送开始前可以取消。相同请求标识返回原任务;同一标识提交不同内容会返回 409。

清楚了解每一步。

queued已保存,等待处理。
simulated已生成测试预览,未发送消息。
submitted发送服务商已接收,不代表客户已收到。
failed未被接收,或因配置/接收偏好而停止。
delivery_unknown发送结果不确定,需先核查服务商记录再决定是否重发。

在线贺卡 90 天后过期,持有私密链接的人可以查看。邮件包含退订入口;短信需配置支持 STOP 的发送渠道。当前预览不包含批量营销、计费或最终送达回执。

从下一个值得感谢的时刻开始。

浏览商务贺卡