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

POST /api/resellers/addMessage

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

Этот запрос пересылает сообщения, которые были получены Вашими номерами на сервер Onlinesim.

Вы можете отфильтровать сообщения перед отправкой запроса (отсылать только SMS от заказанного сервиса) или отсылать все сообщения, а мы произведем фильтрацию на своей стороне.

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

Параметры

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

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

Content-Type*string

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

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

Тело запроса

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

Content-Typeapplication/json
Схема
Bodyobject
Все из
[0]object
numberoneOfОбязательный

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

(смотри ответ сервера на запрос sendNumbersOnline)

Одно из
[0]integer
[1]string
fromstringОбязательный

Имя или номер отправителя

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

Текст сообщения

datestring

Дата и время приема сообщения (в любом формате, например UNIX timestamp)

[1]object
teststring

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

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

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

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

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

Примеры

Example payload of your server `addMessage` request
{
  "number": "+234112233445",
  "from": "VKcom",
  "message": "VKcom 111111",
  "date": "1546934787"
}

Ответы

200

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

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

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

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

Примеры

Onlinesim server response example for `addMessage` request (message successfuly received)
{
  "response": 1
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Bad Request

Content-Typeapplication/json
Схема
ResponseoneOf
Одно из
[0]object
responsestringОбязательный
Перечисление:ERROR_MESSAGE
messagestringОбязательный
Перечисление:ERROR_MESSAGE

Примеры

Incorrect or missing parameters
{
  "response": "ERROR_PARAMS",
  "message": "ERROR_PARAMS"
}
Empty message context
{
  "response": "ERROR_MESSAGE",
  "message": "ERROR_MESSAGE"
}
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
404

Not Found

Content-Typetext/html
Схема
Responsestring

Примеры

Message was filtered out by the server
NO_OPERATION

Примеры кода

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