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

GET /api/resellers/takeOffNumbers

Informationen über die Einnahmen der Nummern erhalten

Diese Anfrage ist optional, Sie müssen diese Methode nicht implementieren. Die Anfrage gibt Informationen über das Einkommen Ihrer aktuellen Nummern zurück, diese Daten sind auch in Ihrem persönlichen Konto verfügbar. Bei übergebenem Parameter sum gibt sie eine Liste der Online-Nummern des Kontos zurück, deren Einkommen den übergebenen Wert überschreitet.

Diese Anfrage kann verwendet werden, um schnell Informationen darüber zu erhalten, welche Nummern Ihr gewünschtes Einkommen erreicht haben und durch neue ersetzt werden können.

Parameter

query2
NameTypBeschreibung
sumstring

Filter nach Einkommenswert, in Rubel.

Zum Beispiel: Bei sum = 37.5 gibt die Anfrage eine Liste der Online-Nummern zurück, deren Einkommen gleich oder höher als 37.5 RUB ist.

Wenn 0 als Wert übergeben wird, gibt der Server eine Liste aller Online-Nummern des Kontos zurück.

Standard:50
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
Responseobject
responseoneOf

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

Eins von
[0]string
[1]integer
listobject[]
itemsobject
idstring

ID der Nummer

numberstring

Telefonnummer im internationalen Format

sumstring

Gesamte Einnahmesumme, die von der Nummer erzielt wurde

countrystring

Ländercode (gemäß Länderliste)

Beispiele

Example response of Onlinesim server for takeOffNumbers request17 Zeilen
{
  "response": 1,
  "list": [
    {
      "id": "40516575",
      "number": "2203830000",
      "sum": "75.76",
      "country": "220"
    },
    {
      "id": "40516576",
      "number": "2203830001",
      "sum": "58.76",
      "country": "220"
    }
  ]
}
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...