Docsएपीआई संदर्भ

एपीआई संदर्भ

हमारे पूर्ण विशेषताओं वाले REST API के साथ BeeCastly के शीर्ष पर निर्माण करें। संपर्क प्रबंधित करें, संदेश भेजें, अभियान बनाएं और वेबहुक को प्रोग्रामेटिक रूप से कॉन्फ़िगर करें।

आधार यूआरएल

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:

Read only — GET requests.
Read & write — also POST: send messages, create contacts.

पूर्ण प्रमाणीकरण मार्गदर्शिका देखें →

एपीआई समापन बिंदु

प्रमाणीकरण

लॉगिन, रजिस्टर, एपीआई कुंजी, जेडब्ल्यूटी टोकन

संपर्क

सीआरयूडी संचालन, टैग, खंड, कस्टम फ़ील्ड

संदेशों

व्हाट्सएप, ईमेल, एसएमएस भेजें। वार्तालाप प्राप्त करें

वेबहुक

इवेंट सदस्यता, पेलोड, सत्यापन

प्रतिक्रिया प्रारूप

हर जवाब एक ही आकार का 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.