POST /v1/PUSH_SMS_RENT
Send SMS to Onlinesim for rent operation
WARNING
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.
WARNING
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)
Parameters
No parameters
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/jsonBodyobject
smsIdintegerRequired
Operation ID (assigned by your server)
≥ 1
Example:
355phoneFromstringRequired
Name or a phone number of a sender
Example:
InstagramphonestringRequired
Phone number with active operation, that has received the SMS
Example:
79088081050textstringRequired
Message text
Example:
Your verification code is 800142actionstringRequired
Method name, in this case PUSH_SMS
Enum:
PUSH_SMSDefault:
PUSH_SMSExample:
PUSH_SMSkeystringRequired
API key of your Onlinesim partner’s profile
servicestringRequired
Service name, for long term rental always rent
Enum:
rentExample:
rentResponses
200
Onlinesim server response
Code Samples
No code samples available