Bevor Sie beginnen
Wählen Sie einen Bereich mit getareas. Kopieren Sie die Bereichs-ID aus der Antwort oder dem zurückgegebenen next_function. Für einen Bereich in den USA oder Kanada verwenden Sie getstates, wenn Sie die Ergebnisse auf einen Bundesstaat oder eine Provinz eingrenzen möchten.
Ergebnis auswerten
Prüfen Sie status.code im JSON-Antworttext sowie den HTTP-Status. Erfolgreiche Ergebnisse befinden sich im response-Array. Die Standardantwort ist nach Namen sortiert. available ist eine Schätzung. Katalogkennzeichen ersetzen nicht die Prüfung der tatsächlichen Funktionen und Registrierungsanforderungen der ausgewählten Rufnummer.
Nächsten Schritt auswählen
Verwenden Sie ein nicht gruppiertes Ergebnis. Wenn returns_numbers den Wert 1 hat, verweist das zurückgegebene next_function auf eine Rufnummernsuche. Bei einem Wert von 0 werden Rufnummern bei der Bestellung zugewiesen, und der Pfad verweist auf einen Bestellvorgang. Prüfen Sie den Vorgang und seine Anforderungen, bevor Sie die Anfrage senden: Eine Bestellanfrage kann Ihr Konto belasten. Rufen Sie nicht automatisch jeden zurückgegebenen Pfad auf.
Hier ist kein Preis enthalten. Prüfen Sie vor dem Kauf das zugehörige Preisangebot, die erforderlichen Dokumente und die Bestellhinweise. Bewahren Sie die zurückgegebenen IDs des einzelnen Präfixes und des Preisangebots auf, statt sie aus einem angezeigten Rufnummernpräfix zu konstruieren.
Erweiterte Anzeigeoptionen
compact=1 liefert eine zufällig angeordnete Stichprobe mit höchstens 100 Zeilen, keine Seite einer größeren Ergebnismenge. Durch Gruppierung entstehen zusammengefasste Zeilen und künstliche IDs. Verwenden Sie eine normale, nicht gruppierte Antwort, um ein einzelnes Präfix auszuwählen. Leiten Sie aus Stichproben oder gruppierten Ergebnissen keine Aussagen über den vollständigen Bestand oder die genauen Funktionen ab.
Anfrage
Verwenden Sie die Zugangsdaten Ihres freigeschalteten API-Kontos über HTTPS. Unterstützt werden Basic-Authentifizierung und freigeschaltete bearer-Token für API-Konten; Kontobeschränkungen gelten weiterhin.
Verwenden Sie GET und übermitteln Sie optionale Parameter in der Abfragezeichenfolge. Verlassen Sie sich nicht darauf, dass ersatzweise Formulardaten aus dem Anfragetext verarbeitet werden.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
area_id | string | Ja | Kopieren Sie die Bereichskennung aus getareas oder dessen next_function. Behandeln Sie sie als undurchsichtigen Wert; konstruieren Sie sie nicht selbst und berechnen Sie sie nicht durch Hashing. |
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
state | string | Nein | Nur für Bereiche in US und CA. Verwenden Sie einen Bundesstaats- oder Provinzcode aus getstates oder den vollständigen Namen des Bundesstaats bzw. der Provinz. Bei Codes wird die Groß- und Kleinschreibung nicht unterschieden; bei Namen werden außerdem mehrfach aufeinanderfolgende Leerraumzeichen ignoriert. Bei einem anderen Land oder einem nicht erkannten, nicht leeren Wert wird ein API-Fehler zurückgegeben. |
compact | string | Nein | Optionaler Stichprobenmodus: 1, true oder on. Die Ergebnisse werden zufällig angeordnet und umfassen höchstens 100 Zeilen. Lassen Sie diesen Parameter weg, um eine vollständige Ergebnisliste zu erhalten; dieser Endpunkt bietet keine Seiten- oder Cursorfunktion. |
group | integer | Nein | Erweiterte Zusammenfassungen für die Anzeige: Die Werte 1 bis 6 fassen Zeilen zusammen und geben maskierte Präfixe zur Anzeige zurück. Gruppen-UUIDs sind künstlich erzeugt und nicht mit den IDs einzelner Präfixe austauschbar. Stellen Sie eine Anfrage ohne Gruppierung, bevor Sie ein Präfix für eine Rufnummernsuche oder Bestellung auswählen. Lassen Sie diesen Parameter für den normalen Ablauf weg. |
pid | string | Nein | Optionaler, von MultiTEL bereitgestellter Selektor zur Bestandsauswahl in numerischer oder unterstützter hexadezimaler Form mit 32 Zeichen. Lassen Sie ihn bei normaler Verwendung weg. Nicht erkannte Werte werden ohne Meldung ignoriert. Der Wert ist weder ein Rufnummernpräfix noch eine Tarif-ID. |
Antwort
Die standardmäßige JSON-Hüllstruktur mit status/response. status.results zählt die zurückgegebenen Zeilen, auch bei Stichproben oder Gruppierung. response enthält Präfixobjekte. Es werden keine Preisfelder zurückgegeben. In der normalen, nicht gruppierten Antwort ist uuid die Präfix-ID; area_uuid und country_uuid sind zurückgegebene Kennungen; prefix und name sind Anzeigeinformationen; available ist eine Verfügbarkeitsschätzung und keine Reservierung; needs_registration und restrictions beschreiben Registrierungsinformationen; sms_coverage, is_mobile und number_type sind Hinweise aus dem Katalog und keine Garantie für eine bestimmte Funktion einer Rufnummer. number_type kann leer sein oder eine andere Zeichenfolge aus dem Katalog enthalten; setzen Sie daher keine feste Aufzählung zulässiger Werte voraus. state ist eine Zeichenfolge und kann leer sein oder katalogspezifische Formatierungen enthalten. latitude und longitude können leer sein. metered und overflow sind Katalogkennzeichen, keine Geldbeträge. returns_numbers wählt einen Pfad zur Rufnummernauflistung (1) oder zur Zuweisung bei der Bestellung (0). next_function bezeichnet diesen nächsten Pfad. Gruppierte Antworten enthalten zusätzlich zusammengeführte Merkmale, einschließlich ersatzweise verwendeter Merkmalswerte; interpretieren Sie diese nicht als verifizierte Funktionen jeder einzelnen Rufnummer.
Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}Fehler
- 404: Invalid area ID: Rufen Sie über die Katalogabfragen eine aktuelle Bereichs-ID ab.
- 404: State filter is only available for US and CA: Lassen Sie state für andere Länder weg.
- 404: Invalid state: Verwenden Sie einen Bundesstaat oder eine Provinz, die getstates für dieses Land zurückgibt.
- 404: No prefixes found: Es wurden keine passenden Katalogzeilen zurückgegeben. Das beweist nicht, dass eine bestimmte Rufnummer niemals bestellt werden kann.
- 500: Fehler: 'Failed loading prefixes': Die Katalogabfrage ist fehlgeschlagen. Versuchen Sie es später erneut und wenden Sie sich an den Support, wenn der Fehler weiterhin auftritt.
Verfügbarkeit und Nebenwirkungen
- Dies ist ein Schritt zur Ermittlung des Angebots, keine Bestellbestätigung. Die Verfügbarkeit kann durch weitere Katalogabfragen aktualisiert werden, weshalb die Antwortzeit variieren kann.
- Es werden keine Preise zurückgegeben. Rufen Sie das zutreffende Preisangebot für die Rufnummer oder Bestellung ab und prüfen Sie vor einer Bestellung die Registrierungsanforderungen.
- Betrachten Sie available nicht als genaue Bestandszahl, einen Nullwert nicht als generelles Bestellverbot und eine erfolgreiche Abfrage nicht als Reservierung. Die Verfügbarkeit kann sich vor der Bestellung ändern.