Allo an alles anschließen

Anrufe, SMS, CRM-Datensätze, Auswertungen, sogar der KI-Rezeptionist. Eine REST-API gibt Ihnen die rohen Bausteine, damit sich das Telefonsystem Ihrem Stack beugt und nicht umgekehrt.

Allo kostenlos testen
Dokumentation lesen
Dokumentation lesen
  • REST und JSON
  • Api-Key-Authentifizierung
  • Signierte Webhooks
  • In jedem Tarif kostenlos
terminal
# Jeder Schlüssel beantwortet das. Fangen Sie hier an.
curl -X GET "https://api.withallo.com/v2/api/me" \
  -H "Authorization: Api-Key YOUR-API-KEY"

# 200 · Ihre Scopes, Ihre Endpunkte, Ihre Ratenbegrenzungen
{
  "scopes": ["CONVERSATIONS_READ", "SMS_SEND", "CRM_WRITE"],
  "rate_limits": { "read_per_second": 20, "write_per_second": 5 }
}
terminal
# Jeder Anruf und jede SMS, in denen es um eine Erstattung ging
curl -X POST "https://api.withallo.com/v2/api/conversations/items/search" \
  -H "Authorization: Api-Key YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": "refund",
    "type": "ALL",
    "sort": "RELEVANCE",
    "size": 25
  }'

# Transkripte, KI-Zusammenfassungen und SMS-Texte, in einem Durchgang durchsucht
terminal
# Eine SMS von einer Ihrer Allo-Nummern senden
curl -X POST "https://api.withallo.com/v1/api/sms" \
  -H "Authorization: Api-Key YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "+13055550180",
    "to": "+13055550142",
    "message": "Your order just shipped"
  }'

# Sie landet im selben Faden wie jeder Anruf mit diesem Kontakt
terminal
# Sagen Sie uns, wohin die Ereignisse gehen sollen, in Echtzeit
curl -X POST "https://api.withallo.com/v2/api/webhooks" \
  -H "Authorization: Api-Key YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/allo/events",
    "topics": ["call.completed", "sms.received", "contact.created"]
  }'

# Signiert, wiederholt und in dem Moment zugestellt, in dem es passiert

Gebaut, damit Ihre erste Anfrage sitzt

Die API ist REST, die Authentifizierung ist ein Header, und die Antworten sind vorhersehbares JSON. Nichts Verschachteltes, nichts zum Auswendiglernen.

  • Ein Header, ein SchlüsselErzeugen Sie einen Schlüssel in den Einstellungen Ihres Arbeitsbereichs und senden Sie ihn als Authorization: Api-Key. Das ist der ganze Handschlag.

  • Berechtigungen mit ScopesEin Schlüssel trägt nur die Scopes, die Sie ihm geben, und GET /v2/api/me antwortet mit den Scopes und den Endpunkten, die er wirklich erreichen kann.

  • Seitenweiser Abruf, der sagt, wann Schluss istpage und size, bis zu 100 pro Anfrage, mit total_count und has_more in jeder seitenweisen Antwort.

  • Ratenbegrenzungen, mit denen sich planen lässt20 Lese- und 5 Schreibvorgänge pro Sekunde und Schlüssel, mit X-RateLimit-Remaining und X-RateLimit-Reset in der Antwort.

Anleitung zur Authentifizierung lesen
Ein Schreibtisch mit Laptop, Notizbuch und einer Tasse Kaffee
terminal
# Zwei Zeilen. Das ist die ganze Einrichtung.
export ALLO_KEY="YOUR-API-KEY"

curl -s \
  "https://api.withallo.com/v2/api/numbers" \
  -H "Authorization: Api-Key $ALLO_KEY"

# 200 · jede Allo-Nummer im Konto

Jede Oberfläche und die Route, die sie öffnet

Vierzehn Ressourcen auf einer Basis-URL. Eine kleine, klare API, ohne wuchernde Altlasten und ohne rätselhafte Abkündigungen.

Unterhaltungen

Der gemeinsame Verlauf aus Anrufen und SMS, mit Stichwortsuche über Transkripte und Nachrichteninhalte.

  • GET/v2/api/conversations
  • POST/v2/api/conversations/items/search
  • POST/v2/api/conversations/items/batch

SMS

SMS und MMS von Ihren Allo-Nummern oder von einer registrierten Sender-ID senden.

  • POST/v1/api/sms

CRM

Personen, Unternehmen und Deals anlegen, lesen, ändern und durchsuchen.

  • /v2/api/crm/people
  • /v2/api/crm/companies
  • /v2/api/crm/deals

