SMS an OnlineSIM senden

POSThttps://{ourserver.com}/v1/PUSH_SMS

Dies ist ein Webhook zum Senden von Nachrichten an den OnlineSIM-Server. Senden Sie ihn automatisch, wenn Ihre Nummer mit einem aktiven Vorgang eine Nachricht empfängt.

Senden Sie einen JSON-Body in UTF-8 (Content-Type: application/json). Der Vorgang wird anhand von phone gefunden; die SMS geht an den Vorgang auf dieser Nummer, dessen bestellter Dienst zu Absender und Text passt.

Wenn Sie {"status": "SUCCESS"} erhalten, kann die SMS in Ihrer Datenbank als zugestellt markiert werden (senden Sie sie nicht erneut).

Geschäftliche Fehler werden mit HTTP 200 und {"status": "ERROR", "error": "<code>"} beantwortet; sie sind endgültig, wiederholen Sie solche Anfragen nicht. Wenn die Anfrage auf Netzwerkebene fehlschlägt oder mit HTTP 500 (INTERNAL_ERROR) beantwortet wird, wiederholen Sie sie nach einer Pause (zum Beispiel 10 Sekunden).

Mögliche Fehler (die Menge hängt von der Integration ab):

  • NO_OP - auf der Nummer gibt es keinen aktiven Vorgang, oder keiner ihrer Vorgänge wurde für den Dienst bestellt, von dem die SMS stammt;
  • BAD_SERVICE - die SMS stammt von einem blockierten Absender (Banken, Zahlungssysteme usw.);
  • IGNORED - die SMS stammt von einem anderen Dienst als dem, den der Kunde bestellt hat;
  • SERVICE_BAN / BANNED - der Absender ist für Ihre Integration blockiert;
  • BAD_REQUEST - phone, phoneFrom oder text fehlt oder ist leer (in missing aufgeführt);
  • INTERNAL_ERROR (HTTP 500) - die Anfrage konnte nicht verarbeitet werden.

Anforderungs-Body

PUSH_SMS Webhook: Ihr Server sollte diese Anfrage senden, wenn das Ereignis eintritt (wenn die bestellte Nummer eine Nachricht erhalten hat).

Content-Typeapplication/json
Schema
schemaobject
smsIdinteger
Vorgangs-ID (die activationId, die Sie in GET_NUMBER zurückgegeben haben); einige Integrationen verwenden sie, um den Vorgang zu finden≥ 1Beispiel:355
phoneFromstringErforderlich
Name oder Telefonnummer des Absenders (alles nach @ wird abgeschnitten)Beispiel:Instagram
phonestringErforderlich
Telefonnummer mit aktivem Vorgang, die die SMS empfangen hat, im internationalen Format mit Landesvorwahl, nur Ziffern (wie in GET_NUMBER zurückgegeben)Beispiel:79088081050
textstringErforderlich
Text der NachrichtBeispiel:Your verification code is 800142
actionstring
Name der Methode, in diesem Fall PUSH_SMSEnumeration:PUSH_SMSBeispiel:PUSH_SMS
keystring
API-Schlüssel Ihres OnlineSIM-Partnerprofils. Die Integration wird anhand der Webhook-URL erkannt; ob der Schlüssel geprüft wird, hängt von der Integration abBeispiel:apikey

Beispiele

request

PUSH_SMS-Anfrage von Ihrem Server

{
  "smsId": 124971,
  "phoneFrom": "vk",
  "phone": "79104041216",
  "text": "Your OTP 46875",
  "action": "PUSH_SMS",
  "key": "apikey"
}

Antworten

200Antwort des OnlineSIM-Servers: Die SMS wird angenommen oder mit einem Fehlercode abgelehnt
Content-Typeapplication/json
Schema
schemaobject
statusstringErforderlich
AntwortstatusEnumeration:SUCCESSERRORBeispiel:SUCCESS
errorstring
Fehlercode (bei status: ERROR)Enumeration:NO_OPBAD_SERVICEIGNOREDSERVICE_BANBANNEDBAD_REQUESTBeispiel:NO_OP
missingstring[]Bei BAD_REQUEST: die fehlenden oder leeren FelderBeispiel:[ "text" ]
messagestring
Bei BAD_REQUEST: eine lesbare BeschreibungBeispiel:Missing or empty fields: text

Beispiele

success

Die SMS ist angenommen

{
  "status": "SUCCESS"
}
NO_OP

Kein aktiver Vorgang für diese Nummer und diesen Dienst

{
  "status": "ERROR",
  "error": "NO_OP"
}
BAD_SERVICE

Der Absender ist blockiert (Banken, Zahlungssysteme usw.)

{
  "status": "ERROR",
  "error": "BAD_SERVICE"
}
IGNORED

Die SMS stammt von einem anderen als dem bestellten Dienst

{
  "status": "ERROR",
  "error": "IGNORED"
}
SERVICE_BAN

Der Absender ist für Ihre Integration blockiert

{
  "status": "ERROR",
  "error": "SERVICE_BAN"
}
BAD_REQUEST

Ein Pflichtfeld fehlt oder ist leer

{
  "status": "ERROR",
  "error": "BAD_REQUEST",
  "missing": [
    "text"
  ],
  "message": "Missing or empty fields: text"
}
500Die Anfrage konnte nicht verarbeitet werden: Wiederholen Sie sie später
Content-Typeapplication/json
Schema
schemaobject
statusstring
Enumeration:ERRORBeispiel:ERROR
errorstring
Enumeration:INTERNAL_ERRORBeispiel:INTERNAL_ERROR

Beispiele

INTERNAL_ERROR

Interner Fehler

{
  "status": "ERROR",
  "error": "INTERNAL_ERROR"
}

Codebeispiele

Beispiele werden generiert...