SMS an OnlineSIM für einen Mietvorgang senden

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

Derselbe Webhook wie PUSH_SMS, gesendet an dieselbe URL: Ein service-Wert, der mit rent beginnt, leitet die SMS an den Mietvorgang auf phone. Die Unterstützung der Miete hängt von der Integration ab.

Die erste SMS bestätigt die Miete. Eine SMS von einem blockierten Absender (Banken, Zahlungssysteme usw.) wird dem Kunden anstelle des Textes als Hinweis angezeigt und bestätigt die Miete nicht.

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 Mietvorgang;
  • SERVICE_BAN / BANNED - der Absender ist blockiert (die SMS kann dem Kunden trotzdem als Hinweis angezeigt werden);
  • INTERNAL_ERROR (HTTP 500) - die Anfrage konnte nicht verarbeitet werden.

Anforderungs-Body

PUSH_SMS-Webhook für eine Mietnummer: Ihr Server muss diese Anfrage senden, sobald ein Ereignis eintritt (wenn die gemietete Nummer eine Nachricht empfangen hat).

Content-Typeapplication/json
Schema
schemaobject
smsIdinteger
Vorgangs-ID (die activationId, die Sie in GET_NUMBER zurückgegeben haben)≥ 1Beispiel:355
phoneFromstringErforderlich
Name oder Telefonnummer des Absenders (alles nach @ wird abgeschnitten)Beispiel:Instagram
phonestringErforderlich
Gemietete Telefonnummer, die die SMS empfangen hat, im internationalen Format mit Landesvorwahl, nur Ziffern (wie in GET_NUMBER zurückgegeben)Beispiel:79088081050
textstringErforderlich
NachrichtentextBeispiel: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
servicestringErforderlich
Kennzeichnet die SMS als Miet-SMS: jeder Wert, der mit rent beginnt, z. B. rentBeispiel:rent

Beispiele

request

PUSH_SMS-Anfrage von Ihrem Server (für eine gemietete Nummer)

{
  "smsId": 124980,
  "phoneFrom": "instagram",
  "phone": "4605028040",
  "text": "784958 is your secret code",
  "action": "PUSH_SMS",
  "key": "apikey",
  "service": "rent"
}

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_OPSERVICE_BANBANNEDBeispiel:NO_OP

Beispiele

success

Die SMS ist angenommen

{
  "status": "SUCCESS"
}
NO_OP

Kein aktiver Mietvorgang für diese Nummer

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

Der Absender ist blockiert

{
  "status": "ERROR",
  "error": "SERVICE_BAN"
}
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

Codebeispiele

Beispiele werden generiert...