Bestätigen, dass Ihr Server läuft
GEThttps://{ourserver.com}/api/resellers
Bestätigt, dass Ihr Server läuft, und tut sonst nichts. POST an dieselbe URL funktioniert genauso.
Statt sendNumbersOnline alle 5 Minuten zu senden, können Sie diese Anfrage ohne Parameter im selben Intervall senden. 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.
Auch andere Anfragen bestätigen die Verfügbarkeit: sendNumbersOnline, addNumber(s), removeNumber(s),
checkNumber(s), addMessage(s). Eine Anfrage mit dem Parameter test tut das nicht.
Parameter
header1
| Name | Typ | Beschreibung |
|---|---|---|
Authorization* | string | Siehe Details hier |
query1
| Name | Typ | Beschreibung |
|---|---|---|
test | string | Testmodus. Er kann auch im Anfragetext übergeben werden.
Eine Anfrage mit einem beliebigen nicht leeren Enumeration: test1test2 |
Antworten
200Die Verfügbarkeit ist bestätigt
application/jsonschemaobject
1Beispiel:1Beispiele
Die Verfügbarkeit ist bestätigt
{
"response": "1"
}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"}.
text/htmlUnauthorized.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).
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).application/jsonschemaobject
ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTBeispiele
Anfrage von einer IP-Adresse außerhalb der Positivliste
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}