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

POST /api/resellers/addNumber

Отправить указанные номера телефона на сервер Onlinesim

Данный запрос позволяет Вам добавлять номера на сервер Onlinesim по одному, в противоположность sendNumbersOnline, который отсылает все активные номера в виде цельного списка.

Это может быть особенно полезно если Вам необходимо добавить новые номера к списку уже существующих, вместо передачи измененного списка каждый раз, когда Вы добавляете номера.

Параметры

header1
НазваниеТипОписание
Authorization*string

Смотрите подробнее тут

Тело запроса

Добавление Ваших новых номеров к списку существующих на сервер Onlinesim.

Content-Typeapplication/json
Схема
Bodyobject

Схема тела запроса

Все из
[0]object
numberstringОбязательный

Номер телефона в международном формате

country_idintegerОбязательный

Код страны (согласно списку стран)

operatorinteger

MCC + MNC коды оператора (эти коды содержатся в первых 5 цифрах IMSI)

date_startinteger

Дата и время размещения номера в формате UNIX timestamp

Формат:date-time
port_idstring

Уникальное имя порта, которое будет отображаться в нашем интерфейсе на странице управления Вашими номерами. Значение по умолчанию совпадает с номером телефона (значением параметра number)

maxLen: 100
usedstring[]
itemsstring

Список сервисов, которые нужно отметить как использованные для этого номера. Передавайте значения из столбца Service таблицы сервисов (например: vkcom, tg, google).

Сервер кэширует переданное значение примерно на неделю с момента последнего получения и использует его при включении номера. Повторная отправка запроса с этим параметром сбрасывает срок хранения и отсчет начинается заново.

Если used не передан в запросе, сервером используется предыдущее закэшированное значение (если оно есть). Чтобы очистить кэш, передайте пустой массив [].

rentintegerОбязательный

Режим аренды для этого номера:

1 - включен,

0 - выключен,

Перечисление:01
[1]object
teststring

Опциональное поле для тела запросов Reseller API v2. Может принимать одно из двух значений: test1 или test2.

Будучи равным test1 отправит запрос на сервер, но данные, переданные таким запросом не будут сохранены нашим сервером (не вызовет исполнения функции).

Если параметр будет равен test2, то сервер Onlinesim в ответе вернет тело Вашего запроса.

Может передаваться как query-параметр (для GET) или как поле в теле запроса (для POST). Оба способа эквивалентны, но одновременно использовать их не рекомендуется.

Перечисление:test1test2

Примеры

Payload example for `addNumber` from your server
{
  "number": "+46050910804",
  "country_id": 46,
  "operator": 24012,
  "date_start": 1658209063,
  "port_id": "Port1",
  "rent": 0,
  "test": "test1"
}

Ответы

200

Ответ сервера Onlinesim

Content-Typeapplication/json
Схема
Responseobject
responseoneOf

1, если запрос был выполнен успешно, либо выведет сообщение об ошибке

Одно из
[0]string
[1]integer
idinteger

Телефонные номера и их ID: id - возвращает ID для каждого номера (или присваивает ID для нового номера), либо присваивает null для удаленных номеров

Примеры

Onlinesim server response example (successfuly added new numbers)
{
  "response": 1,
  "ids": {
    "+234112233445": 1042,
    "+234112233446": 1043,
    "+234112233447": 1044
  }
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Отсутствуют или неверно указаны параметры (запрос должен содержать параметры в теле с правильными именами, как описано в документации)

Content-Typeapplication/json
Схема
Responseobject
responsestringОбязательный
Перечисление:ERROR_PARAMS
messagestringОбязательный
401

Не авторизован. В запросе отсутствует или использован некорректный API-ключ. Некоторые эндпоинты могут возвращать статус 200 с сообщением ERROR_WRONG_KEY вместо 401 — проверяйте тело ответа

Content-Typetext/plain
Схема
Responsestring
Перечисление:Unauthorized
403

Доступ запрещен. Запрос был понят сервером, но отклонён из-за недостаточных прав доступа

Content-Typeapplication/json
Схема
Responseobject
errorobjectОбязательный
statusinteger

HTTP код ответа в текстовом формате

codestring
messagestring

Возможные коды ошибок: - ERROR_DISABLED - аккаунт партнера не активирован - ERROR_IP - IP адрес не находится в списке разрешенных - allowlist (см. <поле 0="code" 1="{}" 2="Access from IP"> ) - ERROR_RENT - аккаунт не имеет доступа к аренде

Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
messagestringОбязательный
Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Обязательный
itemsobject

Примеры кода

Генерация примеров...