NAV undefined

Прием СМС

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

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

Run in Postman

docs in postmen

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

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 язык, не обязательный параметр. "en" - English; "ru" - Russian;

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

Значения параметра 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 выключен в профиле

Шифрование

В методах register и login параметр password передается в зашифрованном, алгоритмом RSA, виде, порядок шифрования следующий:

  1. Получить публичный ключ /api/public.pem
  2. Зашифровать пароль при помощи данного ключа;
  3. Обернуть результат в base64;

Пример кода на PHP

$key = openssl_get_publickey('key');
openssl_public_encrypt('password', $password, $key);
$password = base64_encode($password);

Регистрация - register

Регистрация нового пользователя, POST запрос, все пареметры необходимо передавать в теле запроса

Пример

https://onlinesim.ru/api/register.php

body: {
    name: name
    username: username
    email: email
    password: password
    password_confirmation: password
    dev_key: dev_key
    terms: true
}

// ajax

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/login.php",
    "method": "POST",
    "data" : {
       "username": "username",
       "password": "password",
       "name": "name",
       "email": "email",
       "password": "password",
       "password_confirmation": "password",
       "terms": true,
       "dev_key": "Ключ доступен только для разработчиков, обратитесь в тех. поддержку",
    },
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});
Название параметра Параметр Тип данных Описание
name обязательный TEXT ФИО
username обязательный TEXT имя пользователя
email обязательный TEXT email
password обязательный TEXT пароль в зашифрованном виде см. Шифрование, минимальное количество символов - 10, TEXT (строковый тип)
password_confirmation обязательный TEXT подтверждение пароля в зашифрованном виде см. Шифрование, минимальное количество символов - 10, TEXT (строковый тип)
dev_key обязательный TEXT
terms обязательный BOOL согласие с правилами сервиса, true/false - согласен/не согласен

Результат

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

json {"response":"1","active":"true"}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
active true - требуется подтверждение email адреса, false - не требуется

RESPONSE

Результат Описание
TIME_ERROR Превышено количество запросов на регистрацию
"email": [ "Поле адрес электронной почты обязательно для заполнения."],.. Указание на отсутствующие или не соответствующие данные

Авторизация - login

Пример

https://onlinesim.ru/api/login.php

body: {
    username: username
    password: password
    dev_key: dev_key
}

// ajax

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://onlinesim.ru/api/login.php",
    "method": "POST",
    "data" : {
       "username": "username",
       "password": "password",
       "dev_key": "Ключ доступен только для разработчиков, обратитесь в тех. поддержку",
    },
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
console.log(response);
});

Авторизация пользователя, получение apikey, POST запрос, все пареметры необходимо передавать в теле запроса

Название параметра Параметр Тип данных Описание
username обязательный TEXT имя пользователя
password обязательный TEXT пароль пароль в зашифрованном виде см. Шифрование
dev_key обязательный TEXT

Результат

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

json {"response":"1","active":"true"}

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке
active true - требуется подтверждение email адреса, false - не требуется

RESPONSE

Результат Описание
TIME_ERROR Превышено количество запросов на регистрацию
ERROR_ACCOUNT_NOT_ACTIVATE email адрес не подтвержден
LOGIN_ERROR Не верно введен логин или пароль
"email": [ "Поле адрес электронной почты обязательно для заполнения."],.. Указание на отсутствующие или не соответствующие данные

getServiceList

Пример

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

// ajax

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

$.ajax(settings).done(function (response) {
console.log(response);
});

Возвращает доступные для заказа сервисы, стоимость по всем видам приема, % - свободных номеров

Параметры

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

Результат

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

json [ { "id": "0", "slug": "VKcom", "title": "Вконтакте", "index": "14", "repeat": "8", "deferr": "12", "limit": "50" }, { "id": "1", "slug": "3223", "title": "Facebook", "index": "4", "repeat": "5", "deferr": "3", "limit": "50" }, ... ]

Параметр Описание
id id сервиса
slug Наименование сервиса
title Название сервиса
index Стоимость онлайн приема СМС в рублях
repeat Стоимость повторного приема СМС в рублях
deferr Стоимость отложенного приема СМС в рублях
limit Процент свободных от общего количества номеров

getNum

Пример

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

// ajax

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);
});

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

Название параметра Параметр Тип данных Описание
service обязательный TEXT определяет cайт (сервис) от которого будет ожидаться и отображаться СМС. Принимает одно из значений, можно передавать оба варианта: см. сервисы
form необязательный INT вид приема (онлайн прием — 1, отложенный прием — 3) по умолчанию 3
simoperator необязательный INT 25001 - МТС
25002 - Мегафон
25099 - Билайн
25020 - Tele2
extension необязательный INT 1 - номера с возможностью продления срока действия и повторного получения СМС
2 - номера с возможностью повторного получения СМС
3 - номера без обслуживания
0, либо не передавать параметр - любой вариант обслуживания
region необязательный INT Без параметра - любой регион
78 - Санкт-Петербург
77 - Москва
country необязательный INT Без параметра - 7 (7 - Россия, 86 - Китай)
reject необязательный ARRAY Массив масок исключений, Пример: [911,912123] исключит все номера, начинающиеся на 911* и 912123*.

Сервисы

