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

POST /api/resellers/sendNumbersOnline

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

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

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

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

Параметры

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

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

Тело запроса

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

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

Content-Typeapplication/json
Схема
Bodyobject
numbersobject[]
itemsobject
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
teststring

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

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

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

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

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

Примеры

Example payload of your server `sendNumbersOnline` request21 строк
{
  "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
Схема
Responseobject
responseoneOf

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

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

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

[additionalProperties]oneOf
Одно из
[0]integer
[1]nullМожет быть null
[2]string

ID, присвоенный номеру (либо null для удаленных номеров, либо fail - это происходит при передаче номера в некорректном формате)

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

Примеры

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
Схема
Responsestring

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

Примеры

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

Примеры кода

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