v2

Daten und Status einer Nummer abrufen

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

Gibt die Daten einer Ihrer Nummern zurück (einschließlich über Ausrüstung angeschlossener Nummern): Status, Einkommen, Dienste, Sperren und auf Wunsch den Verlauf der Vorgänge.

Die Anfrage bestätigt außerdem, dass Ihr Server läuft.

Parameter

query4
NameTypBeschreibung
number*string

Telefonnummer mit Ländervorwahl (ein optionales führendes + wird ignoriert)

with_historyboolean

Fügt Ihre abgeschlossenen Vorgänge auf der Nummer zu history hinzu. Der Parameter wirkt durch sein Vorhandensein: Jeder Wert, auch 0, aktiviert ihn.

as_textboolean

Gibt used_service und banned_service als kommagetrennte Strings zurück. Wirkt durch sein Vorhandensein, wie with_history.

teststring

Testmodus. Er kann auch im Anfragetext übergeben werden.

  • test1 — die Anfrage wird wie gewohnt ausgeführt und beantwortet, aber ihre Datenbankänderungen werden zurückgerollt. Wirkungen außerhalb der Datenbank treten trotzdem ein.
  • test2 — die Anfrage wird nicht ausgeführt: Die Antwort ist ein Debug-Dump (HTML, HTTP 200) der Anfrage-Header und des Anfragetexts, so wie unser Server sie empfangen hat.

Eine Anfrage mit einem beliebigen nicht leeren test-Wert bestätigt nicht, dass Ihr Server läuft.

Enumeration:test1test2
header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Antworten

200Die Daten der Nummer mit "response": "1" oder {"response": "0"}, wenn Sie keine solche Nummer haben
Content-Typeapplication/json
Schema
schemaoneOf
Eins von
[0]objectDaten einer Ihrer Nummern.
[1]object

Beispiele

withHistoryZeilen: 35

Eine aktive Nummer, abgefragt mit with_history

{
  "id": 110251,
  "balance": 0,
  "country_id": 46,
  "errors": 0,
  "number": "4605091080",
  "port_id": "Port1",
  "equipment_id": "2130706433",
  "sum": 26,
  "used_service": {
    "telegram": "tg"
  },
  "banned_service": {
    "whatsapp": "wa"
  },
  "history": [
    {
      "id": 1027,
      "number": 4605091080,
      "service": "telegram",
      "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": "no",
  "status": 1,
  "status_text": "work",
  "clearable": true,
  "created_at": "2024-06-11T14:33:26.000000Z",
  "response": "1"
}
justAddedZeilen: 21

Eine Nummer wartet auf Aktivierung, Konto ohne Mietzugang

{
  "id": 110252,
  "balance": 0,
  "country_id": 1,
  "errors": 0,
  "number": "15555555555",
  "port_id": "Port2",
  "equipment_id": "2130706433",
  "sum": 0,
  "used_service": {},
  "banned_service": {},
  "history": [],
  "banned": false,
  "reseller_id": 12345,
  "rent": null,
  "status": 2,
  "status_text": "wait",
  "clearable": false,
  "created_at": "2024-06-01T09:00:00.000000Z",
  "response": "1"
}
notFound

Sie haben keine solche Nummer

{
  "response": "0"
}
401Kein API-Schlüssel, oder der Schlüssel existiert nicht. Der Body ist der reine Text Unauthorized. Eine Anfrage mit Accept: application/json erhält stattdessen HTTP 200 mit {"response":"ERROR_WRONG_KEY"}.
Content-Typetext/html
Schema
schemastring
Enumeration:Unauthorized.Beispiel:Unauthorized.
403Verboten: Der API-Schlüssel ist gültig, aber die Anfrage wird abgelehnt. Fehlercodes:
  • ERROR_DISABLED — das Partnerkonto ist nicht aktiviert;
  • ERROR_BANNED — das Partnerkonto ist gesperrt;
  • ERROR_IP — die Anfrage kommt von einer IP-Adresse, die nicht auf der Positivliste des Kontos steht;
  • ERROR_RENT — rent wird angefordert, aber das Konto hat keinen Mietzugang (nur addNumber).
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
FehlercodeEnumeration:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENT
messagestringErforderlich
Derselbe Fehlercode

Beispiele

ERROR_IP

Anfrage von einer IP-Adresse außerhalb der Positivliste

{
  "response": "ERROR_IP",
  "message": "ERROR_IP"
}

Codebeispiele

Beispiele werden generiert...