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

POST /api/resellers/sendNumbersOnline

Send phone numbers in bulk to Onlinesim server list

In this request all numbers available for sale should be passed. This request should be sent to Onlinesim server every 5 minutes (to ensure that your server is up and running) and after any change in the number list: after adding new numbers or removing any of previously passed ones.

However, there is another way: you can send checkWork request every 5 minutes (as confirmation that your server is up and running), and use addNumber and removeNumber to add or delete numbers respectively.

If your server is not confirmed to be up and running (via sendNumbersOnline or checkWork) within 10 minutes, the system will consider your server unavailable and automatically remove all your numbers from issuing.

Parameters

header1
NameTypeDescription
Authorization*string

see more here

Request Body

Your server should send this request every 5 minutes as a confirmation of uptime or when the list of available numbers is changed

(when new numbers are added or previously passed ones are removed).

Content-Typeapplication/json
Schema
Bodyobject
numbersobject[]
itemsobject
numberstringRequired

Phone number in international format

country_idintegerRequired

Country code (according to countries list)

operatorinteger

MCC + MNC operator code (first 5 digits of IMSI)

date_startinteger

Date and time of the start of the phone number placement in UNIX timestamp format

Format:date-time
port_idstring

Unique port name, this name will be displayed in our interface on your personal web-page. Unless specified defaults to phone number value (value of number parameter)

maxLen: 100
usedstring[]
itemsstring

List of services to mark this number as used. Pass values from the Service column of the services table (e.g. vkcom, tg, google).

Server caches this value for about a week from the last time it was passed and uses it when the number is activated. Any repeated request with this parameter resets the cache and starts a new countdown.

If used is not passed in the request, server will use previously cached value (if any). To clear the cache, pass an empty array [].

rentintegerRequired

Rent mode for this number:

1 - enabled,

0 - disabled

Enum:01
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 `sendNumbersOnline` request21 lines
{
  "numbers": [
    {
      "number": "+234112233445",
      "country_id": 234
    },
    {
      "number": "+234112233446",
      "country_id": 234,
      "operator": 28967,
      "date_start": 1543907600
    },
    {
      "number": "+234112233447",
      "country_id": 234,
      "operator": 28967,
      "date_start": 1543907600,
      "port_id": "Port1"
    }
  ]
}

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
idsobject

Object where keys are phone numbers (in international format, e.g. "+234112233445") and values are the corresponding IDs assigned by the server

[additionalProperties]oneOf
One Of
[0]integer
[1]nullNullable
[2]string

ID assigned to the number (or null for removed numbers, or fail — this occurs when a number is passed in an incorrect format)

Enum:fail

Examples

Successful Onlinesim server response example
{
  "response": 1,
  "ids": {
    "+234112233445": 1042,
    "+234112233446": 1043,
    "+234112233447": 1044
  }
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Bad Request

Content-Typetext/html
Schema
Responsestring

Error description

Examples

Incorrect format number passed
NUMBER_FORMAT_ERROR
date_start format error
ERROR_DATE
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...