posthttps://{ourserver.com}/api/resellers/addMessage

POST /api/resellers/addMessage

Forward received SMS to Onlinesim server

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`	`Content type` header and encoding scheme 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-Typeapplication/json

Schema

Bodyobject

All Of

[0]object

numberoneOfRequired

Phone number in international format or number's ID

(see sendNumbersOnline server response)

One Of

[0]integer

[1]string

fromstringRequired

Name or a phone number of a sender

messagestringRequired

Message text

datestring

Date and time when SMS was received (in any format, for example in UNIX timestamp)

[1]object

teststring

Optional field for the request body of Reseller API v2. Allowed values are test1, test2.

While being assigned, test1 value will allow the request to be passed, however the data won't be saved by our server (the function will not be executed by this request).

While being assigned, test2 value will print out your request's payload in response.

Can be passed as query parameter (for GET) or as a field in request's body (for POST). Both ways are equivalent, but using them simultaneously is not recommended.

Enum:test1test2

Examples

Example payload of your server `addMessage` request

{
  "number": "+234112233445",
  "from": "VKcom",
  "message": "VKcom 111111",
  "date": "1546934787"
}

Responses

200

Onlinesim server response

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

1, if request was successful, otherwise error message will come up

One Of

[0]string

[1]integer

Examples

Onlinesim server response example for `addMessage` request (message successfuly received)

{
  "response": 1
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

400

Bad Request

Content-Typeapplication/json

Schema

ResponseoneOf

One Of

[0]object

responsestringRequired

Enum:ERROR_MESSAGE

messagestringRequired

Enum:ERROR_MESSAGE

Examples

Incorrect or missing parameters

{
  "response": "ERROR_PARAMS",
  "message": "ERROR_PARAMS"
}

Empty message context

{
  "response": "ERROR_MESSAGE",
  "message": "ERROR_MESSAGE"
}

401

Unauthorized. 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-Typetext/plain

Schema

Responsestring

Enum:Unauthorized

403

Forbidden. The request was understood but refused due to insufficient permissions

Content-Typeapplication/json

Schema

Responseobject

errorobjectRequired

statusinteger

HTTP response code in text format

codestring

messagestring

Possible error codes: - ERROR_DISABLED - partner account is not activated - ERROR_IP - IP address is not in the list of allowed addresses - allowlist (see Access from IP field) - ERROR_RENT - account has no access to rent

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

messagestringRequired

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

detailsobject[]Required

itemsobject

404

Not Found

Content-Typetext/html

Schema

Responsestring

Examples

Message was filtered out by the server

NO_OPERATION

Code Samples

Generating examples...