Webhook get-v2-profile-api

SMS über Webhook empfangen

Wir haben die Möglichkeit hinzugefügt, SMS an Ihren Server weiterzuleiten! Sie können die URL für den Versand in den Einstellungen Ihres Profils festlegen, und sobald eine SMS an eine Ihrer bestellten Nummern eingeht, senden wir sie an Sie.

Dies funktioniert sowohl für den Empfang als auch für die langfristige Vermietung!

Webhook

Das Schema des eingehenden Anfragekörpers mit der Nachricht ist unten im Abschnitt „Incoming payload“ beschrieben.

Sicherheit

OAuth2Berechtigungen: sms-scope, rent-scope

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim
rent-scope: grants access to renting phone numbers from Onlinesim

apikey

BearerAuth

Eingehender Payload

Erforderlich

SMS-Payload, den Onlinesim an Ihre Webhook-URL sendet

Content-Typeapplication/json

Schema

Bodyobject

user_idstring

ID Ihres Profils

country_codestring

Internationaler Telefoncode des Landes, dem die Nummer gehört, die die SMS erhalten hat

numberstring

Telefonnummer im internationalen Format

senderstring

Name oder Nummer des Absenders

messagestring

SMS-Text

time_startstring

Datum und Uhrzeit des Vorgangsbeginns

time_leftstring

Verbleibende Zeit für den Vorgang

operation_idstring

Vorgangs-ID

webhook_typeobject

Art des Dienstes (Empfang oder Miete)

Enumeration:receiving_smsrent_sms

codestring

SMS-ID

Beispiele

Example 1

Incoming SMS webhook payload

{
  "user_id": "204355",
  "country_code": "7",
  "number": "+79918397701",
  "sender": "OKru",
  "message": "текст смс",
  "time_start": "2023-04-26 12:37:55",
  "time_left": "880",
  "operation_id": "91763432",
  "webhook_type": "receiving_sms",
  "code": "612045"
}

Webhook get-v2-profile-api

Sicherheit

Eingehender Payload

Beispiele

Antwort Ihres Servers