v2

Die vollständige Liste Ihrer Nummern senden

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

Übergeben Sie alle Nummern, die gerade zum Verkauf verfügbar sind. Die Anfrage ersetzt Ihre Liste der über diese API hinzugefügten Nummern:

  • Nummern, die nicht in der Anfrage enthalten sind, werden entfernt (ihr Wert in ids ist null);
  • Nummern, die bereits auf der Liste stehen, bleiben unverändert, mit derselben ID (ihre übrigen Felder werden nicht aktualisiert: Verwenden Sie addNumber, um eine Nummer zu ersetzen);
  • neue Nummern werden hinzugefügt und vom Server innerhalb von etwa einer Minute aktiviert.

Einer Nummer ohne Ländervorwahl am Anfang wird die Vorwahl aus country_id vorangestellt.

Die Anfrage bestätigt außerdem, dass Ihr Server läuft. Senden Sie sie nach jeder Änderung der Liste und mindestens alle 5 Minuten. Statt die Liste erneut zu senden, können Sie die Verfügbarkeit mit checkWork bestätigen und die Liste mit addNumber und removeNumber ändern.

Hat Ihr Server die Verfügbarkeit länger als 10 Minuten nicht bestätigt, werden alle Nummern entfernt, die Sie über diese API hinzugefügt haben.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Content-Typeapplication/json
Schema
schemaobject
numbersobject[]Alle zum Verkauf verfügbaren Nummern. Ein JSON-String des Arrays wird ebenfalls akzeptiert.
teststring
Testmodus, nur für Anfragen an /api/resellers*. Er kann im Query-String oder 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: Zum Beispiel wird eine von addMessage angenommene SMS dennoch an den Kunden zugestellt, und used-Werte werden dennoch gespeichert.
  • 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:test1test2Beispiel:test1

Beispiele

threeNumbersZeilen: 22

Drei Nummern, die letzten beiden mit optionalen Feldern

{
  "numbers": [
    {
      "number": "+234112233445",
      "country_id": 234
    },
    {
      "number": "+234112233446",
      "country_id": 234,
      "date_start": 1543907600
    },
    {
      "number": "+234112233447",
      "country_id": 234,
      "date_start": 1543907600,
      "port_id": "Port1",
      "used": [
        "vkcom"
      ]
    }
  ]
}

Antworten

200Die Liste ist angenommen. Prüfen Sie das Ergebnis jeder Nummer in ids.
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Enumeration:1Beispiel:1
idsanyOfErforderlichErgebnis je Nummer. Der Schlüssel ist die Telefonnummer als Ziffern (mit Ländervorwahl, ohne +). Der Wert ist die ID der Nummer auf unserem Server, null für eine Nummer, die von Ihrer Liste entfernt wurde, oder fail für eine Nummer, die nicht hinzugefügt wurde. Eine Nummer schlägt fehl, wenn sie keine Telefonnummer ist, das Land unbekannt ist, ihre port_id bereits von einer anderen Ihrer Nummern verwendet wird, sie unter einem anderen Konto online ist, equipment_id ungültig ist oder rent ohne Mietzugang angefordert wird. Ein leeres Ergebnis wird als leeres Array [] zurückgegeben.

Beispiele

success

Zwei Nummern hinzugefügt, eine entfernt, eine keine Telefonnummer

{
  "response": "1",
  "ids": {
    "234112233445": 1042,
    "234112233446": 1043,
    "234112233440": null,
    "abc": "fail"
  }
}
400numbers ist keine Liste
Content-Typeapplication/json
Schema
schemaobjectFehlerantwort: response und message enthalten denselben Fehlercode.
responsestringErforderlich
Enumeration:ERROR_PARAMS
messagestringErforderlich
Beispiel:ERROR_PARAMS
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...