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

GET /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

Name	Typ	Beschreibung
`number`*	`string`	Telefonnummer im internationalen Format (einschließlich Ländervorwahl)
`with_history`	`boolean`	Flag für detaillierte Betriebshistorie (wenn `true`, gibt eine Liste der Vorgänge für die angegebenen Nummern zurück)
`test`	`string`	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

Name	Typ	Beschreibung
`Authorization`*	`string`	Siehe Details hier

Antworten

200

Antwort des Onlinesim-Servers

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

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

Eins von

[0]string

[1]integer

Alles von

[0]object

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

idinteger

Nummern-ID

balanceinteger

Guthaben der Nummer

country_idinteger

Ländercode (gemäß Länderliste)

errorsinteger

Wie oft die Nummer bestellt wurde, aber keine SMS erhalten konnte (Anzahl fehlgeschlagener Vorgänge)

numberstring

Telefonnummer im internationalen Format

port_idstring

Eindeutiger Portname, der in unserer Benutzeroberfläche auf der Seite zur Verwaltung Ihrer Nummern angezeigt wird.

Der Standardwert entspricht der Telefonnummer (dem Wert des Parameters number)

maxLen: 100

suminteger

Gesamteinkommen, das von dieser Nummer erzielt wurde, in Rubel

used_serviceobject

Ein Objekt, dessen Schlüssel die Kurznamen (Slugs) der auf der aktuellen Nummer verwendeten Dienste sind, gemäß der Dienste-Liste. Für den Dienst „Miete“ lautet der Schlüssel rent

[additionalProperties]string

Kurzer Dienstname (Slug)

banned_serviceobject

Ein Objekt, dessen Schlüssel die Kurznamen (Slugs) der auf der aktuellen Nummer gesperrten Dienste sind, gemäß der Dienste-Liste. Für den Dienst „Miete“ lautet der Schlüssel rent

[additionalProperties]string

Kurzer Dienstname (Slug)

historyobject[]

itemsobject

numberinteger

Telefonnummer im internationalen Format

servicestring

Name des Dienstes (für Mietvorgänge ist der Wert immer rent)

sumnumber

Einnahmebetrag für diesen Vorgang in Rubel (0, wenn der Vorgang vom Kunden abgebrochen wurde oder keine SMS eingegangen ist)

created_atstring

Datum und Uhrzeit des Beginns des Vorgangs (Bestellung der Nummer durch den Kunden)

updated_atstring

Datum und Uhrzeit der letzten Aktualisierung der Vorgangsinformationen (wenn der Vorgang geschlossen ist - entspricht dem Datum und der Uhrzeit des Schließens)

historyboolean

Flag für den Abschluss des Vorgangs (wenn true - der Vorgang ist zum Zeitpunkt der Anfrage geschlossen)

bannedboolean

Wenn true, ist die Nummer blockiert (die Blockierung wird automatisch nach 3 fehlgeschlagenen Vorgängen angewendet). Die Blockierung wird automatisch alle 24 Stunden aufgehoben oder durch Klicken auf die Schaltfläche Bans zurücksetzen/Clean all banned services auf der PSA-Seite.

reseller_idinteger

ID des Onlinesim-Partnerkontos

rentboolean

Wenn der Wert true ist, hat Ihr Konto die Möglichkeit, Nummern zur Miete anzubieten

statusinteger

Aktueller Status der Nummer, enum:

1 - Nummer funktioniert

2 - Nummer wird auf den Server geladen (nach dem Hinzufügen zur Nummernliste)

3 - (deprecated)

4 - Die von Ihnen angegebene Nummer ist nicht in Ihrem Konto vorhanden (ungültige Nummer)

5 - (deprecated)

6 - null, Mietfehler: Diese Nummer wurde zuvor erfolgreich für die Miete verwendet und wird keinen Gewinn mehr generieren. Sie müssen die Nummer durch eine neue ersetzen.

7 - (deprecated)

Enumeration:123467

status_textstring

Aktueller Status der Nummer, Textbeschreibung

clearableboolean

Verfügbarkeit der Funktion Bans zurücksetzen/Clean all banned services (verfügbar einmal alle 24 Stunden)`

created_atobject

datestring

Datum und Uhrzeit der Nummernveröffentlichung

timezone_typeinteger

Zeitzone der Serverzeit

timezonestring

Zeitzone der Serverzeit (im Textformat)

Beispiele

Example response from Onlinesim server (successful retrieval with full details)38 Zeilen

{
  "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)29 Zeilen

{
  "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

Responsestring

Enumeration:Unauthorized

403

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

Content-Typeapplication/json

Schema

Responseobject

errorobjectErforderlich

statusinteger

HTTP-Antwortcode im Textformat

codestring

messagestring

Mögliche Fehlercodes: - ERROR_DISABLED - Partnerkonto ist nicht aktiviert - ERROR_IP - IP-Adresse befindet sich nicht in der Liste der erlaubten Adressen - Allowlist (siehe ) - ERROR_RENT - Konto hat keinen Zugriff auf die Miete

Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT

messagestringErforderlich

Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT

detailsobject[]Erforderlich

itemsobject

Codebeispiele

Beispiele werden generiert...