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

Пакетно переслать полученные SMS на сервер Onlinesim

Этот запрос пересылает на сервер Onlinesim несколько входящих SMS в одном запросе.

Рекомендуется использовать его вместо addMessage и отправлять SMS пакетами, например один раз в 5 секунд.

Параметры

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

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

Content-Type*string

Заголовок Content type и кодировка

Перечисление:application/json; charset=utf-8

Тело запроса

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

Content-Typeapplication/json
Схема
schemaobject
messagesobject[]Обязательный

Массив сообщений.

teststring

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

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

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

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

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

Примеры

Example payload of your server `addMessages` request
{
  "messages": [
    {
      "number": "33712345678",
      "from": "Telegram",
      "message": "Code: 12345"
    },
    {
      "number": "33712345679",
      "from": "WhatsApp",
      "message": "Code: 56789"
    }
  ]
}

Ответы

200

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

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

1, если хотя бы одно сообщение было успешно обработано, иначе 0

Перечисление:01
totalintegerОбязательный

Общее количество обработанных записей

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

Количество успешно обработанных сообщений

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

Количество сообщений с ошибкой

resultsobject[]Обязательный

Результаты обработки по каждому сообщению

Примеры

Onlinesim server response example for `addMessages` requestexample_lines
{
  "response": "1",
  "total": 2,
  "success": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "number": "33712345678",
      "from": "Telegram",
      "response": "1"
    },
    {
      "index": 1,
      "number": "33712345679",
      "from": "WhatsApp",
      "response": "0",
      "error": "NO_OPERATION"
    }
  ]
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

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

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

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

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

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

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

Примеры кода

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