POSThttps://{ourserver.com}/api/resellers/sendNumbersOnline

Telefonnummern in großen Mengen an den Onlinesim-Server senden

In dieser Anfrage sollten alle verfügbaren Verkaufsnummern übergeben werden. Diese Anfrage muss alle 5 Minuten an den Onlinesim-Server gesendet werden (zur Bestätigung der Verfügbarkeit Ihres Servers) und nach jeder Änderung der Nummernliste: nach dem Hinzufügen neuer Nummern oder dem Entfernen zuvor übergebener Nummern.

Es gibt jedoch eine Alternative: Zur Bestätigung der Verfügbarkeit können Sie die Anfrage checkWork verwenden, und zum Hinzufügen und Entfernen von Nummern die Anfragen addNumber und removeNumber entsprechend.

Bei fehlender Bestätigung der Verfügbarkeit (über sendNumbersOnline oder checkWork) Ihres Servers innerhalb von 10 Minuten betrachtet das System Ihren Server als nicht verfügbar und entfernt automatisch alle Ihre Nummern aus der Ausgabe.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Ihr Server sollte diese Anfrage alle 5 Minuten als Bestätigung der Uptime senden oder bei Änderungen der Liste der verfügbaren Nummern (beim Hinzufügen neuer Nummern oder beim Entfernen von zuvor übermittelten).

Content-Typeapplication/json
Schema
schemaobject
numbersobject[]
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 die gleichzeitige Verwendung wird nicht empfohlen.

Enumeration:test1test2

Beispiele

Example payload of your server `sendNumbersOnline` requestexample_lines
{
  "numbers": [
    {
      "number": "+234112233445",
      "country_id": 234
    },
    {
      "number": "+234112233446",
      "country_id": 234,
      "operator": 28967,
      "date_start": 1543907600
    },
    {
      "number": "+234112233447",
      "country_id": 234,
      "operator": 28967,
      "date_start": 1543907600,
      "port_id": "Port1"
    }
  ]
}

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

idsobject

Ein Objekt, bei dem die Schlüssel Telefonnummern (im internationalen Format, z. B. "+234112233445") und die Werte die entsprechenden, vom Server vergebenen IDs sind

Beispiele

Successful Onlinesim server response example
{
  "response": 1,
  "ids": {
    "+234112233445": 1042,
    "+234112233446": 1043,
    "+234112233447": 1044
  }
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Fehler 400

Content-Typetext/html
Schema
schemastring

Fehlerbeschreibung

Beispiele

Incorrect format number passed
NUMBER_FORMAT_ERROR
date_start format error
ERROR_DATE
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...