API-функции

Для взаимодействия с предоставляемыми нами услугами мы разработали удобный API-интерфейс.
Возможен GET или POST запрос. Если есть необходимость получения данных в формате json, добавьте дополнительный параметр для передачи данных: format=json.
Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=balance&format=json

Список всех доступных функций

Верификация номера телефона (осуществить голосовой вызов)

Url запроса:
http://phoneverify.org/api.pl?email=&password=d41d8cd98f00b204e9800998ecf8427e&id=call&phonenumber={phonenumber}&code={code}

Входные данные:
1. email - Адрес электронной почты, используемый для входа в личный кабинет.
2. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)) .
3. phonenumber - Номер телефона на который позвонить и сообщить код. Только стационарные и мобильные номера России. В формате 7XXXXXXXXXX.
4. code - Код, который вы хотите сообщить пользователю по телефону.
Длина от 3 до 4 цифровых символов. Буквенные не допускаются.

Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=call&phonenumber=790500000000&code=1234

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<status>1</status>
<queue_num>70</queue_num>
</datalist>

Пояснения к формату возвращаемых данных:

  • status - Код состояния операции
  • queue_num - Номер очереди

Верификация номера телефона (используя SMS)

Url запроса:
http://phoneverify.org/api.pl?email=&password=d41d8cd98f00b204e9800998ecf8427e&id=sendsms&cellphone={cellphone}&code={code}

Входные данные:
1. email - Адрес электронной почты, используемый для входа в личный кабинет.
2. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)) .
3. cellphone - Номер сотового телефона на который сообщить код.
Только мобильные номера России. В формате 7XXXXXXXXXX.
4. code - Код, который вы хотите сообщить пользователю в смс-сообщении.
Длина от 1 до 10 буквенно-цифровых символов.

Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=sendsms&cellphone=790500000000&code=1234

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<status>1</status>
<queue_num>70</queue_num>
</datalist>

Пояснения к формату возвращаемых данных:

  • status - Код состояния операции
  • queue_num - Номер очереди

Вывод остатка средств

Url запроса:
http://phoneverify.org/api.pl?email=&password=d41d8cd98f00b204e9800998ecf8427e&id=balance

Входные данные:
1. email - Адрес электронной почты, используемый для входа в личный кабинет.
2. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)) .

Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=balance

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<status>1</status>
<amount>70</amount>
</datalist>

Пояснения к формату возвращаемых данных:

  • status - Код состояния операции
  • amount - Сумма на счету клиента в рублях

Вывод состояния голосовой верификации номера телефона

Url запроса:
http://phoneverify.org/api.pl?email=&password=d41d8cd98f00b204e9800998ecf8427e&id=callstatus&queue={queue}

Входные данные:
1. email - Адрес электронной почты, используемый для входа в личный кабинет.
2. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)) .
3. queue - Номер очереди полученной в возвращаемых данных при верификации телефонного номера.

Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=callstatus&queue=4

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<cost>3.00</cost>
<calldate>2012-07-28 07:19:10</calldate>
<status>1</status>
<callstatus>ANSWERED</callstatus>
<code>1234</code>
<dst_phone>790500000000</dst_phone>
</datalist>

Пояснения к формату возвращаемых данных:

  • cost - Стоимость данного вызова в рублях
  • calldate - Дата вызова
  • status - Статус операции
  • callstatus - Статус совершенного вызова. Возможные варианты: FAILED - неудача, BUSY - занят, NO ANSWER - не отвечает, ANSWERED - ответили
  • code - Код, сообщенный получателю
  • dst_phone - Номер телефона, на который осуществлялся вызов

Вывод состояния SMS верификации номера телефона

Url запроса:
http://phoneverify.org/api.pl?email={email}&password={password}&id=smsstatus&queue={queue}

Входные данные:
1. email - Адрес электронной почты, используемый для входа в личный кабинет.
2. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)) .
3. queue - Номер очереди полученной в возвращаемых данных при верификации телефонного номера через SMS.

Пример:
http://phoneverify.org/api.pl?email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&id=smsstatus&queue=4

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<status>305</status>
</datalist>

Пояснения к формату возвращаемых данных:

  • status - Статус операции

Возможные коды статусов операций <status>

Код Подробное описание
1 Успешная операция
2 Не найдет идентификатор ID
200 Ошибка авторизации
201 Не достаточно средств для выполнения операции
202 Учетная запись блокирована
203 Неверный формат номера телефона
204 Неверный формат кода
205 Неверная длина кода
206 Операция уже в очереди на исполнение
207 Очередь не найдена
300 Шлюз отправки СМС не доступен
302 СМС не отправлено
304 СМС отправлено
305 СМС доставлено
306 Ошибка доставки СМС
307 Запись о СМС не найдена

Проверка номера телефона на принадлежность к городу и оператору (PhoneID)

Url запроса:
http://phoneverify.org/api.pl?&id=phoneinfo&email=&password=d41d8cd98f00b204e9800998ecf8427e&phone={7xxxxxxxxx}

Входные данные:
1. phone - Проверяемый номер в федеральном формате: 11 цифр.
2. email - Адрес электронной почты, используемый для входа в личный кабинет.
3. password - Пароль, используемый для входа в личный кабинет в MD5 хэше следующего вида: MD5(email.MD5(password)).

Пример:
http://phoneverify.org/api.pl?id=phoneinfo&email=admin@domain.ru&password=0030be4afa39965ch6da9e70ff26c638&phone=78412205035

Возвращаемые данные:
<?xml version="1.0" encoding="UTF-8"?>
<datalist>
<operator>Гостиничный.компл.Восток</operator>
<city>Тюмень</city>
<region>Тюменская область</region>
<type>3</type>
<end>2288199</end>
<start>2288100</start>
<prefix>345</prefix>
<limit>1</limit>
</datalist>

Пояснения к формату возвращаемых данных:

  • operator - Наименование оператора связи
  • city - Город
  • region - Регион
  • start - Начало диапазона
  • end - Конец диапазона
  • type - Тип телефона. 9 - сотовый, 3,4,8 - стационарный
  • prefix - Префикс кода оператора
  • limit - Имеются ограничения по количеству запросов (0-да, 1-нет)*
* - В бесплатной версии установлены ограничения – 25 запросов в 5 минут. Для получения доступа без ограничений, абонентская плата 99 руб/мес.