Регистрация

Модуль Link

Создание и управление короткими ссылками. С помощью функций данного модуля можно сокращать длинные URL для использования их в своих SMS рассылках.

API methods

Создание короткой ссылки
https://api.mobizon.ua/service/Link/Create

Удаление коротких ссылок
https://api.mobizon.ua/service/Link/Delete

Получение основных данных короткой ссылки
https://api.mobizon.ua/service/Link/Get

Получение коротких ссылок кампаниии
https://api.mobizon.ua/service/Link/GetLinks

Получение статистики кликов по ссылкам
https://api.mobizon.ua/service/Link/GetStats

Получение списка ссылок
https://api.mobizon.ua/service/Link/List

Редактирование данных короткой ссылки
https://api.mobizon.ua/service/Link/Update

Создание короткой ссылки

https://api.mobizon.ua/service/Link/Create

Данный метод предназначен для создания коротких ссылок.

Параметры запроса

data array – Параметры ссылки

ПараметрТипОписание
data[fullLink]stringПолная ссылка.
Ссылка, которую необходимо сократить в формате правильного URL.
Например: https://help.mobizon.com/api-docs/sms-api?utm_campaign=docs&utm_source=help&utm_medium=test#server-response-format или www.mobizon.com
data[status]integerСтатус короткой ссылки:
0 – ссылка неактивна;
1 – ссылка активна (установлено по умолчанию).
data[expirationDate]dateДата окончания действия ссылки.
Ссылка будет действовать до конца суток указанного дня в часовом поясе пользователя.
По умолчанию срок действия ссылки не ограничен.
Формат: ГГГГ-ММ-ДД.
data[comment]stringКомментарий к ссылке.
Благодаря этому полю можно легко найти короткую ссылку среди прочих.
Например: «Скидки в Черную Пятницу» или «Напоминание об отрицательном балансе».
Максимальная длина комментария – 255 символов.

Ответ сервера

array: Данные созданной короткой ссылки

ПолеТипОписание
idintegerИдентификатор ссылки.
codestringКод короткой ссылки.
shortLinkstringКороткая ссылка.

Коды ответов API

