GEThttps://{ourserver.com}/api/resellers/checkNumber

Detaillierte Informationen über die Telefonnummer und ihren Status erhalten

Diese Anfrage gibt detaillierte Informationen über die Nummer zurück.

Sie können sie verwenden, um Daten zu erhalten, z. B. für die Analyse der Nummernstatistik.

Parameter

query3
NameTypBeschreibung
number*string

Telefonnummer im internationalen Format (einschließlich Ländervorwahl)

with_historyboolean

Flag für detaillierte Betriebshistorie (wenn true, gibt eine Liste der Vorgänge für die angegebenen Nummern zurück)

teststring

Optionales Feld für den Anfragetext der Reseller API v2. Kann einen von zwei Werten annehmen: test1 oder test2.

Bei Wert test1 wird die Anfrage an den Server gesendet, aber die mit dieser Anfrage übermittelten Daten werden von unserem Server nicht gespeichert (die Funktion wird nicht durch diese Anfrage ausgeführt).

Wenn der Parameter test2 ist, gibt der Onlinesim-Server in der Antwort den Textkörper Ihrer Anfrage zurück.

Kann als Query-Parameter (für GET) oder als Feld im Anfragetext (für POST) übergeben werden. Beide Methoden sind gleichwertig, aber es wird nicht empfohlen, sie gleichzeitig zu verwenden.

Enumeration:test1test2
header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Antworten

200

Antwort des Onlinesim-Servers

Content-Typeapplication/json
Schema
schemaobject
responseoneOf

1, wenn die Anfrage erfolgreich ausgeführt wurde, oder gibt eine Fehlermeldung aus

Alles von
[0]object

Ein Objekt mit Daten zu jeder Nummer, wobei der Schlüssel die Telefonnummer ist

Beispiele

Example response from Onlinesim server (successful retrieval with full details)example_lines
{
  "response": "1",
  "id": 110251,
  "balance": 250,
  "country_id": 46,
  "errors": 0,
  "number": "4605091080",
  "port_id": "Port1",
  "sum": 76.25,
  "used_service": {
    "wa": "wa",
    "tg": "tg"
  },
  "banned_service": {
    "fb": "fb"
  },
  "history": [
    {
      "number": 46777666555,
      "service": "rent",
      "sum": 26.6,
      "created_at": "2024-06-11 17:33:26",
      "updated_at": "2024-06-11 17:48:37",
      "history": true
    }
  ],
  "banned": false,
  "reseller_id": 12345,
  "rent": true,
  "status": 1,
  "status_text": "work",
  "clearable": true,
  "created_at": {
    "date": "2024-05-01T12:00:00",
    "timezone_type": 1,
    "timezone": "UTC"
  }
}
Example response from Onlinesim server (successful retrieval with empty history as `with_history` is not passed)example_lines
{
  "response": "1",
  "id": 110252,
  "balance": 100,
  "country_id": 1,
  "errors": 3,
  "number": "15555555555",
  "port_id": "Port2",
  "sum": 0,
  "used_service": {
    "in": "in"
  },
  "banned_service": {
    "wa": "wa",
    "tg": "tg"
  },
  "history": [],
  "banned": true,
  "reseller_id": 12346,
  "rent": false,
  "status": 6,
  "status_text": "rent_error",
  "clearable": false,
  "created_at": {
    "date": "2024-06-01T12:00:00",
    "timezone_type": 1,
    "timezone": "UTC"
  }
}
Example response from Onlinesim server (failed retrieval)
{
  "response": "0"
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
401

Nicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet. Einige Endpunkte können anstelle von 401 einen 200-Status mit der Meldung ERROR_WRONG_KEY zurückgeben — prüfen Sie den Antworttext

Content-Typetext/plain
Schema
schemastring
Enumeration:Unauthorized
403

Verboten. Die Anfrage wurde verstanden, aber aufgrund fehlender Berechtigungen abgelehnt

Content-Typeapplication/json
Schema
schemaobject
errorobjectErforderlich
messagestringErforderlich
Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Erforderlich

Codebeispiele

Beispiele werden generiert...