NAV undefined

OnlineSIM API

Общее

Пример запросов

Специально для вас мы подгтовили несколько примеров для postman

Run in Postman

docs in postmen

Также мы подготовили пакеты для работы с нашим апи

PHP | JS | Python | Ruby | GO

Общее описание

https://onlinesim.ru API предоставляет Вам возможность использовать наш сервис в автоматическом режиме. Для этого необходимо получить API ключ во вкладке «Профиль пользователя» и реализовать в софте примерно следующий порядок действий:

  1. Запросить виртуальный номер, получить TZID (уникальный номер зарегистрированной операции) - метод getNum;
  2. Получить мобильный номер по TZID, ввести номер в форму подтверждения на необходимом сайте (сервисе) – метод getState;
  3. Запустить цикл, который будет проверять поступление ответа - метод getState;
  4. Если ответ верный — завершить операцию – метод setOperationOk;
  5. Если ответ не подошел — запросить уточнение – метод setOperationRevise;
  6. Завершить операцию – метод setOperationOk;

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/{METHOD_NAME}.php?PARAMETERS&apikey=YOUR_APIKEY&lang=LANGUAGE

Метод Описание
METHOD_NAME название метода из списка функций API
PARAMETERS параметры соответствующего метода API
YOUR_APIKEY ключ доступа, установленный во вкладке «Профиль пользователя».
LANGUAGE язык, не обязательный параметр. "de" - German; "en" - English; "ru" - Russian; "zh" - Chinese (Simplified);

Общие возвращаемые ответы

Значения параметра RESPONSE общие для всех методов.

json {response: RESPONSE, …, … }

Результат Описание
ACCOUNT_BLOCKED аккаунт заблокирован
ERROR_WRONG_KEY apikey неверный
ERROR_NO_KEY нет apikey
ERROR_NO_SERVICE не указан сервис
REQUEST_NOT_FOUND не указан метода API
API_ACCESS_DISABLED api выключено
API_ACCESS_IP доступ с данного ip выключен в профиле

getBalance

URL

https://onlinesim.ru/api/getBalance.php?apikey=api_key

Возвращает информацию о состоянии баланса.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getBalance.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}
$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getBalance.php?apikey=api_key",
    CURLOPT_RETURNTRANSFER => true,
));
$response = curl_exec($curl);
curl_close($curl);
var_dump(json_decode($response, true));

Параметры

Название параметра Параметр Тип данных Описание
income не-обязательный BOOLEAN если income=1, возвращает дополнительно информацию о заработке

Результат

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

json {response:RESPONSE, "balance":BALANCE, "zbalance":ZBALANCE}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
balance сумма активных средств.
zbalance сумма замороженных средств.

Прием СМС

Общее описание

Апи для заказа номеров на прием смс от сервиса

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/{METHOD_NAME}.php

Диаграмма

Workflow Diagram

getNumbersStats

URL

https://onlinesim.ru/api/getNumbersStats.php?apikey=api_key

Получение актуальной статистики по странам и количеству номеров

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getNumbersStats.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getNumbersStats.php?apikey=api_key",
    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));

Получение статистики по номерам

Параметры

Название параметра Параметр Тип данных Описание
country необязательный INT Без параметра - 7
Все страны - all
7 - Россия
380 - Украина
49 - Германия
357 - Кипр
44 - Британия
33 - Франция
1 - США
1000 - Канада
55 - Бразилия
86 - Китай
63 - Филиппины
62 - Индонезия
77 - Казахстан
996 - Киргизия
995 - Грузия
40 - Румыния
48 - Польша
420 - Чехия
371 - Латвия
372 - Эстония
43 - Австрия
373 - Молдова
998 - Узбекистан
967 - Йемен
234 - Нигерия
225 - Кот-д’Ивуар
233 - Гана
232 - Сиерре Лионе
237 - Камерун
231 - Либерия

Результат

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