КодОписание
0Короткая ссылка успешно создана.
1Если какие-либо параметры содержат неверные значения.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'data%5BfullLink%5D=http%3A%2F%2Fmobizon.kz&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2020-10-05&data%5Bcomment%5D=%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9+%D0%BA+%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B5'
var data = "data%5BfullLink%5D=http%3A%2F%2Fmobizon.kz&data%5Bstatus%5D=1&data%5BexpirationDate%5D=2020-10-05&data%5Bcomment%5D=%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9+%D0%BA+%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B5";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/create?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'create',
    array(
        'data' => array(
            //полная ссылка
            'fullLink' => 'http://mobizon.kz',
            //статус ссылки
            'status' => '1',
            //дата окончания действия ссылки
            'expirationDate' => '2020-10-05',
            //комментарий к ссылке
            'comment' => 'Комментарий к ссылке'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Удаление коротких ссылок

https://api.mobizon.ua/service/Link/Delete

Данный метод предназначен для удаления коротких ссылок.

Параметры запроса

ПараметрТипОписание
idsarrayИдентификаторы ссылок.

Ответ сервера

Массив данных

ПолеТипОписание
processedarrayИдентификаторы удаленных ссылок.
notProcessedarrayИдентификаторы неудаленных ссылок.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567'
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/delete?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'delete',
    array(
        //идентификаторы ссылок
        'ids' => array(
            '123',
            '455',
            '567'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение основных данных короткой ссылки

https://api.mobizon.ua/service/Link/Get

Данный метод позволяет получить основные данные короткой ссылки по одному из трех ее параметров: id, code, shortLink.

В одном запросе можно получить данные только одной короткой ссылки.

Параметры запроса

Для получения необходимо передать один из параметров:

ПараметрТипОписание
idintegerИдентификатор ссылки.
codestringКод короткой ссылки.
Комбинация символов уникальная для каждой короткой ссылки.
Расположен в самом конце короткой ссылки.
Пример: http://mbz.im/mgjf, где mgif – код короткой ссылки.
shortLinkstringКороткая ссылка.
URL, созданный нашим сервисом, при переходе по которому ваши посетители будут перенаправлены на ссылку, изначально заданную вами.
Пример: http://mbz.im/mgjf.

Ответ сервера

Массив данных

ПолеТипОписание
idintegerИдентификатор ссылки.
statusintegerСтатус установленный пользователем:
0 – ссылка неактивна;
1 – ссылка активна.
moderatorStatusintegerСтатус установленный администратором:
0 – заблокирована администратором;
1 – подтверждена администратором.
clickCntintegerКоличество кликов по короткой ссылке.
createTsstringВремя создания короткой ссылки.
Формат: ГГГГ-ММ-ДД ЧЧ-ММ-СС.
moderatorStatusintegerМодераторский статус ссылки (0 – заблокирована, 1 – подтверждена).
expirationDatestringДата окончания действия короткой ссылки.
Формат: ГГГГ-ММ-ДД.
Если дата не задана – значение поля NULL.
codestringКод короткой ссылки.
fullLinkstringПолная ссылка.
shortLinkstringКороткая ссылка.
commentstringКомментарий пользователя к короткой ссылке.
Если комментарий отсутствует – значение поля NULL.
moderatorCommentstringКомментарий модератора.
Если комментарий отсутствует – значение поля NULL.

Коды ответов API

КодОписание
0Основные данные короткой ссылки успешно получены.
2Если ссылка с указанным идентификатором не найдена.
12Eсли не передан ни один из параметров.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'code=zxc'
var data = "code=zxc";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/get?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'get',
    array(
        //код короткой ссылки
        'code' => 'zxc'
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение коротких ссылок кампаниии

https://api.mobizon.ua/service/Link/GetLinks

Данный метод позволяет получить информацию и статистику списка коротких ссылок кампании.

Параметры запроса

ПараметрТипОписание
campaignIdintegerИдентификатор кампании.

Ответ сервера

Структура объекта ссылки: массив коротких ссылок, в котором каждый элемент содержит следующие поля:

ПолеТипОписание
idintegerИдентификатор короткой ссылки.
codestringКод короткой ссылки.
fullLinkstringПолная ссылка.
shortLinkstringКороткая ссылка.
clickCntintegerКоличество кликов по короткой ссылке.
redirectCntintegerКоличество переходов по короткой ссылке.
commentstringКомментарий пользователя к короткой ссылке.

Коды ответов API

КодОписание
0Короткие ссылки кампании успешно получены.
2Если кампания не найдена.

Получение статистики кликов по ссылкам

https://api.mobizon.ua/service/Link/GetStats

Данный метод предназначен для получения статистики кликов для одной или нескольких коротких ссылок по их ID.

Данные могут быть сгруппированы по месяцам, дням, часам, минутам.

Параметры запроса

ПараметрТипОписание
idsarrayИдентификаторы ссылок.
Максимальное количество ID в запросе – 5.
Синтаксис параметра: ids[] для каждого идентификатора.
typestringТип запрашиваемой статистики.
Позволяет получить данные в различные временные промежутки:
monthly – количество кликов по месяцам. Максимальный интервал для получения статистики – 3 года;
daily – количество кликов по дням. Максимальный интервал для получения статистики – 90 дней;
hourly – количество кликов по часам. Максимальный интервал для получения статистики – 1 неделя;
minute – количество кликов по минутам. Максимальный интервал для получения статистики – 3 часа.
criteriaarrayКритерии поиска (См. таблицу Критерии поиска).

Критерии поиска

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

ПараметрТипОписание
criteria[dateFrom]stringИзвлекать статистику, начиная с указанной даты и времени.
Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.
criteria[dateTo]stringИзвлекать статистику до указанной даты и времени.
Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.

Важно: если критерии поиска dateFrom и dateTo не установлены, то статистика поля type будет извлекаться за последний максимально возможный интервал.

Если установлен только один критерий dateFrom или промежуток времени между dateFrom и dateTo превышает максимально допустимый интервал, то статистика будет извлекаться за максимально допустимый интервал, начиная с даты dateFrom.

Если установлен только критерий dateTo, то статистика будет извлекаться за максимально возможный период до даты dateTo.

Ответ сервера

Массив данных:

ПолеТипОписание
itemsarrayДанные статистики.
totalsstringОбщее количество кликов за запрашиваемый период.

Коды ответов API

КодОписание
0Статистика успешно получена.
12Если указано более 5 идентификаторов ссылок или неверно указан тип статистики.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00'
var data = "ids%5B0%5D=123&ids%5B1%5D=455&ids%5B2%5D=567&type=monthly&criteria%5BdateFrom%5D=2018-01-21+13%3A30%3A00";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/getStats?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'getStats',
    array(
        //идентификаторы ссылок
        'ids' => array(
            '123',
            '455',
            '567'
        ),
        //тип статистики
        'type' => 'monthly',
        //критерии поиска
        'criteria' => array(
            'dateFrom' => '2018-01-21 13:30:00'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Получение списка ссылок

https://api.mobizon.ua/service/Link/List

Данный метод позволяет получить список созданных коротких ссылок. Поиск может быть осуществлен по ID и данным из полей короткой ссылки.

Параметры запроса

ПараметрТипОписание
criteriaarrayКритерии поиска (см. таблицу Критерии поиска).
paginationarrayПараметры постраничного вывода (см. таблицу Параметры постраничного вывода).
sortarrayПараметры сортировки (см. таблицу Параметры сортировки).

Критерии поиска

Информация о полях короткой ссылки, по которым осуществляется поиск. Для поиска можно использовать как одно поле, так и совокупность полей.

ПараметрТипОписание
criteria[status]integerПоиск по статусу короткой ссылки:
0 – ссылка неактивна;
1 – ссылка активна.
criteria[moderatorStatus]integerПоиск по статусу модерации ссылки:
0 – заблокирована;
1 – разрешена.
criteria[createTsFrom]datetimeПоиск по дате создания ссылки, начиная с указанной даты.
Формат: ГГГГ-ММ-ДД.
criteria[createTsTo]datetimeПоиск по дате и времени создания ссылки до указанной даты и времени.
Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.
criteria[query]stringПоиск по различным атрибутам ссылки.
Поиск может быть осуществлен по:
Коду короткой ссылки;
Коду отслеживания получателя;
Комментарию к короткой ссылке.

Параметры постраничного вывода

Данные параметры предназначены для структурированного (частичного) вывода запрашиваемой информации.

ПараметрТипОписание
pagination[pageSize]integerКоличество отображаемых элементов на странице (25, 50, 100).
pagination[currentPage]integerТекущая страница
Нумерация страниц начинается с 0.

Параметры сортировки

С помощью данных параметров можно отсортировать результаты поиска по одному из полей в порядке возрастания (ASC) или убывания (DESC).

Например:

Сортировка по коду короткой ссылки по возрастанию – sort[code]=ASC.
Сортировка по оригинальной ссылке по убыванию – sort[fullLink]=DESC.

ПараметрОписание
sort[createTs]Сортировка по дате и времени создания ссылки.
Формат: ГГГГ-ММ-ДД ЧЧ-ММ-СС.
sort[expirationDate]Сортировка по дате окончания действия ссылки.
Формат: ГГГГ-ММ-ДД.
sort[clickCnt]Сортировка по количеству кликов.
sort[code]Сортировка по коду короткой ссылки.
sort[fullLink]Сортировка по оригинальной ссылке.

Ответ сервера

Массив данных:

ПолеТипОписание
itemsarrayСписок найденных ссылок.
Описание полей коротких ссылок смотрите в описании метода Link/Get.
totalItemCountintegerОбщее количество найденных элементов.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC'
var data = "criteria%5Bstatus%5D=1&criteria%5BmoderatorStatus%5D=1&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BclickCnt%5D=ASC";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'list',
    array(
        //критерии поиска
        'criteria' => array(
            //только активные ссылки
            'status' => '1',
            //ссылки разрешены модератором
            'moderatorStatus' => '1'
        ),
        //параметры постраничного вывода
        'pagination' => array(
            //текущая страница
            'currentPage' => '2',
            //количество отображаемых элементов на странице
            'pageSize' => '50'
        ),
        //параметры сортировки
        'sort' => array(
            //сортировка по количеству кликов по возрастанию
            'clickCnt' => 'ASC'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Редактирование данных короткой ссылки

https://api.mobizon.ua/service/Link/Update

Данный метод позволяет изменить параметры созданной короткой ссылки.

Параметры запроса

ПараметрТипОписание
idintegerИдентификатор ссылки.
dataintegerРедактируемые параметры ссылки указаны в таблице Параметры ссылки.

Параметры ссылки

ПараметрТипОписание
data[status]integerСтатус короткой ссылки:
0 – ссылка неактивна;
1 – ссылка активна.
data[expirationDate]dateДата окончания действия короткой ссылки.
Формат: ГГГГ-ММ-ДД.
Если значение не передано – срок действия ссылки будет неограничен.
data[comment]stringКомментарий к ссылке.
Максимальная длина комментария – 255 символов.

Ответ сервера

string – Короткая ссылка.

Коды ответов API

КодОписание
0Параметры успешно изменены.
1Если какие-либо параметры содержат неверные значения.
2Если ссылка с указанным идентификатором не найдена.

Examples

curl -X POST \
  'https://api.mobizon.ua/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'id=123&data%5Bstatus%5D=0'
var data = "id=123&data%5Bstatus%5D=0";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.ua/service/link/update?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.ua');

// Вызов АПИ метода
if ($api->call(
    'link',
    'update',
    array(
        //идентификатор ссылки
        'id' => '123',
        'data' => array(
            //статус ссылки
            'status' => '0'
        )
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}