get Webhook

https://{yourserver.com}/newSms
webhooks

We've added a webhook feature for you! You can set a URL in your profile settings (https://onlinesim.io/v2/profile/api) and as soon as we get SMS for any number that you've ordered, it will forwarded to you. This works for both single-service and long term rental!

Webhook

The schema of incoming payload is described in the response section.

Servers

https://{yourserver.com}

Security

Responses

200

Successful request example
Content Type:
application/json
  • Schema
  • object
    Example: {"user_id":"string","country_code":"string","number":"string","sender":"string","message":"string","time_start":"string","time_left":"string","operation_id":"string","webhook_type":"receiving_sms","code":"string"}
    Properties:
    • user_id
      string
      Your Profile's ID
      Example: "string"
    • country_code
      string
      International country code of the number, that has received SMS
      Example: "string"
    • number
      string
      Phone number in international format
      Example: "string"
    • sender
      string
      Sender's name or phone number
      Example: "string"
    • message
      string
      SMS context
      Example: "string"
    • time_start
      string
      Date and time when operation was ordered
      Example: "string"
    • time_left
      string
      Remaining time for the operation
      Example: "string"
    • operation_id
      string
      Operation ID
      Example: "string"
    • webhook_type
      any
      Type of service (single service or rent)
      Example: "receiving_sms"
      Enum: receiving_sms rent_sms
    • code
      string
      SMS ID
      Example: "string"