DocsAPI 참조

API 참조

모든 기능을 갖춘 REST API를 사용하여 BeeCastly를 기반으로 구축하세요. 프로그래밍 방식으로 연락처를 관리하고, 메시지를 보내고, 캠페인을 만들고, 웹후크를 구성하세요.

기본 URL

https://beecastly.com/api/v1

Every endpoint that accepts an API key lives under /api/v1. The key identifies your workspace — there is no tenant header to send.

curl "https://beecastly.com/api/v1/contacts?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

Send your API key in the x-api-key header. Create keys under Settings → API Keys and choose their access when you create them:

로그인, 등록, API 키, JWT 토큰

CRUD 작업, 태그, 세그먼트, 사용자 정의 필드

WhatsApp, 이메일, SMS를 보내세요. 대화 가져오기

이벤트 구독, 페이로드, 검증

모든 응답은 같은 형태의 JSON이에요.

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

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

Two limits apply to every API-key request, both set by your plan:

Per key, per minute — the plan's ceiling, or the key's own limit if lower. Over it: 429 with code API_KEY_RATE_LIMITED.
Per workspace, per day — shared by all your keys, resets at 00:00 UTC. Over it: 429 with code API_DAILY_LIMIT and a Retry-After header. Every response carries X-Daily-Limit and X-Daily-Remaining.

Plan	Requests / minute (per key)	Requests / day (workspace)	Webhook endpoints
Free	5	100	2
Starter	20	2,500	10
Growth	100	15,000	30
Pro	300	60,000	100
Agency	1,000	500,000	Unlimited

The BeeCastly Chrome extensions use their own keys and do not count toward the daily allowance.