Skip to main content
DocsAPI参考

API参考

使用我们功能齐全的 REST API 在 BeeCastly 之上构建。 以编程方式管理联系人、发送消息、创建营销活动以及配置 Webhooks。

基本网址

https://beecastly.com/api

所有 API 端点都与此基本 URL 相关。 请求必须包含有效的 API 密钥或 JWT 令牌。

快速入门

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

验证

所有请求都需要通过以下方式之一进行身份验证：

  • API 密钥 — 传入 Authorization: Bearer YOUR_API_KEY 标头
  • JWT 令牌 — 从 POST /auth/login 获取

此外，请包含您的租户 ID：x-tenant-id：YOUR_TENANT_ID

查看完整的身份验证指南 →

API端点

验证

登录、注册、API 密钥、JWT 令牌

联系方式

CRUD 操作、标签、段、自定义字段

留言

发送 WhatsApp、电子邮件、短信。 获取对话

活动

创建、安排和跟踪活动

网络钩子

事件订阅、有效负载、验证

机器人

AI 机器人会话、消息和训练数据

响应格式

所有响应都遵循一致的 JSON 格式：

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

速率限制

免费套餐：100 个请求/分钟

专业级：1,000 个请求/分钟

企业：自定义限制

每个响应中都包含速率限制标头：X-RateLimit-Remaining