Forward received SMS to Onlinesim server
POSThttps://{ourserver.com}/api/resellers/addMessage
This requests forwards messages that were received by your numbers to our server.
You can filter the messages before sending a request (send only SMS from ordered service) or send all messages, and we will filter them on our side.
You can also block all incoming SMS containing confidential or sensitive information such as SMS with credentials of private account on mobile operator's website and other SMS.
Parameters
header2
| Name | Type | Description |
|---|---|---|
Authorization* | string | see more here |
Content-Type* | string |
Enum: application/json; charset=utf-8 |
Request Body
Your server should send this request as soon as number with active operation receives the message (webhook).
Content-Type
application/jsonSchema
schemaobject
All Of
[0]object
[1]object
Examples
Example payload of your server `addMessage` request
{
"number": "+234112233445",
"from": "VKcom",
"message": "VKcom 111111",
"date": "1546934787"
}Responses
200Onlinesim server response
Content-Type
application/jsonSchema
schemaobject
responseoneOf1, if request was successful, otherwise error message will come up
Examples
Onlinesim server response example for `addMessage` request (message successfuly received)
{
"response": 1
}Incorrect key passed
[
{
"response": "ERROR_WRONG_KEY"
}
]400Bad Request
Content-Type
application/jsonSchema
schemaoneOf
One Of
[0]object
[1]object
Examples
Incorrect or missing parameters
{
"response": "ERROR_PARAMS",
"message": "ERROR_PARAMS"
}Empty message context
{
"response": "ERROR_MESSAGE",
"message": "ERROR_MESSAGE"
}401Unauthorized. The request is missing or uses an invalid API key. Some endpoints may return a 200 status with an ERROR_WRONG_KEY message instead of 401 — check the response body
Content-Type
text/plainSchema
schemastring
Enum:Unauthorized403Forbidden. The request was understood but refused due to insufficient permissions
Content-Type
application/jsonSchema
schemaobject
errorobjectRequired
messagestringRequired
Enum:ERROR_DISABLEDERROR_IPERROR_RENTdetailsobject[]Required
404Not Found
Content-Type
text/htmlSchema
schemastring
Examples
Message was filtered out by the server
NO_OPERATIONCode Samples
Generating examples...