Mit API, Playground und Webhooks beginnen
API-Schlüssel finden, eine sichere erste Anfrage stellen und Ereignisbenachrichtigungen ohne Offenlegung von Zugangsdaten einrichten.
Die aktuelle API-Referenz verwenden
Öffnen Sie angemeldet die API-Dokumentation. Sie enthält unterstützte Endpunkte, Pflichtfelder und Beispiele. Entnehmen Sie ihr die konkreten Anfragedetails; diese Anleitung erklärt den Ablauf, statt die Endpunktspezifikation zu wiederholen.
Schlüssel vorbereiten
Folgen Sie der Identitätsprüfung, um Ihren Schlüssel anzuzeigen oder zu kopieren. Danach erlaubt die Dokumentation fünf Minuten lang die Schlüsselanzeige und Playground-Nutzung. Zum Erzeugen oder Erneuern eines Schlüssels ist eine neue Prüfung nötig. Behandeln Sie den Schlüssel wie ein Passwort: Speichern Sie ihn auf Ihrem Anwendungsserver, nicht in öffentlichen Repositorys, Browsercode oder Screenshots.
Eine sichere erste Anfrage stellen
- Öffnen Sie den Playground und wählen Sie eine passende Nur-Lese-Vorlage, etwa zum Auflisten Ihrer SIP-Identitäten.
- Prüfen Sie Methode, Pfad und Parameter. Verwenden Sie Kennungen aus Ihrem eigenen Konto statt Beispielwerten.
- Wählen Sie Run request und prüfen Sie sowohl den HTTP-Status als auch den Antwortinhalt.
- Übernehmen Sie das dokumentierte Anfragebeispiel in Ihre Anwendung und speichern Sie Zugangsdaten sicher.
Der Playground verwendet Ihr Konto. Nachrichten, Anrufe oder Dienstbestellungen können echte Aktionen auslösen und Kosten verursachen. Er ist keine kostenlose Sandbox.
Webhook-Benachrichtigungen hinzufügen
Fügen Sie unter den Kontointegrationen einen HTTPS-Endpunkt hinzu und wählen Sie die gewünschten Ereignisse. Das Webhook-Signaturgeheimnis ist nicht Ihr API-Schlüssel. Prüfen Sie Signaturen, verarbeiten Sie jedes Ereignis nur einmal und bestätigen Sie den Empfang zügig. Nutzen Sie bei Problemen die Zustellprotokolle. Lesen Sie vor der Wiederholung kostenpflichtiger Vorgänge die API-Hinweise zu Wiederholungen und doppelten Anfragen; ein Timeout allein beweist kein Scheitern.
Weitere Anleitungen
Die passende Dienstreferenz wählen
Die Referenz unterscheidet Lookup, Pricing, SIP, SMS, Contacts, Speech API, Phone Numbers, Voice API sowie Calls & recordings. Genaue Voraussetzungen, Anfragefelder und Kosten stehen beim jeweiligen Endpunkt. Für Browsertelefonie gibt es eine eigene Webphone-SDK-Anleitung; sie ist nicht mit serverseitiger Voice-API-Anrufsteuerung gleichzusetzen.
Die Berechtigung eines Agenten zum Lesen der Dokumentation erlaubt keinen Zugriff auf den API-Schlüssel des Kontoinhabers oder schlüsselbasierte Playground-Ausführung. Bitten Sie den Kontoinhaber, Integrationszugangsdaten zu verwalten, statt seine Anmeldung zu teilen.
Zurückgegebene Referenzen und Seitennavigation nutzen
Behandeln Sie öffentliche Anrufreferenzen als unveränderliche Werte: Kopieren Sie die vollständige CALL-Referenz aus Ihrer Antwort, statt sie selbst aufzubauen oder interne Telefoniekennungen zu verwenden. Historische und aktive Anrufe stehen in getrennten Listen. Steueraktionen setzen außerdem einen unterstützten Anrufzustand voraus; ein Verlaufseintrag ist nicht automatisch steuerbar.
Folgen Sie im Anrufverlauf pagination.next_cursor, solange pagination.has_more wahr ist. Behalten Sie days, limit und SIP-Identitätsfilter unverändert bei. Entschlüsseln oder verändern Sie den Cursor nicht. Beginnen Sie bei Ablauf eine neue Abfrage und gleichen Sie anhand der öffentlichen Anrufreferenz ab. Ein als UTC dokumentierter API-Zeitstempel muss für Ihre Anzeige bewusst umgerechnet werden; er entspricht nicht automatisch der lokalen Browserzeit.
Fehler ohne doppelte kostenpflichtige Aktionen behandeln
Lesen Sie HTTP-Status und strukturierten Fehler gemeinsam. Beheben Sie Validierungs- oder Berechtigungsfehler vor dem Wiederholen. Beachten Sie bei Ratenlimits die dokumentierte Wartezeit. Prüfen Sie bei Timeout oder vorübergehendem Fehler eines kostenpflichtigen Vorgangs dessen Status und die Regeln des Endpunkts für doppelte Anfragen, bevor Sie erneut senden. Geänderte Anfragekennungen können eine Wiederholung zu einem neuen Vorgang machen. Bewahren Sie öffentliche Anfragekennung/Referenz, Zeitpunkt und bereinigte Fehlermeldung für den Support auf, niemals den API-Schlüssel.