json {"7":{"name":"russia", .... "services":{"0":{"count":null,"popular":true,"price":23,"id":0,"service":"Вконтакте","slug":"VKcom"},"1":{"count":22,"popular":true,"price":2,"id":1,"service":"Facebook","slug":"3223"}

Описание

Параметр Описание
name название страны
position Позиция в списке на сайте
code код страны, нужен для заказа через getNum
new если true, то страна добавлена недавно
enabled Включена ли страна
services Массив со списком доступных серви серисов

services

Параметр Описание
count Количество доступных номеров, обновляется раз в минуту
popular популярный сервис или нет
price Цена покупки
id ид для формирования списка
service название сервиса
slug slug для заказа через getNum
image: Путь к картинке

getNum

URL

https://onlinesim.ru/api/getNum.php?apikey=api_key&service=VKcom

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

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getNum.php?apikey=api_key&service=VKcom",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getNum.php?apikey=api_key&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 определяет сайт (сервис) от которого будет ожидаться и отображаться СМС. см. сервисы
simoperator необязательный INT Без параметра - любой simoperator
25001 - МТС
25002 - Мегафон
25099 - Билайн
25020 - Tele2
region необязательный INT Без параметра - любой регион
78 - Санкт-Петербург
77 - Москва
country необязательный INT Без параметра - 7
см. страны
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 добавление операций с одинаковыми параметрами

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

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

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

getState

URL

https://onlinesim.ru/api/getState.php?apikey=api_key

Возвращает состояние выбранной операции или всех заказанных операций

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getState.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getState.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid необязательный INT идентификатор операции, если нужно
message_to_code необязательный INT 1 - показывать только код из СМС, 0 - показывать СМС полностью
form необязательный INT вид приема, 1 - онлайн прием, 2 - повторный прием, 3 - отложенный прием. По умолчанию 1,3
orderby необязательный TEXT сортировка по возврастанию/убыванию asc/desc. По умолчанию asc
msg_list необязательный INT Тип списка сообщений, 1 - список, 0 - активное сообщение
clean необязательный INT 1 - не показывать сообщения по кругу, работает только при msg_list=0

Результат

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

json [{tzid:TZID, response:RESPONSE, service:SERVICE, number:NUMBER, msg:MSG, time:TIME, form:FORM, forward_status:FORWARD_STATUS, forward_number:FORWARD_NUMBER}]

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
tzid id операции
service сервис, значения такие же как в методе getNum
number выделенный виртуальный номер, в международном формате
msg код из смс
time время до завершения операции;
form вид приема (онлайн прием — index)
forward_status статус активации переадресации (от 0 - 9 см. Помощь – Статусы переадресации)
forward_number номер для переадресации
country Страна номера (7 - Россия, 86 - Китай)

RESPONSE

Результат Описание
WARNING_NO_NUMS нет подходящих номеров
TZ_INPOOL операция ожидает выделения номера
TZ_NUM_WAIT ожидается ответ
TZ_NUM_ANSWER поступил ответ
TZ_OVER_EMPTY ответ не поступил за отведенное время
TZ_OVER_OK операция завершена
ERROR_NO_TZID не указан tzid
ERROR_NO_OPERATIONS нет операций
ACCOUNT_IDENTIFICATION_REQUIRED Необходимо пройти идентификацию: для заказа мессенджера - любым способом, для переадресации - по паспорту.

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

/demo/api/getState.php?apikey=api_key

Метод вернет сгенерированные тестовые данные.

setOperationRevise

URL

https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234

Создает запрос на уточнение ответа по операции.

Следует использовать, если поступил неверный код. Данный метод отправляет запрос на другой код в случае, если поступило несколько СМС на один номер с разными кодами.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции

Результат

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

json {response:RESPONSE, tzid:TZID}

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

setOperationOk

URL

https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234

Отправляет уведомление об успешном получении кода и завершает операцию

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции
ban необязательный INT Только для китайских номеров, Можно использовать если в течении 5 минут Вам не выдан номер или не получено смс. Для блокировки номера необходимо передать 1

Результат

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

json {response:RESPONSE, tzid:TZID}

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

RESPONSE

Результат Описание
ERROR_WRONG_TZID неверный номер операции.
NO_COMPLETE_TZID невозможно завершить операцию.

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

/demo/api/setOperationOk.php?apikey=api_key&tzid=1234

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

getService

URL

https://onlinesim.ru/api/getService.php?apikey=api_key

Получение списка сервисов для повторного заказа СМС

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getService.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getService.php?apikey=api_key",
    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));

Параметры

Не требует дополнительных параметров.

Результат

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

json {response:RESPONSE, service: ["service","...","..."]}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке;
["service","...","..."] Массив из доступных для повторного СМС сервисов. Возможные варианты:
service Название сайта(сервиса)
vkcom Вконтакте
3223 Facebook
mailru MailRu
odklru Одноклассники
google Google
yandex Yandex
avito Avito
youla Youla
viber Viber
whatsapp WhatsApp
telegram Telegram
fastfriend ДругВокруг
icq ICQ
instagram Instagram
wechat WeChat
steam Steam
uber Uber
microsoft Microsoft
7 Другие сайты

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

/demo/api/getService.php?apikey=api_key

Метод вернет сгенерированные тестовые данные.

getNumRepeat

URL

https://onlinesim.ru/api/getNumRepeat.php?apikey=api_key&service=1234&number=1234

Создает запрос на повторное использование виртуального номера

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getNumRepeat.php?apikey=api_key&service=1234&number=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getNumRepeat.php?apikey=api_key&service=1234&number=1234",
    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 принимает одно из значений полученных методом getService
number обязательный INT принимает одно из значений полученных методом getServiceNumber

RESPONSE

Результат Описание
EXCEEDED_CONCURRENT_OPERATIONS превышено количество одновременных операций
NO_NUMBER для выбранного сервиса свободные номера временно отсутствуют
TIME_INTERVAL_ERROR отложенный прием СМС не возможен в данный интервал времени
INTERVAL_CONCURRENT_REQUESTS_ERROR превышено количество одновременных запросов на выдачу номера, повторите запрос позднее
ERROR_NO_SERVICE не указан сервис
ERROR_NO_NUMBER не указан номер
TRY_AGAIN_LATER запрос временно не может быть выполнен
ERROR_PARAMS не правильно указан один или оба параметра
LIFICYCLE_NUM_EXPIRED срок действия номера истек
NEED_EXTENSION_NUMBER необходимо продлить номер см. вкладку «Продление»

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

/demo/api/getNumRepeat.php?apikey=api_key&service=1234&number=1234

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

getServiceNumber

URL

https://onlinesim.ru/api/getServiceNumber.php?apikey=api_key&service=VKcom

Получает список номеров для указанного сервиса.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getServiceNumber.php?apikey=api_key&service=VKcom",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getServiceNumber.php?apikey=api_key&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 Сервис

Результат

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

json {response:RESPONSE, number:["number","...","..."]}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке;
["number","...","..."] массив из доступных для повторного СМС номеров.

RESPONSE

Результат Описание
ERROR_NO_SERVICE_REPEAT нет сервисов для повторного приема
SERVICE_TO_NUMBER_EMPTY нет номеров для повторного приема по данному сервису

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

/demo/api/getServiceNumber.php?apikey=api_key&service=VKcom

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

Переадресация

Общее описание

Апи для заказа номер на переадресацию

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/{METHOD_NAME}.php

Диаграмма

Workflow Diagram

getForward

URL

https://onlinesim.ru/api/getForward.php?apikey=api_key&forward_numbers[]=9371001010&service=unlimited_sms

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

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getForward.php?apikey=api_key&forward_numbers[]=9371001010&service=unlimited_sms",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getForward.php?apikey=api_key&forward_numbers[]=9371001010&service=unlimited_sms",
    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));
