post GET_NUMBER
https://{yourserver.com}/getNumber
Запрос для заказа номера для приема SMS от указанного сервиса.
Данный запрос отправляется на Ваш сервер для заказа номера на 15 минут с указанными параметрами для получения SMS от одного сервиса.
Операция может быть закрыта досрочно (смотри FINISH_ACTIVATION).
ВАЖНО!
Ваш сервер должен выдать номер с заказанными параметрами в течение 10 секунд после получения запроса. Если по истечению этого времени номер не будет выдан, текущий запрос автоматически отменяется.
ВАЖНО!
Как упоминалось в описании, Вам необходимо будет реализовать функционал по исключению масок номеров. Опциональный параметрexceptionPhoneSet
может содержать массив с набором масок для исключений. При их наличии (когда параметр передается), Ваш сервер должен исключить из выдачи номера с масками, совпадающими в этом наборе.
Например, при переданном значении [46950] не должны выдаваться номера Швеции, начинающиеся с +46950*
ВАЖНО!
Номера используемые в одной операции не могут быть использованы в другой до тех пор, пока предыдущая операция не будет завершена (пока не получен запрос FINISH_ACTIVATION).
Parameters
Content-Type
header
- stringПример:
"application/json; charset=utf-8"
Перечисление:application/json; charset=utf-8
Тело запроса
- Schema
- Examples
- objectПример:
{"action":"GET_NUMBER","country":"germany","operator":"any","service":"facebook","sum":40,"key":"string","exceptionPhoneSet":[46950]}
Свойства:action
stringОбязательныйИмя метода, в данном случае `GET_NUMBER`Пример:"GET_NUMBER"
Перечисление:GET_NUMBER
country
stringОбязательныйНазвание страны, enum (смотри список стран)
Пример:"germany"
operator
stringОбязательныйНазвание оператора (для примеров смотри список операторов)
Пример:"any"
service
stringОбязательныйНазвание сервиса, enum (смотри список сервисов)
Пример:"facebook"
sum
numberОбязательныйЦена сервиса, в рублях (эта сумма будет начислена на Ваш аккаунт партнера Onlinesim при успешном завершении операции)Пример:40
key
stringОбязательныйAPI ключ Вашего профиля партнера OnlinesimПример:"string"
exceptionPhoneSet
array<integer>Список префиксов-исключений для масок номеров, которые НЕ должны выдаваться при запросе номера. Формат: код страны + следующие за ним цифры номера.
Пример:[46950]
Items:- integerПример:
46950
Ответы
200
Ответ Вашего сервера на запрос GET_NUMBER должен быть в следующем формате:
Content-Type
- stringПример:
"application/json; charset=utf-8"
Перечисление:application/json; charset=utf-8
- Schema
- Examples
- objectПример:
{"number":79088081050,"activationId":355,"status":"SUCCESS"}
Свойства:number
integerНомер телефона в международном формате, согласно указанным в запросе параметрамПример:79088081050
activationId
integerID операции (присваивается Вашим сервером)Пример:355
>= 1
status
stringСтатус выполнения запроса (`SUCCESS` или `ERROR`)Пример:"SUCCESS"
Перечисление:SUCCESS
ERROR