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

POST /api/resellers/addNumbers

Add multiple phone numbers to the existing list

This request allows you to add new numbers the list of existing ones to the Onlinesim server in bulk.

Parameters

header1

Name	Type	Description
`Authorization`*	`string`	see more here

Request Body

Content-Typeapplication/json

Schema

Bodyobject

numbersobject[]

itemsobject

numberstring

Number in international format (with + sign)

country_idinteger

Country code (according to countries list)

≥ 1

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[]

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

The server caches the passed value for about a week from the last retrieval and uses it when the number is enabled. Re-sending the request with this parameter resets the cache expiration and starts the countdown again.

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

itemsstring

rentinteger

Rent mode for this number:

1 - enabled,

0 - disabled

Enum:01

operatorinteger

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

date_startinteger

Date and time of placement (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

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

Onlinesim server response example (successfuly added few numbers, others were passed with incorrect country code)

{
  "response": 1,
  "ids": {
    "234112233445": 1042,
    "234112233446": 1043,
    "234112233447": "fail"
  }
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

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...