v2

Mehrere Nummern hinzufügen

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

Fügt Ihrer Liste mehrere Nummern in einer Anfrage hinzu. Jede Nummer wird wie in addNumber verarbeitet: Eine Nummer, die bereits auf der Liste steht, wird ersetzt und erhält eine neue ID. Nummern, die nicht in der Anfrage enthalten sind, bleiben auf der Liste.

Die Antwort ist HTTP 200, auch wenn einige Nummern fehlschlagen: Prüfen Sie den Wert jeder Nummer in ids.

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

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Content-Typeapplication/json
Schema
schemaobject
numbersobject[]Hinzuzufügende Nummern
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

twoNumbersZeilen: 17

Zwei Nummern, die zweite mit optionalen Feldern

{
  "numbers": [
    {
      "number": "+4695000051",
      "country_id": 46
    },
    {
      "number": "+4695000052",
      "country_id": 46,
      "port_id": "Port2",
      "used": [
        "vkcom"
      ],
      "date_start": 1658209063
    }
  ]
}

Antworten

200Ergebnis jeder Nummer
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

partlyAdded

Zwei Nummern hinzugefügt, eine mit unbekanntem Land

{
  "response": "1",
  "ids": {
    "4695000051": 1042,
    "4695000052": 1043,
    "4695000053": "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...