v2

Eine empfangene SMS weiterleiten

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

Leitet eine SMS weiter, die eine Ihrer Nummern empfangen hat. Senden Sie sie, sobald die SMS eingeht.

Die SMS wird an jeden aktiven Vorgang auf dieser Nummer übergeben, zu dessen Dienst sie passt (bei einer Miete passt jede SMS). Gibt es keinen solchen Vorgang, lautet die Antwort 404 NO_OPERATION. SMS von Absendern und mit Texten auf unserer Sperrliste werden nie weitergeleitet.

Sie können Nachrichten auf Ihrer Seite filtern (nur SMS des bestellten Dienstes senden) oder alle senden und die Filterung uns überlassen. Leiten Sie keine SMS mit vertraulichen Daten weiter, etwa Zugangsdaten Ihres Kontos auf der Website des Mobilfunkanbieters.

Um mehrere SMS auf einmal weiterzuleiten, verwenden Sie addMessages.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Content-Typeapplication/json
Schema
schemaobject
Alles von
[0]objectEine SMS, die eine Ihrer Nummern empfangen hat.
[1]object

Beispiele

sms

Eine SMS von VK

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

Antworten

200Die SMS ist angenommen
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Enumeration:1Beispiel:1

Beispiele

success

Die SMS ist angenommen

{
  "response": "1"
}
400Ungültige Anfrage:
  • ERROR_PARAMS — number fehlt oder ist keine Telefonnummer, oder from bzw. message fehlt;
  • ERROR_MESSAGE — message ist leer.
Content-Typeapplication/json
Schema
schemaobjectFehlerantwort: response und message enthalten denselben Fehlercode.
responsestringErforderlich
Fehlercode
messagestringErforderlich
Derselbe Fehlercode

Beispiele

ERROR_PARAMS

Fehlende oder ungültige Parameter

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

Leerer Nachrichtentext

{
  "response": "ERROR_MESSAGE",
  "message": "ERROR_MESSAGE"
}
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"
}
404NO_OPERATION — die Nummer hat keinen aktiven Vorgang, zu dem diese SMS passt; die SMS wird nicht weitergeleitet
Content-Typeapplication/json
Schema
schemaobjectFehlerantwort: response und message enthalten denselben Fehlercode.
responsestringErforderlich
Fehlercode
messagestringErforderlich
Derselbe Fehlercode

Beispiele

NO_OPERATION

Kein passender Vorgang

{
  "response": "NO_OPERATION",
  "message": "NO_OPERATION"
}

Codebeispiele

Beispiele werden generiert...