Название параметра Параметр Тип данных Описание
forward_numbers обязательный ARRAY Список номеров для переадресации. Установка приоритетов в зависимости от положения в массиве(номер в формате 9XXXXXXXXX)
service необязательный STRING unlimited_sms - безлимитные сообщения + переадресация.
forward_without_sms - переадресация без смс
region необязательный INT Без параметра - любой регион
78 - Санкт-Петербург
77 - Москва
reject необязательный ARRAY Массив масок исключений, Пример: [911,912123] исключит все номера, начинающиеся на 911* и 912123*.

Результат

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

json {response:RESPONSE, tzid:TZID}

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

RESPONSE

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

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

/demo/api/getForward.php?apikey=api_key&forward_number[]=9371001010&service=unlimited_sms

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

getState

URL

https://onlinesim.ru/api/getState.php?apikey=api_key

Возвращает состояние выбранной операции или всех заказанных операций

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getState.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getState.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid необязательный INT идентификатор операции, если нужно
message_to_code необязательный INT 1 - показывать только код из СМС, 0 - показывать СМС полностью
form необязательный INT вид приема, 1 - онлайн прием, 2 - повторный прием, 3 - отложенный прием. По умолчанию 1,3
orderby необязательный TEXT сортировка по возврастанию/убыванию asc/desc. По умолчанию asc
msg_list необязательный INT Тип списка сообщений, 1 - список, 0 - активное сообщение
clean необязательный INT 1 - не показывать сообщения по кругу, работает только при msg_list=0

