FÜR ENTWICKLER UND KI
Beginnen Sie mit einer Anfrage.
Eine gemeinsame HTTP-API für reguläre WhatsApp-, Telegram- und MAX-Konten. Die öffentliche Dokumentation beschreibt den API-Vertrag; Ihre Kontenliste ist nur mit Ihrem eigenen Schlüssel zugänglich.
1. Konto und Verbindung erstellen
Registrieren Sie sich per E-Mail, bestätigen Sie die Adresse über die E-Mail und melden Sie sich im Kundenbereich. Wählen Sie einen Messenger und durchlaufen Sie die dafür verfügbare Anmeldung per QR-Code oder Telefonnummer. Für Telegram benötigen Sie eigene application API credentials. Weitere mögliche Anmeldeschritte werden im Kundenbereich angezeigt.
2. API-Schlüssel erstellen
Erstellen Sie unter „Profil → API-Schlüssel“ einen eigenen Schlüssel für Ihr Projekt. Lesezugriff ist standardmäßig erlaubt; zum Senden und für andere Änderungen ist die Berechtigung write erforderlich. Der Schlüsselwert wird nur einmal angezeigt. Speichern Sie ihn in den Secrets des Backends, nicht im Browser, in Git oder in einem KI-Prompt.
3. Verbindungen und vollständigen Katalog abrufen
curl 'https://api-senden.ru/api/v1/integrations/manifest' \
--header 'Authorization: Bearer YOUR_API_KEY'Die Antwort enthält instances, connectedMessengers, commands und permissions. Подключения относятся только к вашему пространству, архивные исключены явно. Для отправки выберите аккаунт со state: connected.
4. Chat auswählen, senden und Ergebnis prüfen
Rufen Sie tatsächliche Chat-IDs ab mit GET /api/v1/instances/{id}/chats. Text und Dateien senden Sie mit POST /api/v1/instances/{id}/messages mit einem stabilen Idempotency-Key. Eine 202-Antwort bedeutet Warteschlange, nicht Zustellung. Status und eingehende Nachrichten erhalten Sie über Verlauf, SSE, Webhooks und Benachrichtigungswarteschlange. Siehe Transportfunktionen unten.
Bei MAX liefert contacts.lookup derzeit eine Benutzer-ID, die nicht automatisch als ID eines privaten Chats gelten darf. Verwenden Sie als Ziel eine ID aus der Chatliste. Senden Sie eine Nachricht nicht mit einem neuen Schlüssel erneut, solange das Ergebnis des ersten Versands unbekannt ist.
Ereignisse und Webhook-Sicherheit
Prüfen Sie bei Webhooks die HMAC-Signatur und verarbeiten Sie Ereignisse idempotent. Der Endpoint muss eine öffentliche HTTPS-Adresse sein; lokale und private Netze werden blockiert. SSE stellt einen Ereignisstrom bereit. Der Empfang einer Benachrichtigung aus der Warteschlange erzeugt einen lease und erfordert write; anschließend erfolgt die Bestätigung per ack. Alle Parameter und Anfrageformate finden Sie in OpenAPI.
Fertige Integrationsmaterialien
Ohne Schlüssel, QR-Codes, Sitzungen oder Benutzerdaten. Beim Start führen die Clients ausschließlich eine discovery-Anfrage aus.
Vollständiger Katalog: 70 HTTP-Befehle
Dies ist der gemeinsame API-Katalog. Die Unterstützung einzelner nativer Befehle und die Notwendigkeit einer aktiven Verbindung werden gesondert angegeben. Der Katalog /methods enthält nur den nativen Teil.
| Methode und Pfad | Zweck | Unterstützung | Berechtigungen |
|---|---|---|---|
GET/api/v1/health | Prozesszustand prüfen | whatsapp, telegram, max | read |
GET/api/v1/status | Verbindungen und Zustände | whatsapp, telegram, max | read |
POST/api/v1/instances | Verbindung erstellen | whatsapp, telegram, max | write |
GET/api/v1/instances | Aktive oder archivierte Verbindungen abrufen | whatsapp, telegram, max | read |
DELETE/api/v1/instances/{id} | Verbindung stoppen und unter Beibehaltung von Verlauf und Sitzung archivieren | whatsapp, telegram, max | write |
PATCH/api/v1/instances/{id} | Verbindung umbenennen | whatsapp, telegram, max | write |
GET/api/v1/instances/{id} | Verbindungszustand | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/restore | Innerhalb der geltenden Limits aus dem Archiv wiederherstellen, ohne automatisch zu verbinden | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/connect | Anmeldung starten | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/auth | Aktuellen Anmeldeschritt fortsetzen | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/stop | Unter Beibehaltung der Sitzung stoppen | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/logout | Abmeldung anfordern | whatsapp, telegram, max | write |
GET/api/v1/instances/{id}/chats | Chats abrufen | whatsapp, telegram, maxVerbindung erforderlich | read |
GET/api/v1/instances/{id}/messages | Gespeicherter Nachrichtenverlauf | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/messages | Text oder Datei in die Warteschlange stellen | whatsapp, telegram, max | writeIdempotency-Key |
POST/api/v1/instances/{id}/messages/from-url | HTTPS-Datei sicher herunterladen und das Dokument in die Warteschlange stellen | whatsapp, telegram, max | writeIdempotency-Key |
GET/api/v1/instances/{id}/settings | Verbindungs- und Ereigniseinstellungen | whatsapp, telegram, max | read |
PUT/api/v1/instances/{id}/settings | Einstellungen ändern | whatsapp, telegram, max | write |
GET/api/v1/instances/{id}/queue | Persistente Nachrichtenwarteschlange | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/queue/clear | Alle Nachrichten im Status queued abbrechen | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/queue/{messageId}/cancel | Eine Nachricht im Status queued abbrechen | whatsapp, telegram, max | write |
POST/api/v1/instances/{id}/queue/{messageId}/retry | Nur einen bestätigten Fehler im Status failed erneut versuchen | whatsapp, telegram, max | write |
GET/api/v1/instances/{id}/notifications/stats | Anzahl ausstehender und verarbeiteter Benachrichtigungen | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/notifications/receive | Benachrichtigung mit lease und Wartezeit empfangen | whatsapp, telegram, max | write |
DELETE/api/v1/instances/{id}/notifications/{receiptId} | Verarbeitung des aktuellen Empfangsbelegs bestätigen | whatsapp, telegram, max | write |
GET/api/v1/instances/{id}/deliveries | Ergebnisse der Webhook-Zustellung | whatsapp, telegram, max | read |
GET/api/v1/instances/{id}/deliveries/stats | Zähler für Webhook-Aufträge | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/deliveries/clear | Ausstehende, erneut versuchte und dead-letter-Webhooks abbrechen | whatsapp, telegram, max | write |
GET/api/v1/instances/{id}/deliveries/{jobId}/attempts | Protokoll der Webhook-Versuche | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/deliveries/{jobId}/retry | Webhook aus dead-letter erneut versuchen | whatsapp, telegram, max | write |
GET/api/v1/events | Ereignisse mit Cursor | whatsapp, telegram, max | read |
GET/api/v1/stream | SSE-Ereignisstrom | whatsapp, telegram, max | read |
POST/api/v1/files | Datei mit bis zu 20 MB hochladen | whatsapp, telegram, max | write |
GET/api/v1/files/{fileId} | Zuvor hochgeladene lokale Datei herunterladen | whatsapp, telegram, max | read |
PUT/api/v1/config | Einstellungen der Anwendung und Netzwerkverbindungen | whatsapp, telegram, max | write |
GET/api/v1/methods | Katalog verfügbarer Operationen | whatsapp, telegram, max | read |
GET/api/v1/integrations/manifest | Verbindungen des aktuellen Arbeitsbereichs, Befehle und fertige Integrationsdateien ohne Schlüssel oder Anmeldedaten | whatsapp, telegram, max | read |
GET/api/v1/integrations/files/{name} | Integrationsvorlage oder vollständiges ZIP-Paket ohne personenbezogene Daten herunterladen | whatsapp, telegram, max | read |
POST/api/v1/instances/{id}/operations/account.settings.get | Profil des verbundenen Kontos | whatsapp, telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/contacts.list | Kontaktliste | whatsapp, telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/contacts.get | Kontaktinformationen | whatsapp, telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/contacts.lookup | Anhand von Telefonnummer oder ID prüfen, ob ein Konto vorhanden ist | whatsapp, telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/contacts.create | Kontakt hinzufügen | telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/contacts.update | Kontakt bearbeiten | telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/contacts.delete | Kontakt löschen | telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/profile.avatar.get | Profilbild abrufen | whatsappVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/messages.history | Verlauf aus dem Messenger laden | telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/messages.get | Nachricht aus dem Messenger abrufen | telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/messages.read | Nachrichten als gelesen markieren | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.delete | Nachricht löschen | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.edit | Nachrichtentext bearbeiten | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.forward | Ausgewählte Nachrichten weiterleiten | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.react | Reaktion auf eine Nachricht ändern | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.contact | Kontaktkarte senden | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.location | Standort senden | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/messages.poll | Umfrage senden | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/chats.typing | Tippanzeige anzeigen | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/chats.archive | Chat archivieren | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/chats.unarchive | Chat aus dem Archiv holen | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/chats.expiration | Selbstlöschende Nachrichten einstellen | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/chats.reactions | Verfügbare Reaktionen abrufen | telegramVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/groups.get | Gruppeninformationen | whatsapp, telegram, maxVerbindung erforderlich | read |
POST/api/v1/instances/{id}/operations/groups.create | Gruppe erstellen | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.rename | Gruppe umbenennen | whatsapp, telegramVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.members.add | Mitglied hinzufügen | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.members.remove | Mitglied entfernen | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.admins.add | Gruppenadministrator ernennen | whatsappVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.admins.remove | Gruppenadministrator absetzen | whatsappVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.leave | Gruppe verlassen | whatsapp, telegram, maxVerbindung erforderlich | writeIdempotency-Key |
POST/api/v1/instances/{id}/operations/groups.settings | Eine Gruppenberechtigung ändern | whatsappVerbindung erforderlich | writeIdempotency-Key |
VON DER IDEE ZUR INTEGRATION
Verbinden Sie Ihr erstes Konto
Erstellen Sie ein Konto, bestätigen Sie Ihre E-Mail-Adresse und beginnen Sie mit dem Abrufen der Verbindungsliste.