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

Empfangene SMS im Batch an den Onlinesim-Server weiterleiten

Diese Anfrage leitet mehrere eingehende SMS in einer einzigen Anfrage an den Onlinesim-Server weiter.

Wir empfehlen, diese Methode anstelle von addMessage zu verwenden und SMS gebündelt zu senden, z. B. einmal alle 5 Sekunden.

Parameter

header2
NameTypBeschreibung
Authorization*string

Siehe Details hier

Content-Type*string

Header Content-Type und Kodierung

Enumeration:application/json; charset=utf-8

Anforderungs-Body

Ihr Server sollte diese Anfrage senden, wenn neue Nachrichten empfangen wurden und mehrere SMS gleichzeitig übertragen werden müssen.

Content-Typeapplication/json
Schema
schemaobject
messagesobject[]Erforderlich

Array von Nachrichten.

teststring

Optionales Feld für den Anfragetext der Reseller API v2. Kann einen von zwei Werten annehmen: test1 oder test2.

Bei Wert test1 wird die Anfrage an den Server gesendet, aber die mit dieser Anfrage übermittelten Daten werden von unserem Server nicht gespeichert (die Funktion wird nicht durch diese Anfrage ausgeführt).

Wenn der Parameter test2 ist, gibt der Onlinesim-Server in der Antwort den Textkörper Ihrer Anfrage zurück.

Kann als Query-Parameter (für GET) oder als Feld im Anfragetext (für POST) übergeben werden. Beide Methoden sind gleichwertig, aber die gleichzeitige Verwendung wird nicht empfohlen.

Enumeration:test1test2

Beispiele

Example payload of your server `addMessages` request
{
  "messages": [
    {
      "number": "33712345678",
      "from": "Telegram",
      "message": "Code: 12345"
    },
    {
      "number": "33712345679",
      "from": "WhatsApp",
      "message": "Code: 56789"
    }
  ]
}

Antworten

200

Antwort des Onlinesim-Servers

Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich

1, wenn mindestens eine Nachricht erfolgreich verarbeitet wurde, sonst 0

Enumeration:01
totalintegerErforderlich

Gesamtzahl der verarbeiteten Einträge

successintegerErforderlich

Anzahl erfolgreich verarbeiteter Nachrichten

failedintegerErforderlich

Anzahl der Nachrichten mit Fehler

resultsobject[]Erforderlich

Verarbeitungsergebnisse für jede Nachricht

Beispiele

Onlinesim server response example for `addMessages` requestexample_lines
{
  "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"
    }
  ]
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Erforderliche Parameter fehlen oder sind inkorrekt (der Anfragetext muss die Parameter mit den korrekten Bezeichnungen enthalten, wie in der Dokumentation angegeben)

Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Enumeration:ERROR_PARAMS
messagestringErforderlich
401

Nicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet. Einige Endpunkte können anstelle von 401 einen 200-Status mit der Meldung ERROR_WRONG_KEY zurückgeben — prüfen Sie den Antworttext

Content-Typetext/plain
Schema
schemastring
Enumeration:Unauthorized
403

Verboten. Die Anfrage wurde verstanden, aber aufgrund fehlender Berechtigungen abgelehnt

Content-Typeapplication/json
Schema
schemaobject
errorobjectErforderlich
messagestringErforderlich
Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Erforderlich

Codebeispiele

Beispiele werden generiert...