Notizen

Interne Teamnotizen an einer Unterhaltung oder einem Personenprofil, mit Erwähnungen.

  • /v2/api/conversations/{contact_number}/notes
  • /v2/api/crm/people/{person_id}/notes

Fäden

Diskussionsfäden des Teams an einem Anruf, einer SMS oder einer Notiz zur Unterhaltung.

  • /v2/api/threads

Webhooks

Ereignisbenachrichtigungen mit HMAC-Signatur und automatischen Wiederholungen.

  • GET/v2/api/webhooks
  • POST/v2/api/webhooks
  • GET/v2/api/webhooks/event_types

Rufnummern

Ihre Allo-Nummern mit ihren Fähigkeiten und Zugriffen, dazu der eingehende Anruf-Flow.

  • GET/v2/api/numbers
  • GET/v2/api/numbers/{number}/call_flow
  • PUT/v2/api/numbers/{number}/call_flow/draft

Nutzer

Die Teamliste mit Rollen und zugewiesenen Nummern, und was Ihr API-Schlüssel darf.

  • GET/v2/api/users
  • GET/v2/api/me

Schlagwörter

Anruf-Schlagwörter anlegen und auflisten, dann an Anrufen und SMS setzen und entfernen.

  • GET/v2/api/tags
  • POST/v2/api/conversations/items/{id}/tags
  • DELETE/v2/api/conversations/items/{id}/tags/{tag}

Zusammenfassungsvorlagen

Die Vorlagen, die bestimmen, wie die KI eine Gesprächszusammenfassung gliedert.

  • GET/v2/api/summary_templates
  • POST/v2/api/summary_templates
  • PUT/v2/api/summary_templates/{id}

Auswertungen

Team-Kennzahlen mit Periodenvergleich und einer Aufschlüsselung pro Nutzer.

  • POST/v2/api/analytics/overview
  • POST/v2/api/analytics/outbound

Wählschlangen

Die Warteschlange des Power Dialers lesen und füllen.

  • GET/v2/api/dialing-queues/current
  • POST/v2/api/dialing-queues/current/numbers
  • GET/v2/api/dialing-queues/sessions/{id}

KI-Rezeptionist

Den Rezeptionisten einrichten: Prompt, Stimme, Wissen und ob er aktiv ist.

  • GET/v2/api/numbers/{number}/agent
  • PATCH/v2/api/numbers/{number}/agent
  • PUT/v2/api/numbers/{number}/agent/prompt

Partner

Allo-Konten als Wiederverkäufer unter eigener Marke anlegen und verwalten.

  • /v2/api/partner/accounts

Jeder Endpunkt, Feld für Feld, in der vollständigen API-Referenz

Ihr Telefonsystem, auf Abruf

Allo führt die Gespräche, die SMS und die KI-Zusammenfassungen. Die API gibt Ihnen die Daten und die Auslöser, damit Sie beides in das einbauen können, womit Ihr Team ohnehin arbeitet.

Jedes Gespräch in Ihr CRM schreiben

Holen Sie Anrufe mit Aufzeichnung, Transkript, KI-Zusammenfassung und Schlagwörtern und legen Sie sie dort ab, wo Ihre Leute wirklich arbeiten, von Salesforce bis zum internen Werkzeug aus dem letzten Quartal.

Personen, Unternehmen und Deals abgleichen

Lesen und schreiben Sie das CRM von beiden Seiten. Eine neue Anfrage in Ihrem Werkzeug landet in Allo, und eine Änderung in Allo kommt per Webhook zurück in Ihre Datenbank.

SMS direkt aus Ihrem Code senden

Terminerinnerungen, Liefermeldungen, Schichtbestätigungen. Ein POST, und sie geht von Ihrer Allo-Nummer raus, dokumentiert im selben Faden wie der Rest der Unterhaltung.

Reagieren, sobald etwas passiert

Webhooks feuern, wenn ein Gespräch endet, eine SMS ankommt oder sich ein Kontakt ändert. Kein Abfragen, kein Cronjob, und die Nutzlast trägt Zusammenfassung und Transkript bereits mit sich.

Über das Team berichten, ohne etwas zu exportieren

Team-Kennzahlen, der Outbound-Funnel und eine Aufschlüsselung pro Nutzer kommen als JSON zurück, damit Ihr eigenes Dashboard die Zahlen zeigt, die Ihre Leute in Allo ohnehin sehen.

Den KI-Rezeptionisten aus Ihren eigenen Werkzeugen einrichten

