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

POST /api/resellers/addMessages

Batch forward received SMS to Onlinesim server

This request forwards multiple incoming SMS messages to Onlinesim server in a single batch.

We recommend using this method instead of addMessage and sending SMS in batches, for example once every 5 seconds.

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 when new messages are received and you need to forward multiple SMS at once.

Content-Typeapplication/json

Schema

Bodyobject

messagesobject[]Required

Array of messages.

itemsobject

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)

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 `addMessages` request

{
  "messages": [
    {
      "number": "33712345678",
      "from": "Telegram",
      "message": "Code: 12345"
    },
    {
      "number": "33712345679",
      "from": "WhatsApp",
      "message": "Code: 56789"
    }
  ]
}

Responses

200

Onlinesim server response

Content-Typeapplication/json

Schema

Responseobject

responsestringRequired

1 if at least one message was processed successfully, otherwise 0

Enum:01

totalintegerRequired

Total number of processed entries

successintegerRequired

Number of successfully processed messages

failedintegerRequired

Number of failed messages

resultsobject[]Required

Per-message processing results

itemsobject

indexintegerRequired

Message index in input array

numberstringRequired

Phone number

fromstringRequired

Sender name or phone number

responsestringRequired

Per-message processing status

Enum:01

errorstring

"Error code:

NO_OPERATION - no active operation for the number"

Examples

Onlinesim server response example for `addMessages` request21 lines

{
  "response": "1",
  "total": 2,
  "success": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "number": "33712345678",
      "from": "Telegram",
      "response": "1"
    },
    {
      "index": 1,
      "number": "33712345679",
      "from": "WhatsApp",
      "response": "0",
      "error": "NO_OPERATION"
    }
  ]
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

400

Missing or incorred parameters (request must contain parameters in it's body with proper names as described in documentation)

Content-Typeapplication/json

Schema

Responseobject

responsestringRequired

Enum:ERROR_PARAMS

messagestringRequired

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

Code Samples

Generating examples...