API für Telefonnummern und Dokumente

Einstellanweisungen / Für Entwickler und Partner (Arbeit mit api) / API für Telefonnummern und Dokumente

Mit Hilfe der API können Sie den Anschluss und die Verwaltung der virtuellen Nummern von der eigenen Oberfläche (Admin Panel) aus realisieren, ohne dass Sie sich in das Zadarma-Konto einloggen müssen.

Alle Funktionen und Methoden der API Zadarma: API Zadarma

In den meisten Ländern ist eine Endbenutzeridentifikation erforderlich, um die Nummer zu aktivieren. Benutzerdokumente werden auch über die API hochgeladen.

API-Funktionen:

  • Auswahl und Aktivierung der virtuellen Nummer
  • Verwalten von bereits verbundenen virtuellen Nummern
  • Arbeit mit Dokumenten für die Rufnummernaktivierung (Informationen zu den Voraussetzungen für die Rufnummernaktivierung, Herunterladen von Dokumenten, Prüfen bereits hochgeladener Dokumente für die Bestellung einer bestimmten Rufnummer)

So bestellen Sie Nummern über API:

  1. Abrufen der aktuellen Länder- und Zielliste für die Rufnummernbestellung, Anzeige für den Benutzer
  2. Abrufen und Anzeigen der Liste der verfügbaren Telefonnummern für die Bestellung
  3. Anlegen einer Gruppe von Dokumenten für den Benutzer (falls nicht vorher angelegt) und Hochladen von Dokumenten (falls erforderlich).
  4. Aktivierung der ausgewählten Nummer für eine Dokumentengruppe.
  5. Richten der Nummer auf SIP-Login oder SIP-URI (set_sip_id)

Aktivierung der neuen Nummer

Methode GET /v1/direct_numbers/countries/ - die Liste der Länder erhalten, in denen die Nummer bestellt werden kann. Wenn die Anfrage ohne Parameter gesendet wird, wird die Antwort in der Sprache Ihres Kontos gesendet. Durch Hinzufügen eines optionalen Parameters language können Sie eine Antwort in einer der Sprachen Ihres persönlichen Kontos erhalten.

Methode GET /v1/direct_numbers/country/ - zum Abrufen einer Liste von Zielen (Städte, Regionen) in einem Land, in dem die Nummer bestellt werden kann. Pflichtparameter: country - iso-Ländercode (ISO 3166-1 alpha-2); Optionale Parameter language und direction_id. Die Antwort liefert eine Reihe von Daten, die die Nummer beschreiben: Land, Stadt, Aktivierungskosten, monatliche Abonnementgebühr, Funktionen, Fähigkeit, SMS zu empfangen, usw.

Liste der verfügbaren Nummern abrufen, Methode GET /v1/direct_numbers/available/<DIRECTION_ID>/ mit den Parametern DIRECTION_ID - Ziel-ID oder ru495; und mask - optionaler Parameter, für die Suche nach passenden Nummern.

Die Nummer kann über die Methode POST /v1/direct_numbers/order/ bestellt werden

Eine bereits aktive Rufnummer kann bei Bedarf mit der Methode POST /v1/direct_numbers/prolong/ für mehrere Monate im Voraus verlängert werden

Pflichtabfrageparameter number und months

Interaktion mit bereits aktiven Telefonnummern

Methode GET /v1/direct_numbers/ (Ohne Parameter) gibt ein Array mit Informationen über bereits verbundene Nummern zurück.

Mit der Methode GET /v1/direct_numbers/number/ können Sie Informationen über eine bestimmte angeschlossene Nummer erhalten, die Anfrage wird mit den Parametern type und number gesendet

Der Status der automatischen Verlängerung (wird die Nummer automatisch für den nächsten Zeitraum verlängert oder wird sie am Ende der Gültigkeitsdauer deaktiviert) kann durch GET /v1/direct_numbers/autoprolongation/ mit den Anfrageparametern type und number ermittelt werden.

Um den Status der automatischen Verlängerung zu ändern, verwenden Sie die Methode PUT /v1/direct_numbers/autoprolongation/ mit den Abfrageparametern type, number und value

Methode PUT /v1/direct_numbers/set_caller_name/ - Zuweisung oder Aktivierung Rufnummernname, Buchstaben und Zahlen, bis zu 30 Zeichen) Textbeschreibung der Rufnummer, wird auch bei eingehendem Anruf im From-Header als CALLERID(name) gesendet Erforderliche Abfrageparameter type, number und caller_name - zum Löschen des Rufnummernnamens muss ein leeres Feld gesendet werden.

Verwenden Sie die Methode PUT /v1/direct_numbers/set_sip_id/ , um Anrufe von der virtuellen Nummer an einen bestimmten SIP-Login oder externen Server per SIP-URI zu leiten oder den Testmodus zu aktivieren. Pflichtabfrageparameter type, number und sip_id - sip-Login oder externe Serveradresse, z. B 1234567890@myserver.com test_mode - Optional, (on|off) - zur Aktivierung des Testmodus.

Arbeit mit Dokumenten

Dokumentgruppe ist die Angabe der Person oder Firma, die die virtuelle Nummer verwenden wird, es kann mehrere Gruppen geben.

Eine neue Dokumentgruppe wird mit der Methode POST /v1/documents/groups/create/ erstellt

Sie können Daten in einer bereits bestehenden Gruppe von Dokumenten mit der Methode PUT /v1/documents/groups/update/<GROUPID>/ aktualisieren.

Das Hochladen einer Dokumentendatei für eine Gruppe von Dokumenten wird durch Methode POST /v1/documents/upload/ durchgeführt.

Mit der Methode GET /v1/documents/groups/list/ können Sie die Liste der Dokumentgruppen abrufen, und mit GET /v1/documents/groups/get/<ID>/ wobei ID die Gruppenkennung und 0 die Hauptdokumentengruppe ist, können Sie Informationen über eine bestimmte Dokumentgruppe erhalten.

Die Methode GET /v1/documents/files liefert eine Liste der zuvor heruntergeladenen Dateien/Dokumente in der Dokumentengruppe. group_id - optionaler Parameter, ID der Dokumentgruppe, (0 oder nicht angegeben - Hauptdokumentengruppe).

Die Überprüfung, ob eine Gruppe von Dokumenten für die Bestellung einer Rufnummer in einer bestimmten Stadt/Zieladresse geeignet ist, erfolgt mit der Methode GET /v1/documents/groups/valid/<ID>/ .