v2

Eine Nummer entfernen

DELETEhttps://{ourserver.com}/api/resellers/removeNumber

Entfernt eine Ihrer über diese API hinzugefügten Nummern, nach Telefonnummer oder nach ID. Sie können sie statt sendNumbersOnline verwenden, um die Liste gezielt zu ändern.

Übergeben Sie number, id oder beide: Jede Nummer, die zu einem davon passt, wird entfernt. Die Parameter können auch im Anfragetext übergeben werden.

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

Parameter

query3
NameTypBeschreibung
numberstring

Telefonnummer mit Ländervorwahl (ein optionales führendes + wird ignoriert). Erforderlich, wenn id nicht übergeben wird.

idinteger

ID der Nummer, die beim Hinzufügen zurückgegeben wurde. Erforderlich, wenn number nicht übergeben wird.

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

2001, wenn eine Nummer entfernt wurde, 0, wenn nichts passte
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Enumeration:01Beispiel:1

Beispiele

removed

Die Nummer ist entfernt

{
  "response": "1"
}
notFound

Keine solche Nummer auf Ihrer Liste (nie hinzugefügt oder bereits entfernt)

{
  "response": "0"
}
400Weder number noch id wurde übergeben
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...