Tham khảo API
Xây dựng dựa trên BeeCastly với API REST đầy đủ tính năng của chúng tôi. Quản lý danh bạ, gửi tin nhắn, tạo chiến dịch và định cấu hình webhook theo chương trình.
URL cơ sở
https://beecastly.com/apiTất cả các điểm cuối API đều liên quan đến URL cơ sở này. Yêu cầu phải bao gồm khóa API hợp lệ hoặc mã thông báo JWT.
Bắt đầu nhanh
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"
Xác thực
Tất cả các yêu cầu đều yêu cầu xác thực thông qua một trong:
- Khóa API - Chuyển tiêu đề Ủy quyền: Bearer YOUR_API_KEY
- Mã thông báo JWT - Lấy từ POST /auth/login
Ngoài ra, hãy bao gồm ID đối tượng thuê của bạn: x-tenant-id: YOUR_TENANT_ID
Điểm cuối API
Xác thực
Đăng nhập, đăng ký, khóa API, mã thông báo JWT
Danh bạ
Hoạt động CRUD, thẻ, phân đoạn, trường tùy chỉnh
Tin nhắn
Gửi WhatsApp, Email, SMS. Tìm nạp cuộc hội thoại
Chiến dịch
Tạo, lên lịch và theo dõi các chiến dịch
Webhook
Đăng ký sự kiện, tải trọng, xác minh
Bot
Phiên bot AI, tin nhắn và dữ liệu đào tạo
Định dạng phản hồi
Tất cả các phản hồi đều tuân theo định dạng JSON nhất quán:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Giới hạn tỷ lệ
Bậc miễn phí: 100 yêu cầu/phút
Cấp chuyên nghiệp: 1.000 yêu cầu/phút
Doanh nghiệp: Giới hạn tùy chỉnh
Tiêu đề giới hạn tỷ lệ được bao gồm trong mọi phản hồi: X-RateLimit-Remaining