posthttps://{ourserver.com}/api/resellers/addMessage

POST /api/resellers/addMessage

Empfangene SMS an den Onlinesim-Server weiterleiten

Diese Anfrage leitet Nachrichten weiter, die von Ihren Nummern auf dem Onlinesim-Server empfangen wurden.

Sie können Nachrichten vor dem Senden der Anfrage filtern (nur SMS vom bestellten Dienst senden) oder alle Nachrichten senden, und wir führen die Filterung auf unserer Seite durch.

Sie können auch alle eingehenden SMS blockieren, die vertrauliche Informationen und persönliche Daten enthalten, wie z. B. das Passwort für die Anmeldung im persönlichen Konto auf der Website des Mobilfunkanbieters und andere SMS.

Parameter

header2

Name	Typ	Beschreibung
`Authorization`*	`string`	Siehe Details hier
`Content-Type`*	`string`	Header `Content-Type` und Kodierung Enumeration:`application/json; charset=utf-8`

Anforderungs-Body

Ihr Server muss diese Anfrage senden, sobald die bestellte Nummer eine Nachricht erhalten hat.

Content-Typeapplication/json

Schema

Bodyobject

Alles von

[0]object

numberoneOfErforderlich

Telefonnummer im internationalen Format oder Nummern-ID

(siehe Serverantwort auf die Anfrage sendNumbersOnline)

Eins von

[0]integer

[1]string

fromstringErforderlich

Name oder Nummer des Absenders

messagestringErforderlich

Nachrichtentext

datestring

Datum und Uhrzeit des Nachrichtenempfangs (in jedem Format, z. B. UNIX-Zeitstempel)

[1]object

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 `addMessage` request

{
  "number": "+234112233445",
  "from": "VKcom",
  "message": "VKcom 111111",
  "date": "1546934787"
}

Antworten

200

Antwort des Onlinesim-Servers

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

1, wenn die Anfrage erfolgreich ausgeführt wurde, oder gibt eine Fehlermeldung aus

Eins von

[0]string

[1]integer

Beispiele

Onlinesim server response example for `addMessage` request (message successfuly received)

{
  "response": 1
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

400

Bad Request

Content-Typeapplication/json

Schema

ResponseoneOf

Eins von

[0]object

responsestringErforderlich

Enumeration:ERROR_MESSAGE

messagestringErforderlich

Enumeration:ERROR_MESSAGE

Beispiele

Incorrect or missing parameters

{
  "response": "ERROR_PARAMS",
  "message": "ERROR_PARAMS"
}

Empty message context

{
  "response": "ERROR_MESSAGE",
  "message": "ERROR_MESSAGE"
}

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

Responsestring

Enumeration:Unauthorized

403

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

Content-Typeapplication/json

Schema

Responseobject

errorobjectErforderlich

statusinteger

HTTP-Antwortcode im Textformat

codestring

messagestring

Mögliche Fehlercodes: - ERROR_DISABLED - Partnerkonto ist nicht aktiviert - ERROR_IP - IP-Adresse befindet sich nicht in der Liste der erlaubten Adressen - Allowlist (siehe ) - ERROR_RENT - Konto hat keinen Zugriff auf die Miete

Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT

messagestringErforderlich

Enumeration:ERROR_DISABLEDERROR_IPERROR_RENT

detailsobject[]Erforderlich

itemsobject

404

Not Found

Content-Typetext/html

Schema

Responsestring

Beispiele

Message was filtered out by the server

NO_OPERATION

Codebeispiele

Beispiele werden generiert...