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

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

В этом запросе следует передавать все доступные для продажи номера. Данный запрос должен отправляться на сервер Onlinesim каждые 5 минут (для подтверждения аптайма Вашего сервера) и после каждого изменения списка номеров: после добавления новых номеров или удаления каких-либо ранее переданных.

Однако, есть альтернативный вариант: для подтверждения аптайма, Вы можете воспользоваться запросом checkWork, а для добавления и удаления номеров - запросами addNumber и removeNumber соответственно.

При отсутствии подтверждения аптайма (через sendNumbersOnline или checkWork) Вашего сервера в течение 10 минут система посчитает Ваш сервер недоступным и автоматически выведет все Ваши номера из выдачи.

Параметры

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

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

Тело запроса

Ваш сервер должен посылать данный запрос каждые 5 минут в качестве подверждения аптайма, либо при изменении списка доступных номеров

(при добавлении новых номеров или удалении каких-либо, ранее переданных).

Content-Typeapplication/json
Схема
schemaobject
numbersobject[]
teststring

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

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

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

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

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

Примеры

Example payload of your server `sendNumbersOnline` requestexample_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"
    }
  ]
}

Ответы

200

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

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

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

idsobject

Объект, где ключи — это номера телефонов (в международном формате, например, "+234112233445"), а значения — соответствующие ID, присвоенные сервером

Примеры

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

Ошибка 400

Content-Typetext/html
Схема
schemastring

Описание ошибки

Примеры

Incorrect format number passed
NUMBER_FORMAT_ERROR
date_start format error
ERROR_DATE
401

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

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

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

Content-Typeapplication/json
Схема
schemaobject
errorobjectОбязательный
messagestringОбязательный
Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Обязательный

Примеры кода

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