posthttps://{ourserver.com}/v1/PUSH_SMS_RENT

Webhook POST /v1/PUSH_SMS_RENT

SMS an Onlinesim für Mietbetrieb senden

Wenn Sie eine Antwort mit dem Status 200(OK) erhalten haben, kann die SMS in Ihrer Datenbank als erfolgreich zugestellt markiert werden (es ist nicht erforderlich, die Anfrage erneut zu senden).

Wenn der Statuscode von 200(OK) abweicht, muss die Anfrage mit demselben Inhalt nach 10 Sekunden erneut gesendet werden (außer bei Erhalt der Fehler NO_OPERATION oder BAD_SERVICE).

Unten sind Antworten mit möglichen Fehlern beschrieben:

  • NO_OPERATION / NO_OP - Dieser Fehler tritt auf, wenn Sie versuchen, eine SMS an eine Nummer zu senden, die keinen aktiven Vorgang hat;
  • BAD_SERVICE - Dieser Fehler tritt auf, wenn Sie versuchen, eine SMS von einem Dienst zu senden, der von unserem Server blockiert wurde (Bank, Zahlungssystem, Mikrofinanzinstitut usw.);
  • IGNORED - Dieser Fehler tritt auf, wenn Sie versuchen, eine SMS von einem Dienst zu senden, der sich von dem unterscheidet, den der Kunde bestellt hat (erscheint nur, wenn die Nachrichtenfilterung auf unserer Seite erfolgt);
  • SERVICE_BAN - Dieser Fehler tritt auf, wenn Sie versuchen, eine SMS von einem Dienst zu senden, den Sie auf die schwarze Liste gesetzt haben (Sie können Dienste zur schwarzen Liste hinzufügen, was es Kunden nicht erlaubt, Ihre Nummern für den Empfang von Nachrichten von diesen Diensten zu bestellen)

Parameter

header2
NameTypBeschreibung
Authorization*string

Siehe Details hier

Content-Type*string

Header Content-Type und Kodierung

Enumeration:application/json; charset=utf-8

Anforderungs-Body

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

Content-Typeapplication/json
Schema
Bodyobject
smsIdintegerErforderlich

Vorgangs-ID (wird von Ihrem Server zugewiesen)

≥ 1
phoneFromstringErforderlich

Name oder Nummer des Absenders

phonestringErforderlich

Telefonnummer mit aktivem Vorgang, die SMS empfangen hat

textstringErforderlich

Nachrichtentext

actionstringErforderlich

Name der Methode, in diesem Fall PUSH_SMS

Enumeration:PUSH_SMSStandard:PUSH_SMS
keystringErforderlich

API-Schlüssel Ihres Onlinesim-Partnerprofils

servicestringErforderlich

Name des Dienstes. Für die Miete immer rent

Enumeration:rent

Beispiele

Example payload of your server request (for rental number)
{
  "smsId": 124980,
  "phoneFrom": "instagram",
  "phone": "4605028040",
  "text": "784958 is your secret code",
  "action": "PUSH_SMS",
  "key": "apikey",
  "service": "rent"
}

Antworten

200

Antwort des Onlinesim-Servers

Content-Typeapplication/json
Schema
Responseobject
statusstring

Status der Antwort des Onlinesim-Servers

Enumeration:SUCCESSERROR

Beispiele

Onlinesim server response example for PUSH_SMS request (for rental number)
{
  "status": "SUCCESS"
}
When pushing SMS to a number that has no active operation
NO_OP
When pushing SMS from a service that is banned by our server (banks, payment systems, etc.)
BAD_SERVICE
When pushing SMS from a service that is differs from the one the client has ordered (only appears when filtration is done on our side)
IGNORED
When pushing SMS from a service you've added to the blacklist
SERVICE_BAN
When rate limit for PUSH_SMS_RENT requests is exceeded
TOO_MANY_ATTEMPTS

Codebeispiele

Beispiele werden generiert...