getNum

URL

https://onlinesim.io/api/getNum.php?apikey=APIKEY&service=VKcom

Делает запрос виртуального номера, создает операцию (сохраняет список параметров запроса).

Пример

  • javascript
    var settings = {
        "async": true,
        "crossDomain": true,
        "url": "https://onlinesim.io/api/getNum.php?apikey=APIKEY&service=VKcom",
        "method": "GET",
        "headers": {"accept": "application/json"}
    }
    $.ajax(settings).done(function (response) {
        console.log(response);
    });
  • php
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://onlinesim.io/api/getNum.php?apikey=APIKEY&service=VKcom",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_SSL_VERIFYHOST => false,
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_HTTPHEADER => [
            "Content-Type: application/json",
        ]
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    var_dump(json_decode($response, true));

Название параметра Параметр Тип данных Описание
service обязательный TEXT определяет сайт (сервис) от которого будет ожидаться и отображаться СМС. см. getNumbersStats
region необязательный INT Без параметра - любой регион
78 - Санкт-Петербург
77 - Москва
country необязательный INT Без параметра - 7
см. getNumbersStats
reject необязательный ARRAY Массив масок исключений, Пример: [911,912123] исключит все номера, начинающиеся на 911 и 912123.
extension необязательный INT Без параметра - 0
Продление номера.
3 или 0 - без продления.
2 - продление номера на месяц
dev_id необязательный INT id аккаунта для разработчиков ПО.
number необязательный BOOL Если передать этот параметр, запрос вернет номер.

Сервисы

Список стран и сервисов вы можете узнать через запрос см. getNumbersStats

При выборе other входящие СМС не фильтруются, поэтому, если необходимого сервиса нет в списке передавать надо имя отправителя, например, если СМС приходит от Gett, service=Gett. Со списком популярных отправителей можно ознакомится в своем аккаунте, в блоке «Все сервисы», выпадающий список рядом с кнопкой добавить.

Результат

После успешного выполнения получите ответ в формате JSON, в следующем виде:

json {response:RESPONSE, tzid:TZID}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
tzid id операции

RESPONSE

Результат Описание
EXCEEDED_CONCURRENT_OPERATIONS превышено количество одновременно заказанных номеров для Вашего аккаунта
NO_NUMBER для выбранного сервиса свободные номера временно отсутствуют
TIME_INTERVAL_ERROR отложенный прием СМС не возможен в данный интервал времени
INTERVAL_CONCURRENT_REQUESTS_ERROR превышено количество одновременных запросов на выдачу номера, повторите запрос позднее
ERROR_NO_SERVICE не указан сервис
TRY_AGAIN_LATER запрос временно не может быть выполнен
NO_FORWARD_FOR_DEFFER активация переадресации возможна только на онлайн приеме
NO_NUMBER_FOR_FORWARD нет номеров для переадресации
ERROR_LENGTH_NUMBER_FOR_FORWARD номер для переадресации имеет не верную длину
DUPLICATE_OPERATION добавление операций с одинаковыми параметрами
WARNING_LOW_BALANCE не хватает средств для покупки услуги

Тестирование

/demo/api/getNum.php?apikey=APIKEY&service=VKcom

Метод вернет сгенерированные тестовые данные. Для тестирования ошибок передайте в качестве параметра err необходимую ошибку. Например err=EXCEEDED_CONCURRENT_OPERATIONS