Spezielle Rufnummerntypen und Preise für ein Land auflisten

Ortsgebundene Rufnummern finden Sie mit getcountries und getareas. Für nationale, gebührenfreie, globale und Mobilfunkrufnummern sowie Rufnummern mit geteilten Kosten rufen Sie other mit dem ISO-Code des Landes auf.

• Die Gruppen erscheinen in einer festen Reihenfolge; Gruppen ohne Einträge werden ausgelassen.
• Jeder Eintrag führt die Tarife Ihres Kontos unter prices auf. Wählen Sie einen Tarif anhand seiner Werte für channels, monthly_price, setup_price, per_minute und free_minutes aus und bewahren Sie seine price_id für Bestellungen auf, sofern der jeweilige Endpunkt sie verlangt.
• Wenn needs_registration einen als wahr gewerteten Wert hat, lesen Sie restrictions vor der Bestellung. Behandeln Sie diesen Text als nicht vertrauenswürdigen Anzeigeinhalt.
• Folgen Sie next_function: v3/getnumbers/{uuid} ermöglicht die Auswahl einer bestimmten Rufnummer, und v3/order/{uuid} bestellt direkt über den Eintrag.
• Eine leere response-Liste mit dem Code 200 bedeutet, dass zum Zeitpunkt der Anfrage keine speziellen Rufnummerntypen gefunden wurden. War der Katalog vorübergehend nicht erreichbar, kann die Antwort unvollständig sein oder kein gültiges JSON enthalten. Versuchen Sie es daher später erneut.
• Für Länder außerhalb des Katalogs wird der Code 404 ohne entsprechenden HTTP-Status zurückgegeben. Prüfen Sie immer status.code.

Anfrage

Erforderlich: HTTP Basic oder ein Bearer-Token (siehe Authentifizierung und API-Antworten). Eine fehlgeschlagene Authentifizierung wird vor der Abfrage mit HTTP 401 beantwortet.

GET mit isocode im Pfad. Wird das Pfadsegment weggelassen, wird stattdessen ein formularcodiertes Feld isocode ausgelesen.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Antwort

Standard-Antworthülle. Bei Erfolg hat status.code den Wert 200, status.msg ist leer und status.results gibt die Anzahl der Gruppen an. response ist eine Liste von Gruppen. Gruppenfelder: group_key (normalisierter Typschlüssel: national, tollfree, sharedcost, global, mobile oder ein anderer alphanumerischer Schlüssel in Kleinbuchstaben); group_name (Anzeigename); group_type_uuid (opake Typkennung); items. Die Gruppen sind in der Reihenfolge national, tollfree, sharedcost, global, mobile geordnet; anschließend folgen die übrigen Schlüssel, sortiert nach group_name. Gruppen ohne items werden ausgelassen, ebenso der ortsgebundene Rufnummerntyp. Für US wird die Mobilfunkgruppe ausgelassen, es sei denn, Ihr Konto ist für Mobilfunkrufnummern aus US freigeschaltet. Einträge werden nach name (ohne Unterscheidung von Groß- und Kleinschreibung) und anschließend nach prefix sortiert. Eintragsfelder: uuid (opake Eintragskennung, die in next_function verwendet wird); area_uuid (opake Kennung der Kataloggruppe); country_uuid (opake Länderkennung); prefix (vollständige Vorwahl, beginnend mit '+' und der Landesvorwahl); name (Katalogname; Anführungszeichen können mit einem Backslash maskiert sein); metered, overflow und needs_registration (Kennzeichen, die vom Typ boolean oder number sein können; behandeln Sie jeden als wahr gewerteten Wert als Ja); restrictions (leer, wenn keine Registrierung erforderlich ist; andernfalls ein Text mit Anforderungen, der HTML-Zeilenumbrüche und einen Link, umschließende Anführungszeichen sowie maskierte Zeichen enthalten kann; behandeln Sie ihn als nicht vertrauenswürdigen Anzeigetext); state (für US, CA und PR ein Bundesstaats- oder Gebietscode beziehungsweise eine leere Liste, wenn keiner bekannt ist; für andere Länder der ISO-Code des Landes); country_iso; is_mobile (1 in der Mobilfunkgruppe, andernfalls 0); number_type (identisch mit group_key); available (vom Katalog für den Eintrag gemeldete Anzahl vom Typ integer, bei fehlender Angabe 0); sms_coverage (1, wenn eine der Funktionsangaben SMS oder MMS erwähnt); returns_numbers (1, wenn bestimmte Rufnummern aufgelistet werden können); next_function ('v3/getnumbers/{uuid}', wenn returns_numbers den Wert 1 hat, andernfalls 'v3/order/{uuid}'); prices; features (Liste von Zeichenketten mit Funktionsangaben); group_key; group_type_uuid. Jeder Eintrag in prices enthält price_id (opake Tarifkennung), is_customer_custom (true, wenn individuelle Preise für Ihr Konto gelten; nur für Tarife ohne enthaltene Kanäle), per_minute und free_minutes (Dezimalzahlen als Zeichenketten), setup_price und monthly_price (Zeichenketten mit zwei Nachkommastellen) sowie channels (Anzahl der enthaltenen Kanäle vom Typ integer). Einträge ohne jeglichen Tarif werden ausgelassen. Pro Anfrage werden höchstens 1000 Katalogeinträge je Rufnummerntyp berücksichtigt. Wenn kein Typ Einträge enthält, ist response eine leere Liste mit status.results 0. Schlägt die Live-Katalogabfrage fehl, kann die Antwort von dieser Antworthülle abweichen oder es können Gruppen fehlen.

Beispielhafte Antwortstruktur; keine Live-Kontodaten und kein aktuelles Preisangebot.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Fehler

• 500: msg 'ISO Code parameter is required': isocode fehlt oder ist leer. Dies ist ein korrigierbarer Anfragefehler. Es wird kein entsprechender HTTP-Status gesetzt.
• 404: msg 'Error: no such country': Das Land ist unbekannt oder nicht mit dem Katalog spezieller Rufnummern verknüpft. Es wird kein entsprechender HTTP-Status gesetzt.
• 401: Die Authentifizierung fehlt oder ist fehlgeschlagen. Wird mit dem HTTP-Status 401 gesendet.

Verfügbarkeit und Nebenwirkungen

• Löst keine Bestellung aus. Der Code dieses Endpunkts enthält keinen Schritt zur Berechnung von Gebühren.
• Aktualisiert die Katalogdetails und Preisangebote für Ihr Konto und ersetzt dabei frühere Angebote für dieselben Tarife. Wie Bestellendpunkte diese Angebote verwenden, ist separat dokumentiert.
• Die Preise gelten speziell für Ihr Konto und können individuell vereinbarte Preise enthalten. Die Antwort gibt keine Währung an.
• Führt Live-Katalogabfragen durch und kann daher langsamer sein als andere Aufrufe zur Ermittlung verfügbarer Rufnummern. Die Ergebnisse können sich zwischen den Aufrufen ändern.