Результат

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

json [{tzid:TZID, response:RESPONSE, service:SERVICE, number:NUMBER, msg:MSG, time:TIME, form:FORM, forward_status:FORWARD_STATUS, forward_number:FORWARD_NUMBER}]

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
tzid id операции
service сервис, значения такие же как в методе getNum
number выделенный виртуальный номер, в международном формате
msg код из смс
time время до завершения операции;
form вид приема (онлайн прием — index)
forward_status статус активации переадресации (от 0 - 9 см. Помощь – Статусы переадресации)
forward_number номер для переадресации
country Страна номера (7 - Россия, 86 - Китай)

RESPONSE

Результат Описание
WARNING_NO_NUMS нет подходящих номеров
TZ_INPOOL операция ожидает выделения номера
TZ_NUM_WAIT ожидается ответ
TZ_NUM_ANSWER поступил ответ
TZ_OVER_EMPTY ответ не поступил за отведенное время
TZ_OVER_OK операция завершена
ERROR_NO_TZID не указан tzid
ERROR_NO_OPERATIONS нет операций
ACCOUNT_IDENTIFICATION_REQUIRED Необходимо пройти идентификацию: для заказа мессенджера - любым способом, для переадресации - по паспорту.

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

/demo/api/getState.php?apikey=api_key

Метод вернет сгенерированные тестовые данные.

setOperationRevise

URL

https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234

Создает запрос на уточнение ответа по операции.

Следует использовать, если поступил неверный код. Данный метод отправляет запрос на другой код в случае, если поступило несколько СМС на один номер с разными кодами.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/setOperationRevise.php?apikey=api_key&tzid=1234",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции

Результат

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

json {response:RESPONSE, tzid:TZID}

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

setOperationOk

URL

https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234

Отправляет уведомление об успешном получении кода и завершает операцию

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/setOperationOk.php?apikey=api_key&tzid=1234",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции
ban необязательный INT Только для китайских номеров, Можно использовать если в течении 5 минут Вам не выдан номер или не получено смс. Для блокировки номера необходимо передать 1

Результат

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

json {response:RESPONSE, tzid:TZID}

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

RESPONSE

Результат Описание
ERROR_WRONG_TZID неверный номер операции.
NO_COMPLETE_TZID невозможно завершить операцию.

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

/demo/api/setOperationOk.php?apikey=api_key&tzid=1234

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

forwardingList

URL

https://onlinesim.ru/api/forwardingList.php?apikey=api_key

Выводит список всех переадресаций

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/forwardingList.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/forwardingList.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
id необязательный INT уникальный номер переадресации, для вывода конкретной переадресации
page необязательный INT порядковый номер страницы, по 10шт. на странице
sort необязательный TEXT сортировка, пример: {"number":"DESC","forward_number":"ASC"} 1 - имя поля для сортировки, 2 - тип сортировки (ASC,DESC)

Результат

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

json {"response": RESPONSE,"forwardingList": {"total": 17,"per_page": 10,"current_page": 1,"last_page": 2, "next_page_url": "https://onlinesim.ru/api/forwardingList.php?page=2","prev_page_url": null,"from": 1,"to": 10,"data": [......]}}

Название параметра Описание
total общее количество
current_page текущая страница
last_page всего страниц
data массив из списка переадресаций, и данные по каждой переадресации

