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,phoneFromodertextfehlt oder ist leer (inmissingaufgefü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).
application/jsonschemaobject
activationId, die Sie in GET_NUMBER zurückgegeben haben); einige Integrationen verwenden sie, um den Vorgang zu finden≥ 1Beispiel:355@ wird abgeschnitten)Beispiel:InstagramGET_NUMBER zurückgegeben)Beispiel:79088081050Your verification code is 800142PUSH_SMSEnumeration:PUSH_SMSBeispiel:PUSH_SMSapikeyBeispiele
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
application/jsonschemaobject
SUCCESSERRORBeispiel:SUCCESSstatus: ERROR)Enumeration:NO_OPBAD_SERVICEIGNOREDSERVICE_BANBANNEDBAD_REQUESTBeispiel:NO_OPmissingstring[]Bei BAD_REQUEST: die fehlenden oder leeren FelderBeispiel:[
"text"
]
BAD_REQUEST: eine lesbare BeschreibungBeispiel:Missing or empty fields: textBeispiele
Die SMS ist angenommen
{
"status": "SUCCESS"
}Kein aktiver Vorgang für diese Nummer und diesen Dienst
{
"status": "ERROR",
"error": "NO_OP"
}Der Absender ist blockiert (Banken, Zahlungssysteme usw.)
{
"status": "ERROR",
"error": "BAD_SERVICE"
}Die SMS stammt von einem anderen als dem bestellten Dienst
{
"status": "ERROR",
"error": "IGNORED"
}Der Absender ist für Ihre Integration blockiert
{
"status": "ERROR",
"error": "SERVICE_BAN"
}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
application/jsonschemaobject
ERRORBeispiel:ERRORINTERNAL_ERRORBeispiel:INTERNAL_ERRORBeispiele
Interner Fehler
{
"status": "ERROR",
"error": "INTERNAL_ERROR"
}