post PUSH_SMS (RENT)

https://{ourserver.com}/pushSmsRent
v1 rent

IMPORTANT NOTE!
URL of Onlinesim server is provided by Onlinesim partner support specialists. Please note, that the URL in the example is just a placeholder.

If you get a response with 200(OK) status, SMS can be marked in your database as successfully delivered (don't send message again).

If response is different from 200, then in 10 seconds another request with the same context should be sent, unless it's NO_OPERATION or BAD_SERVICE error.

IMPORTANT NOTE!
Request header should have utf-8 encode scheme placed in 'Content-Type'
('Content-Type': 'application/json; charset=utf-8').

Following responses with errors are possible:
NO_OPERATION / NO_OP - this error occurs when you try to push SMS for a number that has no active operation;
BAD_SERVICE - this error occurs when you try to push SMS from a service that is banned by our server (banks, payment systems, etc.);
IGNORED - this error occurs when you try to push SMS from a service that is differs from the one the client has ordered (only appears when filtration is done on our side);
SERVICE_BAN - this error occurs when you try to push SMS from the service you've blacklisted (you can add services to the blacklist, it prevents users to order your numbers for these services)

Servers

https://{ourserver.com}

Parameters

Authorization
Required

see more here

In: header
Schema:
  • string
    Example: Bearer apiKey
Content-Type
Required
`Content type` header and encoding scheme
In: header
Schema:
  • string
    Example: application/json; charset=utf-8
    Enum: application/json; charset=utf-8

Global params

Request Body

PUSH_SMS webhook: your server must send this request once an event is triggered (when the ordered number has received a message).

Content Type:
application/json
  • Schema
  • Examples
  • object
    Properties:
    • smsId
      integer
      Required
      Operation ID (assigned by your server)
      Example: 355
      >= 1
    • phoneFrom
      string
      Required
      Name or a phone number of a sender
      Example: Instagram
    • phone
      string
      Required
      Phone number with active operation, that has received the SMS
      Example: 79088081050
    • text
      string
      Required
      Message text
      Example: Your verification code is 800142
    • action
      string
      Required
      Method name, in this case `PUSH_SMS`
      Example: PUSH_SMS
      Enum: PUSH_SMS
    • key
      string
      Required
      API key of your Onlinesim partner's profile
    • service
      string
      Required
      Service name, for long term rental always `rent`
      Example: rent
      Enum: rent

Responses

200

Onlinesim server response
Titles
Content
Content Type:
application/json
  • Schema
  • Examples
  • object
    Properties:
    • status
      string
      Onlinesim server response status
      Example: SUCCESS
      Enum: SUCCESS ERROR