json {response:RESPONSE, forwarding": {"id": id,"id_user": id_user,"minutes": minutes,"status": status,"id_number": id_number, "number": number,"forward_number": forward_number,"created_at": created_at,"updated_at": updated_at,"extension": extension,"data": { "balance": data,"time_update_balance": time_update_balance,"region": region}}

Название параметра Описание
id уникальный номер переадресации
id_user id пользователя
minutes остаток минут
status текущий статус переадресации:
1 - Работает
2 - Заблокирована
3 - Завершена
4 - Замена номера
5 - Отправлена на блокировку
6 - Ожидает завершения
number виртуальный номер, с которого установлена переадресация
forward_number номер телефона, на который установлена переадресация
extension автоматическое продление (true - включено, false - выключено)
balance текущий баланс на виртуальном номере
time_update_balance дата и время последнего обновления баланса
region регион виртуального номера

forwardingSave

URL

https://onlinesim.ru/api/forwardingSave.php?apikey=api_key&id=1

Изменяет параметры переадресации

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/forwardingSave.php?apikey=api_key&id=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/forwardingSave.php?apikey=api_key&id=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
id обязательный INT уникальный номер переадресации, полученный методом forwardingList
forward_number необязательный ARRAY номера телефонов, на которые установлена переадресация

Результат

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

json {"response": RESPONSE}

forwardingRemove

URL

https://onlinesim.ru/api/forwardingRemove.php?apikey=api_key&id=1

Удаляет (выключает) переадресацию

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/forwardingRemove.php?apikey=api_key&id=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/forwardingRemove.php?apikey=api_key&id=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
id обязательный INT уникальный номер переадресации, полученный методом forwardingList

Результат

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

json {"response": RESPONSE}

getCallNumberList

URL

https://onlinesim.ru/api/getCallNumberList.php?apikey=api_key&number=1234

Получение списка звонков по номеру

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getCallNumberList.php?apikey=api_key&number=1234",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getCallNumberList.php?apikey=api_key&number=1234",
    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));

Параметры

Название параметра Параметр Тип данных Описание
number обязательный INT номер
count необязательный INT Количество звонков(По умолчанию: 50)
page необязательный INT страница
order_by необязательный string тип сортировки(asc,desc)

Результат

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

json {response:RESPONSE, "list": {"total": 17,"per_page": 10,"current_page": 1,"last_page": 2, "next_page_url": "https://onlinesim.ru/api/getCallNumberList.php?page=2","prev_page_url": null,"from": 1,"to": 10,"data": [......]}}

Параметр Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
current_page Текущая страница
last_page Всего страниц
list Список звонков:

json {"id":1,"number_forward_client":456,"number_forward":789,"payment_minutes":0,"start_at":null,"stop_at":"2017-10-25 14:11:57"}

Name of parameter Description
id Уникальный ID звонка
number_forward_client Номер с которого совершен звонок
number_forward Номер на который совершена переадресация
payment_minutes Количество оплаченyых минут
created_at Начало звонка
start_at Начало разговора
stop_at Окончание разговора

setForwardStatusEnable

URL

https://onlinesim.ru/api/setForwardStatusEnable.php?apikey=api_key&tzid=1

Подтверждает переадресацию

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/setForwardStatusEnable.php?apikey=api_key&tzid=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/setForwardStatusEnable.php?apikey=api_key&tzid=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции

Результат

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

json {response:RESPONSE, TZID:tzid}

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

RESPONSE

Результат Описание
NO_CONFIRM_FORWARD переадресация не может быть подтверждена

Аренда номера

Общее описание

Апи для заказа номер на аренду

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/rent/{METHOD_NAME}.php

Диаграмма

Workflow Diagram

tariffsRent

URL

https://onlinesim.ru/api/rent/tariffsRent.php?apikey=api_key

Тарифы и другие параметры.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/tariffsRent.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/tariffsRent.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
country необязательный INT Страна, если передать параметр, то вернет только нужную страну.

Результат

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

json [7: {code: 7,enabled: true,name: "russia",new: true, days: {1: 100,7: 350,15: 600,30: 900,},position: 7,count: "1",}, ...]

Результат Описание
code Код страны
enabled true - страна доступна к заказу
name Имя страны
new true - страна добавлена недавно
days Стоймость аренды номера: {количество дней: цена, ...}
position параметр для сортировки в интерфейсе
count Количество досупных номеров {количество дней: колличество, ...}

getRentNum

URL

https://onlinesim.ru/api/rent/getRentNum.php?apikey=api_key&country=7&days=30

Получение номера

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/getRentNum.php?apikey=api_key&country=7&days=30",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/getRentNum.php?apikey=api_key&country=7&days=30",
    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));

Параметры

