getState


URL

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

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

Пример

  • javascript
    var settings = {
        "async": true,
        "crossDomain": true,
        "url": "https://onlinesim.ru/api/getState.php?apikey=APIKEY",
        "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.ru/api/getState.php?apikey=APIKEY",
        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=APIKEY

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