Phone Number Location

Запросы к API

Для вызова метода API, Вам необходимо осуществить POST или GET запрос по протоколу HTTPS на URL сформированный по принципу: https://pnl.ruvx.org/{token}/{method}?{params} Пример:

https://pnl.ruvx.org/123456789:SGVAXD_wGRBUYGF7KvLGtnEZ-S0aqmMxVG0/getMe

token – токен доступа
method – название метода из списка методов API
params – параметры соответствующего метода API

Мы поддерживаем два способа передачи параметров в запросах:

URL query string
application/x-www-form-urlencoded

Ответ содержит объект JSON, который всегда имеет логическое поле ok. Если ok равно true, запрос был выполнен успешно, и результат запроса можно найти в поле result. В случае неудачного запроса ok равно false, тогда описание ошибки будет находится в поле description, а код ошибки в поле error_code.

Все методы API чувствительны к регистру.
Все запросы должны быть в кодировке UTF-8.

Доступные типы

PhoneInfo

Этот объект описывает параметры информации о номере телефона или префиксе

Параметр	Тип	Описание
place	Place	Местоположение
operator	Operator	Оператор, может быть NULL

Place

Этот объект описывает параметры места

Параметр	Тип	Описание
continent	Continent	Континент
country	Country	Страна
district	District	Округ
region	Region	Регион
area	Area	Район
city	City	Населенный пункт
location	Location	Гео позиция
timezone_min	Timezone	Минимальная временная зона
timezone_max	Timezone	Максимальная временная зона

Operator

Этот объект описывает параметры оператора

Параметр	Тип	Описание
id	Integer	ID оператора
title	String	Наименование оператора

Continent

Этот объект описывает параметры континента

Параметр	Тип	Описание
id	Integer	ID континента
alpha2	String	Код континента
title	String	Название континента

Country

Этот объект описывает параметры страны

Параметр	Тип	Описание
id	Integer	ID страны
continent_id	Integer	ID континента
alpha2	String	Код страны
title	String	Название страны

District

Этот объект описывает параметры округа

Параметр	Тип	Описание
id	Integer	ID округа
country_id	Integer	ID страны
title	String	Название округа

Region

Этот объект описывает параметры региона

Параметр	Тип	Описание
id	Integer	ID региона
district_id	Integer	ID округа, может быть NULL
country_id	Integer	ID страны
alpha3	String	Код региона
title	String	Название региона

Area

Этот объект описывает параметры района

Параметр	Тип	Описание
id	Integer	ID района
region_id	Integer	ID региона
country_id	Integer	ID страны
title	String	Название района

City

Этот объект описывает параметры населенного пункта

Параметр	Тип	Описание
id	Integer	ID населенного пункта
area_id	Integer	ID района
region_id	Integer	ID региона
country_id	Integer	ID страны
title	String	Название населенного пункта

Location

Этот объект описывает параметры гео позиции

Параметр	Тип	Описание
longitude	Float	Долгота
latitude	Float	Широта

Timezone

Этот объект описывает параметры временной зоны

Параметр	Тип	Описание
id	String	Идентификатор "tz" часового пояса, например, "Europe/Moscow" или "Australia/Sydney". Эти идентификаторы указаны в Базе данных часовых поясов IANA, которая также имеется в доступном для поиска формате в Списке часовых поясов базы данных tz в Википедии.
offset	Integer	Смещение от UTC (в секундах) для данного местоположения. С учетом перехода на летнее время.

User

Этот объект описывает параметры пользователя

Параметр	Тип	Описание
id	Integer	ID пользователя
first_name	String	Имя пользователя
last_name	String	Фамилия пользователя, может быть NULL

Доступные методы

getMe

Метод возвращает информацию о пользователе. В случае успеха будет возвращен объект User.

getPhoneInfo

Метод возвращает информацию о номере телефона. В случае успеха возвращается объект PhoneInfo.

Параметры	Тип	Обязательный	Описание
phone	Integer или String	Да	Номер телефона. Допускаются только цифры. Длина значения от 2 до 16 символов