Название параметра Параметр Тип данных Описание
country обязательный INT страна. 7 - Россия, 77 - Казахстан, 380 - Украина
days обязательный INT Количество дней аренды. см tariffsRent
extension не-обязательный BOOLEAN автопродление по умолчанию true
pagination не-обязательный BOOLEAN пагинация сообщений, если = false - выключено

Результат

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

json {response:1, item => { checked: false,country: 7,days: 0,extend: {1: 30, 7: 210, 15: 450, 30: 900},hours: 0,messages: {current_page: 1, data: [], from: 1, last_page: 1, per_page: 20, to: 0, total: 0},number: "9313358547",reload: 0,rent: 1,status: 0,time: 19,tzid: 3715}}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
item object - rent number

rent Number

Параметр Тип Описание
checked bool подтверждение номера
country int страна, см. параметры
days int количество оставшихся дней на аренде
extend object возможные вырианты продления: {1: 30, 7: 210, 15: 450, 30: 900} см. extendRentState
hours int количество оставшихся часов на аренде
messages object сообщения см. rent Message
number str номер тефона
reload ?int перезагрузка порта. 0 - перезагрузка доступна. см. portReload
rent int общее количество купленных дней
status int 0 - номер в процессе подтверждения, 1 - номер подтвержден
time int количество оставшихся минут на аренде
tzid int id операции

rent Message

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

Параметр Тип Описание
current_page int Первая страница
data object in array массив с сообщениями, разбитый на страницы. [[{code: "sms code",created_at: "2019-12-12 10:50:43",id: 1,service: "service", text: "message"}, ...], [{...}, ...],...]
from int Первая страница
last_page int Количество страниц
per_page int Количество сообщений на странице
to int количество страниц
total int количество сообщениий

getRentState

URL

https://onlinesim.ru/api/rent/getRentState.php?apikey=api_key

Список арендованных номеров

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/getRentState.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/getRentState.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid необязательный INT id операции, если не передавать id, то метод возвращает весь список доступных оперций
pagination не-обязательный BOOLEAN пагинация сообщений, если = false - выключено

Результат

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

json {response:1, list => [..,]}

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

extendRentState

URL

https://onlinesim.ru/api/rent/extendRentState.php?apikey=api_key&tzid=1&days=30

Продление купленого номера

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/extendRentState.php?apikey=api_key&tzid=1&days=30",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/extendRentState.php?apikey=api_key&tzid=1&days=30",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT id операции
days обязательный INT Количество дней для продление номера. см. rent Number параметр extend

Результат

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

json {response:1, item => []}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
item Операция. описание смотрите в getRentNum

portReload

URL

https://onlinesim.ru/api/rent/portReload.php?apikey=api_key&tzid=1

Перезагрузка порта, данный метод работает только если у параметр reload у операции === 0 Метод можно использовать 1 раз в 5 минут.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/portReload.php?apikey=api_key&tzid=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/portReload.php?apikey=api_key&tzid=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT id операции

Результат

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

json {response:1}

closeRentNum

URL

https://onlinesim.ru/api/rent/closeRentNum.php?apikey=api_key&tzid=1&days=30

Завершить номер, Внимание этот метод полностью удаляет номер, восстановить его будет невозможно.

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/rent/closeRentNum.php?apikey=api_key&tzid=1&days=30",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/rent/closeRentNum.php?apikey=api_key&tzid=1&days=30",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT id операции

Результат

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

json {response:1}

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

Аренда прокси

Общее описание

Апи для заказа номер на аренду

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/proxy/{METHOD_NAME}.php

Диаграмма

Workflow Diagram

tariffs

URL

https://onlinesim.ru/api/proxy/tariffs.php?apikey=api_key

Список доступных тарифов для аренды

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/tariffs.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/tariffs.php?apikey=api_key",
    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));

Результат

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

json {"days":{"config":{"type": {"type","enabled","days":{...}}}, "operators: [...], "connect": [...]}, "traffic": {"config":{"country_code":{"name","cities":{"city_code":"city_name"...},"operators":["operator_code":"operator_name"]}}, "response":1}

getProxy

URL

https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&days=1&type=shared&connectType=https&operator=all

Получение прокси

Example

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&days=1&type=shared&connectType=https&operator=all",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&days=1&type=shared&connectType=https&operator=all",
    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));

