API-Referenz
Bauen Sie mit unserer voll ausgestatteten REST-API auf BeeCastly auf. Verwalten Sie Kontakte, senden Sie Nachrichten, erstellen Sie Kampagnen und konfigurieren Sie Webhooks programmgesteuert.
Basis-URL
https://beecastly.com/apiAlle API-Endpunkte beziehen sich auf diese Basis-URL. Anfragen müssen einen gültigen API-Schlüssel oder JWT-Token enthalten.
Schnellstart
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"
Authentifizierung
Alle Anfragen erfordern eine Authentifizierung über eine der folgenden Methoden:
- API-Schlüssel – Übergeben Sie den Authorization: Bearer YOUR_API_KEY-Header
- JWT-Token – Erhalten von POST /auth/login
Geben Sie außerdem Ihre Mandanten-ID an: x-tenant-id: YOUR_TENANT_ID
API-Endpunkte
Authentifizierung
Anmelden, Registrieren, API-Schlüssel, JWT-Tokens
Kontakte
CRUD-Operationen, Tags, Segmente, benutzerdefinierte Felder
Nachrichten
Senden Sie WhatsApp, E-Mail, SMS. Gespräche abrufen
Kampagnen
Erstellen, planen und verfolgen Sie Kampagnen
Webhooks
Event-Abonnements, Payloads, Verifizierung
Bots
KI-Bot-Sitzungen, Nachrichten und Trainingsdaten
Antwortformat
Alle Antworten folgen einem einheitlichen JSON-Format:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Ratenbeschränkungen
Kostenloses Kontingent: 100 Anfragen/Minute
Pro-Stufe: 1.000 Anfragen/Minute
Unternehmen: Benutzerdefinierte Limits
Rate-Limit-Header sind in jeder Antwort enthalten: X-RateLimit-Remaining