post PUSH_SMS (RENT)
https://{ourserver.com}/pushSmsRent
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
Content-Type
header
- stringExample:
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).
- Schema
- Examples
- objectProperties:
smsId
integerRequiredOperation ID (assigned by your server)Example:355
>= 1
phoneFrom
stringRequiredName or a phone number of a senderExample:Instagram
phone
stringRequiredPhone number with active operation, that has received the SMSExample:79088081050
text
stringRequiredMessage textExample:Your verification code is 800142
action
stringRequiredMethod name, in this case `PUSH_SMS`Example:PUSH_SMS
Enum:PUSH_SMS
key
stringRequiredAPI key of your Onlinesim partner's profileservice
stringRequiredService name, for long term rental always `rent`Example:rent
Enum:rent
Responses
200
- Schema
- Examples
- objectProperties:
status
stringOnlinesim server response statusExample:SUCCESS
Enum:SUCCESS
ERROR