Вариант 1 Вариант 2 Название сайта(сервиса) Китай
VKcom vk Вконтакте OK
3223 facebook Facebook OK
MailRu mailru MailRu
Odklru classmates Одноклассники
Google gmail GMail OK
Yandex yandex Yandex OK
Avito avito Avito
Youla youla Youla
Viber viber Viber
WhatsApp whatsapp WhatsApp OK
Telegram telegram Telegram OK
FastFriend drugvokrug ДругВокруг
Instagram instagram Instagram OK
WeChat wechat WeChat OK
Steam steam Steam OK
Uber uber Uber OK
Microsoft microsoft Microsoft OK
7 other Другие сайты

Дополнительные сервисы

Название сервиса Описание
unlimited_sms безлимитные сообщения

** При выборе 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

getForward

Пример


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

// ajax

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);
});

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

Название параметра Параметр Тип данных Описание
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

setForwardStatusEnable

Пример

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

// ajax

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

$.ajax(settings).done(function (response) {
console.log(response);
});

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

Параметры

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

Результат

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

json {response:RESPONSE, TZID:tzid}

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

RESPONSE

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

getState

Пример

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

// ajax

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);
});

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

Параметры

Название параметра Параметр Тип данных Описание
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 - активное сообщение

Результат

После успешного выполнения будет получен ответ в формате 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, отложенный прием — deferr)
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

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

getOperations

Пример

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

// ajax

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

$.ajax(settings).done(function (response) {
console.log(response);
});

Возвращает список и состояние всех операции.

Параметры

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

Результат

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

json [{"tzid":"219","service":"vk","number":"+79670663128","form":"index","time":1172,"response":"TZ_NUM_WAIT"},{"tzid":"220","service":"whatsapp","response":"TZ_INPOOL","form":"deferr","time":0}]

Значения параметров идентичны методу getState.

setOperationRevise

Пример

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

// ajax

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);
});

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

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

Параметры

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

Результат

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

json {response:RESPONSE, tzid:TZID}

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

setOperationOk

Пример

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

// ajax

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);
});

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

Параметры

Название параметра Параметр Тип данных Описание
tzid обязательный INT идентификатор операции
country необязательный INT Страна номера, по умолчанию 7 (7 - Россия, 86 - Китай)
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

getBalance

Пример

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

// ajax

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);
});

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

Параметры

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

Результат

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

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

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

getService

Пример

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

// ajax

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);
});

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

Параметры

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

Результат

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

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

Результат Описание
response 1, если запрос выполнен успешно, либо сообщение об ошибке;
["service","...","..."] Массив из доступных для повторного СМС сервисов. Возможные варианты:
service Название сайта(сервиса)
VKcom Вконтакте
3223 Facebook
MailRu MailRu
Odklru Одноклассники
Google GMail
Yandex Yandex
Avito Avito
Youla Youla
Viber Viber
WhatsApp WhatsApp
Telegram Telegram
FastFriend ДругВокруг
Instagram Instagram
WeChat WeChat
Steam Steam
Uber Uber
Microsoft Microsoft
7 Другие сайты

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

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

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

getServiceNumber

Пример

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

// ajax

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);
});

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

Параметры

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

Результат

После успешного выполнения будет получен ответ в формате 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

getNumRepeat

Пример

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

// ajax

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);
});

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

Параметры

Название параметра Параметр Тип данных Описание
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

forwardingList

Пример

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

// ajax

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);
});

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

Параметры

Название параметра Параметр Тип данных Описание
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://on.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 регион виртуального номера

getCallNumberList

Пример

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

// ajax

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);
});

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

Параметры

Название параметра Параметр Тип данных Описание
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://on.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 Окончание разговора

forwardingSave

Пример

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

// ajax

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

$.ajax(settings).done(function (response) {
console.log(response);
});

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

Параметры

Название параметра Параметр Тип данных Описание
id обязательный INT уникальный номер переадресации, полученный методом forwardingList
minutes необязательный INT минимальное количество минут для разговора, автоматически поддерживаемое сервисом, 0 - выключение авто-пополнения
auto необязательный BOOL true/false - установить/отключить автопродление на виртуальном номере,
forward_number необязательный INT номер телефона, на который установлена переадресация
max_minutes необязательный INT общая сумма авто-пополнений. При достижении авто-пополнение выключается. 0 - без ограничений

Результат

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

json {"response": RESPONSE}

forwardingRemove

Пример

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

// ajax

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);
});

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

Параметры

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

Результат

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

json {"response": RESPONSE}

getForwardPaymentsList

Пример

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

// ajax

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

$.ajax(settings).done(function (response) {
console.log(response);
});

Выводит список всех автоматических платежей

Параметры

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

Результат

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

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

Параметр Описание
forwardPaymentsList массив из списка платежей, и данные по каждой платежу

json {"id":10545,"forward_id":12048,"number":9811957337,"sum":13,"status":3,"created_at":"2016-12-26 12:38:04"},...

Название параметра Описание
id уникальный номер платежа
forward_id уникальный номер переадресации
number виртуальный номер, с которого установлена переадресация
sum сумма пополнения с комиссией
status текущий статус платежа:
1 - Создан
2 - Отправлен на оплату
3 - Зачислен
created_at дата и время создания платежа