Для получения информации о своих входящих сообщениях необходимо отправить HTTPS (POST и GET) запрос по адресу:
- Код: Выделить всё
http://api.comtube.ru/scripts/userinfo_api/inmsginfo.php
В дополнение к адресу необходимо передавать следующие параметры:
- username – логин пользователя. Обязательный параметр.
- type – тип возвращаемого результата: xml (по умолчанию) или html. Необязательный параметр.
- signature – подпись запроса. Обязательный параметр. Как создать подпись смотрите раздел "Создание подписи (signature)"
После отправки запроса вы получите ответ.
Обработка результата запроса
После обработки запроса возвращается XML или HTML с результатами выполнения запроса. Ниже приводится пример ответа в формате XML:
- Код: Выделить всё
<?xml version="1.0" encoding="utf-8"?>
<result>
<vmsg_read>4</vmsg_read>
<vmsg_unread>22</vmsg_unread>
<fmsg_read>4</fmsg_read>
<fmsg_unread>6</fmsg_unread>
<smsg_read>16</smsg_read>
<smsg_unread>3</smsg_unread>
<msg_read>3</msg_read>
<msg_unread>10</msg_unread>
<vmmsg_read>0</vmmsg_read>
<vmmsg_unread>0</vmmsg_unread>
<code>200</code>
<desc>OK</desc>
</result>
Поле code указывает код выполнения операции:
- 200 - успешное выполнение.
- 400 - в запросе отсутствуют требуемые параметры
- 401 - ошибка авторизации. Не указан логин пользователя
- 404 - ошибка авторизации. Некорректно сформирована подпись
- 500 - системная ошибка
Поле desc предоставляет дополнительное описание ошибки.
Поле vmsg_read указывает количество входящих прочитанных сообщений голосовой почты.
Поле vmsg_unread указывает количество входящих непрочитанных сообщений голосовой почты.
Поле fmsg_read указывает количество входящих прочитанных факсов.
Поле fmsg_unread указывает количество входящих непрочитанных факсов.
Поле smsg_read указывает количество входящих прочитанных SMS сообщений.
Поле smsg_unread указывает количество входящих непрочитанных SMS сообщений.
Поле msg_read указывает количество входящих прочитанных текстовых сообщений (на публичной странице).
Поле msg_unread указывает количество входящих непрочитанных текстовых сообщений (на публичной странице).
Поле vmmsg_read указывает количество входящих прочитанных голосовых сообщений (на публичной странице).
Поле vmmsg_unread указывает количество входящих непрочитанных голосовых сообщений (на публичной странице).
Пример отправки запроса и обработки ответа
Ниже приведен простой пример на языке программирования PHP для работы с данным API.
- Код: Выделить всё
<?php
// В этом файле находится функция для подписи параметров
include_once('common/signature.inc');
$baseurl = "http://api.comtube.ru/scripts/userinfo_api/inmsginfo.php";
// Создаем массив и заполняем его параметрами
$params = array();
$params["username"] = "mylogin";
$params["type"] = "xml";
// Создаем подпись к параметрам
$urlparams = BuildUrlParamsWithSignature($params, "mypwd");
// Формируем полный URL для обращения к серверу
$url = $baseurl . "?" . $urlparams;
// Инициализируем curl и отправляем запрос
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$data = curl_exec($ch);
curl_close($ch);
echo $data;
?>