Lesen und ändern Sie Prompt, Stimme, Öffnungszeiten und Wissen des Rezeptionisten und schalten Sie ihn für eine Nummer ein, ohne dass jemand die Allo App öffnet.

Ereignisse, in dem Moment, in dem sie passieren

Sparen Sie sich das Abfragen. Geben Sie Allo eine URL, wählen Sie Ihre Themen, und die Nutzlast kommt mit KI-Zusammenfassung und Transkript an, in der Sekunde, in der das Gespräch endet oder die SMS ankommt.

  • Elf ThemenAnrufe, SMS, Schlagwörter, Kontakte und Zusammenfassungen, in jeder Kombination abonnierbar.

  • Signierte ZustellungenJede Nutzlast trägt eine HMAC-Signatur, damit Ihr Handler beweisen kann, dass sie von Allo kommt, bevor er handelt.

  • Automatisch wiederholtEine fehlgeschlagene Zustellung wird wiederholt, ein Deploy-Fenster kostet Sie also ein paar Sekunden statt einem Tag voller Ereignisse.

Anleitung zu Webhooks lesen
Themen
  • call.receivedEin eingehender Anruf landet auf einer Ihrer Nummern
  • call.triggeredEin Gespräch beginnt, eingehend oder ausgehend
  • call.answeredJemand nimmt ab, ein Teammitglied oder der KI-Rezeptionist
  • call.completedDas Gespräch endet, Zusammenfassung und Transkript inklusive
  • sms.receivedEine eingehende SMS kommt an
  • sms.sentEine SMS geht raus, von überall in Allo
  • summary.updatedEine KI-Zusammenfassung wird geschrieben oder bearbeitet
  • tag.addedEin Schlagwort wird an einem Anruf oder einer SMS gesetzt
  • tag.removedEin Schlagwort wird entfernt
  • contact.createdEin neuer Kontakt erscheint in Ihrem Arbeitsbereich
  • contact.updatedEin Name, eine Nummer oder ein Unternehmen ändert sich

Fragen, die uns immer wieder erreichen

Der API-Zugang ist in jedem Allo-Tarif enthalten. Es gibt keine Entwicklerstufe und keine Gebühr pro Anfrage. Zusätzlich berechnet werden nur die ausgehenden SMS, die Sie über die API senden, pro Segment wie Ihre übrige SMS-Nutzung.

Ja. HTTP-Verben, JSON-Rümpfe, vorhersehbare Statuscodes und eine Basis-URL unter api.withallo.com. Der größte Teil liegt unter /v2/api; eine SMS zu senden ist weiterhin POST /v1/api/sms.

Über API-Schlüssel. Sie erzeugen einen in den Einstellungen Ihres Arbeitsbereichs und senden ihn im Authorization-Header als Api-Key, nicht als Bearer. Jeder Schlüssel trägt die Scopes, die Sie ihm geben. Ein 403 mit APIKEYINSUFFICIENT_SCOPE heißt also: Der Schlüssel ist gültig, darf das aber nicht. Rufen Sie GET /v2/api/me auf, um genau zu sehen, was Ihrer erreicht.

Ja, über POST /v1/api/sms, von jeder Ihrer Allo-Nummern oder von einer registrierten Sender-ID. Die Nachricht landet im selben Faden wie die Anrufe und SMS davor.

Heute auf elf Themen: call.received, call.triggered, call.answered, call.completed, sms.received, sms.sent, summary.updated, tag.added, tag.removed, contact.created und contact.updated. Abonnieren Sie jede Kombination. Ihr Endpunkt muss HTTPS sein, und jede Zustellung ist signiert und wird wiederholt.

Ja, pro API-Schlüssel: 20 Leseanfragen pro Sekunde und 5 Schreibanfragen pro Sekunde. Jede Antwort trägt X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset, damit Ihr Backoff genau weiß, wann es wieder losgehen kann. Abonnieren Sie Webhooks statt abzufragen, wo immer es geht.

Ja. GET und PATCH /v2/api/numbers/{number}/agent lesen und ändern die gesamte Konfiguration, von der Stimme über die Öffnungszeiten bis zu den Weiterleitungsregeln, ein PUT auf /prompt ersetzt, womit er antwortet, und die Wissens-Endpunkte ergänzen oder entfernen die Websites, die er gelesen hat.

Jeder Endpunkt, jedes Feld und jedes Beispiel liegt unter help.withallo.com/en/v2/api-reference. Den cURL-Befehl können Sie direkt von der Seite kopieren.