Параметры

Название параметра Параметр Тип данных Описание
class не-обязательный STRING тип аренды, days или traffic, по умолчанию: days
type обязательный STRING тип. shared или sharednowait или private или privatenowait или multiport, для аренды по дня не нужен
connect обязательный STRING тип соединения. https или socks, для аренды по дня не нужен
count обязательный INT Количество дней аренды [1,7,15,30] или колличество трафика в gb [1,5,10,15]
operator не-обязательный STRING оператор, по умолчанию все. Доступы: mts,megafon,beeline,tele2
country не-обязательный STRING Страна, смотрите в Tariffs
city не-обязательный STRING Город, смотрите в Tariffs
port_count не-обязательный STRING Количество портов для Мультипорта
session не-обязательный BOOLEAN Сохранение сессии для аренды по трафику

Результат

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

json {response:1, item => {}}

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

proxy item

Параметр Тип Описание
tzid int tzid аренды
host string ip прокси
port int порт прокси
user string user
pass string пароль для прокси
change_ip bool Возможность смены ip
check_at string? Дата проверки прокси
comment string? Коментарий
connect_type string тип соединения
country int Код страны
created_at int Дата заказа
days int Количество дней аренды
hours int Количество часов аренды
rent int Количество дней аренды
ping int пинг
operator string оператор
rotate int Смена ип
status int Статус
stop_at string дата отключения
time int Время аренды
type string тип прокси
updated_at string Дата обновления

getState

URL

https://onlinesim.ru/api/proxy/getState.php?apikey=api_key

Список прокси

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/getState.php?apikey=api_key",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/getState.php?apikey=api_key",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT tzid прокси

Результат

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

json {response:1, list => [..,]}

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

changeIp

URL

https://onlinesim.ru/api/proxy/changeIp.php?apikey=api_key&tzid=1

Смена ip

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/changeIp.php?apikey=api_key&tzid=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/changeIp.php?apikey=api_key&tzid=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT tzid прокси. см. getProxy или getState

Результат

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

json {response:1}

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

changeType

URL

https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&tzid=1

Смена типа прокси https -> socks, socks -> https

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&tzid=1",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/changeType.php?apikey=api_key&tzid=1",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT tzid прокси. смю getProxy или getState

Результат

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

json {response:1, connect_type: type}

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

setComment

URL

https://onlinesim.ru/api/proxy/setComment.php?apikey=api_key&tzid=1&comment=commentproxy

Установка коментраия для прокси

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/proxy/setComment.php?apikey=api_key&tzid=1&comment=commentproxy",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/proxy/setComment.php?apikey=api_key&tzid=1&comment=commentproxy",
    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));

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT tzid прокси
comment обязательный STRING Коментраий

Результат

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

json {response:1}

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

Бесплатные номера

Общее описание

Апи для бесплатных номеров

Для того чтобы использовать API, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL: https://onlinesim.ru/api/{METHOD_NAME}.php

Диаграмма

Workflow Diagram

getFreeCountryList

URL

https://onlinesim.ru/api/getFreeMessageList

Список стран для беслатных номеров

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getFreeMessageList",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getFreeMessageList",
    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));

Результат

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

json {response: 1, countries: [{country: 1,country_text: "english"}, {country: 7,country_text: "russia"}, {country: 46,country_text: "english"}]}

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

getFreePhoneList

URL

https://onlinesim.ru/api/getFreePhoneList?country=7

Список бесплатных номеров

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getFreePhoneList?country=7",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getFreePhoneList?country=7",
    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));

Параметры

Название параметра Параметр Тип данных Описание
country необязательный INT Страна номера, по умолчанию 7 (7 - Россия, 86 - Китай)

Результат

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

json {response:RESPONSE, numbers:[]}

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

getFreeMessageList

URL

https://onlinesim.ru/api/getFreeMessageList?cpage=1&phone=+46700000000

Список бесплатных сообщений

Пример

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/getFreeMessageList?cpage=1&phone=+46700000000",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://onlinesim.ru/api/getFreeMessageList?cpage=1&phone=+46700000000",
    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));

Параметры

Название параметра Параметр Тип данных Описание
phone обязательный TEXT номер телефона в формате +7...
page необязательный INT Страница

Результат

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

json {response:RESPONSE, messages:[]}

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