Реєстрація

Модуль 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%B5%D0%BD%D1%82%D0%B0%D1%80+%D0%B4%D0%BE+%D0%BF%D0%BE%D1%81%D0%B8%D0%BB%D0%B0%D0%BD%D0%BD%D1%8F'
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%B5%D0%BD%D1%82%D0%B0%D1%80+%D0%B4%D0%BE+%D0%BF%D0%BE%D1%81%D0%B8%D0%BB%D0%B0%D0%BD%D0%BD%D1%8F";

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Якщо посилання з зазначеним ідентифікатором не знайдено.
12Якщо не переданий жоден з параметрів.

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Редаговані параметри посилання вказані в таблиці Параметри посилання.

Параметри посилання/span>

ПараметрТипОпис
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;
}