v2

Mehrere empfangene SMS auf einmal weiterleiten

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

Leitet mehrere SMS in einer Anfrage weiter. Jede SMS wird wie in addMessage verarbeitet, und die Antwort meldet das Ergebnis jeder einzelnen. Wir empfehlen diese Methode statt addMessage: Sammeln Sie die SMS und senden Sie sie gebündelt, zum Beispiel alle paar Sekunden.

Die Antwort ist HTTP 200, auch wenn keine SMS angenommen wurde: Prüfen Sie response und results.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Content-Typeapplication/json
Schema
schemaobject
messagesobject[]ErforderlichDie SMS, mindestens eine. Ein JSON-String des Arrays wird ebenfalls akzeptiert.minItems: 1
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

twoSms

Zwei SMS

{
  "messages": [
    {
      "number": "33712345678",
      "from": "Telegram",
      "message": "Code: 12345"
    },
    {
      "number": "33712345679",
      "from": "WhatsApp",
      "message": "Code: 56789"
    }
  ]
}

Antworten

200Ergebnis jeder SMS
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
1, wenn mindestens eine SMS angenommen wurde, sonst 0Enumeration:01Beispiel:1
totalintegerErforderlich
Anzahl der SMS in der AnfrageBeispiel:2
successintegerErforderlich
Anzahl der angenommenen SMSBeispiel:1
failedintegerErforderlich
Anzahl der nicht angenommenen SMSBeispiel:1
resultsobject[]ErforderlichErgebnis jeder SMS, in der Reihenfolge der Anfrage

Beispiele

partlyAcceptedZeilen: 21

Eine SMS angenommen, eine ohne passenden Vorgang

{
  "response": "1",
  "total": 2,
  "success": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "number": "33712345678",
      "from": "Telegram",
      "response": "1"
    },
    {
      "index": 1,
      "number": "33712345679",
      "from": "WhatsApp",
      "response": "0",
      "error": "NO_OPERATION"
    }
  ]
}
400messages fehlt, ist leer oder 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...