Интеграции

воспользуйтесь готовой или используйте наш API

API-документация (Версия 2. Актуальная)

Старая версия API работает в штатном режиме.

Добавление заказа

Адрес

https://www.liveinform.ru/api/v2/add/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
orders обязательный JSON-массив с данными о заказе:
phone обязательный Телефон клиента в международном формате
tracking обязательный Трек-номер заказа
order_id Номер заказа внутри вашего магазина
email E-mail клиента
firstname Имя клиента
lastname Фамилия клиента
tags Метки через запятую
additional1 Дополнительное поле 1, до 255 символов
additional2 Дополнительное поле 2, до 255 символов
additional3 Дополнительное поле 3, до 255 символов
price Сумма заказа к оплате (целое значение, без валюты)
index Индекс получателя (необходимо только для Белпочты)
comment Примечание к заказу

Пример на PHP

$orders = array(
0 => array('tracking' => '12546819019192', 'phone' => '+79601234567', 'firstname' => 'Иван', 'lastname' => 'Иванов', 'order_id' => '№1235', 'email' => 'ivan.ivanov@gmail.com'),
1 => array('tracking' => '1071485698', 'phone' => '89601234568', 'firstname' => 'Петр', 'lastname' => 'Петров', 'order_id' => '№1236', 'email' => 'petr.petrov@gmail.com'),
2 => array('tracking' => 'MX270035157KZ', 'phone' => '+77771506035', 'firstname' => 'Сергей', 'lastname' => 'Сергеев', 'order_id' => '№1237', 'email' => 'serg.sergeev@gmail.com'),
3 => array('tracking' => '20400035201896', 'phone' => '+38 (067) 382-76-27', 'firstname' => 'Ирина', 'lastname' => 'Летова', 'order_id' => '№1238'),
4 => array('tracking' => '12546819019195', 'phone' => '382-76-27', 'firstname' => 'Ольга', 'lastname' => 'Павлова', 'order_id' => '№1239')
);

$ch = curl_init("https://www.liveinform.ru/api/v2/add/");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_POSTFIELDS, array('api_id' => 'API_ID', 'orders' => json_encode($orders, true)));
$body = curl_exec($ch);
curl_close($ch);

Варианты ответа

При успешном добавлении трека сервер ответит:

{
   "status": "OK", Успешный запрос
   "balance": 47.85, Текущий баланс
   "tariff": 2,  Стоимость 1 отслеживания по тарифу
   "count": 4, Количество добавленных отслеживаний
   "total": 8, Общая сумма за отслеживания
   "needed": 0, Необходимая сумма (если баланса недостаточно)
   "orders": 
   [      
      {
         "status": "ADDED",  Успешно добавлено
         "liveinform_id": 3326115 ID отслеживания
      },      
      {
         "status": "ADDED",
         "liveinform_id": 3326116
      },      
      {
         "status": "ADDED",
         "liveinform_id": 3326117
      }, 
	  {
         "status": "ADDED",
         "liveinform_id": 3326118
      },     
      {
         "status": "ERROR",  Ошибка, отслеживание не добавлено
         "error":  Массив с ошибками
         {
            "phone": Название поля
            {
               "code": "201", Код ошибки
               "text": "Неправильно введен телефон" Описание ошибки
            }
         }
      }
   ]
}

В данном случае: 100 - успешный ответ сервера, 2123 - ID отправления (на следующей строке).

Если на балансе недостаточно средств или API_ID не найден ошибки выводятся в массиве error

{
   "status": "ERROR",  Ошибка
   "error": 
   {
      "code":200,
      "text":"Неправильный api_id"
   },
   "balance": -1.6, Текущий баланс
   "tariff": 2, Стоимость 1 отслеживания по тарифу
   "count": "0", Количество успешно добавленных отслеживаний
   "total": 2, Общая сумма за отслеживания
   "needed": 3.6 Необходимая сумма (если денег недостаточно)
}

Информация об отслеживании

Адрес

https://www.liveinform.ru/api/v2/track/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
liveinform_id обязательный ID отслеживания

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "result": {
      "liveinform_id": "3210942", ID отслеживания
      "tracking": "42995918013517", Трек-номер
      "phone": "+79656007521", Телефон
      "email": "", E-mail
      "order_id": "№999", Номер заказа
      "firstname": "Иван", Имя
      "lastname": "Петров", Фамилия
      "additional1": ", Дополнительное поле 1
      "additional2": "",  Дополнительное поле 2
      "additional3": "",  Дополнительное поле 3
      "comment": "", Комментарий
      "value": "2340", Объявленная ценность
      "price": "2340", Наложенный платеж
      "currency": "руб.", Валюта
      "weight": "0.68", Вес
      "index": "420011", Индекс получателя
      "address": "Казань 11", Отделение
      "delivery": "RU", Служба доставки (RU - Почта России, EMS - EMS, CDEK - СДЭК, BX - Боксберри, NP - Нова Пошта, KZ - Казпчочта, BY - Белпочта)
      "status": "2", Статус (0 - в пути, 1 - в ПВЗ, 2 - Вручен, 3 - Возврат)
      "lastcheck": "23.01.18 16:10", Последняя индексация заказа
      "phoneinfo": { Информация об абоненте
         "country": "Россия", Страна
         "region": "Республика Татарстан", Регион
         "operator": "Билайн", Оператор
         "timezone": "3", Часовой пояс относительно UTC
         "localtime": "12:22" Местное время
      },
      "track": [
         {
            "date": "23.01.18 13:14", Дата
            "operation": "Вручение", Атрибут
            "text": "Вручение адресату", Операция
            "geo": "Казань 11", Местоположение
            "index": "420011", Индекс
            "checkdate": "23.01.18 16:10", Фактическая дата статуса  
         },
         {
            "date": "11.01.18 13:21",
            "operation": "Обработка",
            "text": "Прибыло в место вручения",
            "geo": "Казань 11",
            "index": "420011",
            "checkdate": "11.01.18 15:42",
         },
         {
            "date": "11.01.18 10:36",
            "operation": "Обработка",
            "text": "Покинуло сортировочный центр",
            "geo": "Казанский ЛПЦ",
            "index": "420300",
            "checkdate": "11.01.18 11:40",
         },
         {
            "date": "10.01.18 11:22",
            "operation": "Обработка",
            "text": "Сортировка",
            "geo": "Казанский ЛПЦ Цех Посылок",
            "index": "420306",
            "checkdate": "10.01.18 11:28",
         },
         {
            "date": "10.01.18 09:14",
            "operation": "Обработка",
            "text": "Прибыло в сортировочный центр",
            "geo": "Казанский ЛПЦ",
            "index": "420300",
            "checkdate": "10.01.18 09:27",
         },
         {
            "date": "10.01.18 00:44",
            "operation": "Обработка",
            "text": "Покинуло сортировочный центр",
            "geo": "Чебоксары Почтамт",
            "index": "428999",
            "checkdate": "10.01.18 01:23",
         },
         {
            "date": "09.01.18 17:53",
            "operation": "Обработка",
            "text": "Сортировка",
            "geo": "Чебоксары Почтамт",
            "index": "428999",
            "checkdate": "09.01.18 19:20",
         },
         {
            "date": "09.01.18 17:53",
            "operation": "Обработка",
            "text": "Прибыло в сортировочный центр",
            "geo": "Чебоксары Почтамт",
            "index": "428999",
            "checkdate": "09.01.18 19:20",
         },
         {
            "date": "09.01.18 12:41",
            "operation": "Обработка",
            "text": "Покинуло место приёма",
            "geo": "Новочебоксарск 9",
            "index": "429959",
            "checkdate": "09.01.18 19:20",
         },
         {
            "date": "09.01.18 10:15",
            "operation": "Прием",
            "text": "Единичный",
            "geo": "Новочебоксарск 9",
            "index": "429959",
            "checkdate": "09.01.18 19:20",
         }
      ],
      "messages": [ Сообщения
         {
            "id": "13404628", ID сообщения
            "date": "18.01.2018 17:11", Дата отправки
            "text": "Напоминаем, Ваш заказ находится на почте. Заберите его, пожалуйста. В посылке подарок", Текст
            "status_text": "Доставлено", Статус
            "status_reason": "", Подробный статус
            "way": "sms" Канал доставки: sms или viber
         },
         {
            "id": "13295621",
            "date": "11.01.2018 15:42",
            "text": "Заказ №999 прибыл на почту 412245: Ферма 2 м, 79А.Трек-номер: 42995918013517",
            "status_text": "Доставлено",
            "status_reason": "",
            "way": "sms"
         },
         {
            "id": "13267649",
            "date": "09.01.2018 19:19",
            "text": "Ваш заказ №999 отправлен. Трее-номер: 42995918013517",
            "status_text": "Доставлено",
            "status_reason": "",
            "way": "sms"
         }
      ],
      "calls": [
		{
			"id":"1944458", ID звонка
			"date":"11.01.2018 17:00", Дата звонка
			"text":"Здравствуйте, Иван! Ваш заказ прибыл на почту. Трек-номер мы отправили в СМС. Заберите заказ в самое ближайшее время", Текст
			"status":"Звонок исполнен полностью", Статус
			"duration":"4", Продолжительность, сек. 
		} 
	  ], Звонки
      "emails": [
		 {
			"id":"1347356", ID письма
			"date":"21.01.18 16:06", Дата
			"subject":"Прибытие BY BV175728356BY ", Тема письма
			"status":"Доставлено", Статус
			"status_date":"1516539966", Дата получения статуса
		 
		},
		{
			"id":"1347355",
			"date":"21.01.18 16:05",
			"subject":"BY start BV175728356BY ",
			"status":"Доставлено",
			"status_date":"1516539936",
			 
		}
	  ], E-mail
      "np": [ Информация о наложенном платеже
         {
            "number": "5149", Номер
            "date": "24.01.18 16:49", Дата события
            "event": "Оплата", Статус
            "indexFrom": "429959", Откуда
            "indexTo": "429959", Куда
            "summa": "2340" Сумма
         },
         {
            "number": "5149",
            "date": "23.01.18 13:14",
            "event": "Приём",
            "indexFrom": "420011",
            "indexTo": "429959",
            "summa": "2340"
         }
      ]
   }
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": [
      {
         "code": 208,
         "text": "Отслеживание не найдено"
      }
   ]
}

Редактирование заказа

Адрес

https://www.liveinform.ru/api/v2/edit/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
liveinform_id обязательный ID отслеживания
phone Телефон
tracking Трек-номер
order_id Номер заказа
email E-mail
firstname Имя
lastname Фамилия
price Сумма к оплате
comment Комментарий (примечание)
additional1 Дополнительное поле 1
additional2 Дополнительное поле 2
additional3 Дополнительное поле 3
index Индекс
status=welldone Изменение статуса заказа на "Вручен"
status=return Изменение статуса заказа на "Возврат"
status=stop Остановка отслеживания заказа
status=delete Удаление заказа
np=1 Изменить статус наложенного платежа на "Оплата"

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "fields": {
      "3326335": { ID отслеживания
         "phone": { Название поля
            "status": "ERROR", Поле не изменено, ошибка
            "error": 201, Код ошибки
            "error_text": "Неправильно введен телефон" Описание ошибки
         },
         "comment": { Название поля
            "status": "OK", Поле изменено
            "data": "Комментарий" Актуальное значение
         },
         "status": {
            "status": "OK",
            "data": "welldone"
         }
      }
   }
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "OK",
   "fields": {
      "332633005": {
         "status": "ERROR",
         "error": 208
      }
   }
}

Отправка СМС

Адрес

https://www.liveinform.ru/api/v2/sendsms/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
liveinform_id обязательный ID отслеживания. Или при рассылке на несколько номеров в JSON массиве:
[332633005,332633006]
text обязательный Текст сообщения
date Отложенная отправка. Дата в формате UNIX Timestamp
options[translit]=1 Транслитерация сообщения

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "balance": 2.25, Состояние баланса до отправки
   "count": 1, Количество отправленных СМС
   "total": 1.6 Общая стоимость
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": {
      "orders": {
         "code": 212, Код ошибки
         "text": "Отслеживание не найдено" Описание ошибки
      }
   },
   "balance": 0.65,
   "count": 0,
   "total": 0
}

Позвонить клиенту

Адрес

https://www.liveinform.ru/api/v2/sendcall/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
liveinform_id обязательный ID отслеживания. При рассылке на несколько номмеров JSON массиве:
[332633005,332633006]
text обязательный Текст звонка
date Отложенный звонок. Дата в формате UNIX Timestamp

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "balance": 30, Состояние баланса до звонка
   "count": 1, Количество отправленных звонков
   "total": 3 Общая стоимость
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": {
		{
         "code": 204, Код ошибки
         "text": "Не хватает денежных средств" Описание ошибки
		}
   },
   "balance": 0.65, Состояние баланса
   "count": 1, Количество звонков
   "total": 2, Общая сумма
   "needed": 1.35  Необходимая сумма (если баланса недостаточно)
}

Отправить E-mail

Адрес

https://www.liveinform.ru/api/v2/sendemail/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
liveinform_id обязательный ID отслеживания. При рассылке на несколько номмеров JSON массиве:
[332633005,332633006]
subject обязательный Тема письма
text обязательный Текст письма
date Отложенный звонок. Дата в формате UNIX Timestamp

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "balance": 30, Состояние баланса до рассылки
   "count": 1, Количество отправленных писем
   "total": 3 Общая стоимость
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": {
      {
         "code": 204, Код ошибки
         "text": "Не хватает денежных средств" Описание ошибки
      }
   },
   "balance": 0.65, Состояние баланса
   "count": 1, Количество писем
   "total": 2, Общая сумма
   "needed": 1.35  Необходимая сумма (если баланса недостаточно)
}

Проверка баланса

Адрес

https://www.liveinform.ru/api/v2/balance/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API

Варианты ответа

Успешный ответ:

{
   "status": "OK",
   "balance": 22149.45 Состояние баланса
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": 
   {
      "api_id": 200
   }
}

Черный список

Проверка по собственной базе невыкупленных заказов.

Адрес

https://www.liveinform.ru/api/v2/blacklist/

Методы

GET, POST

Параметры метода

Параметр Описание
api_id обязательный Уникальный идентификатор API
contact обязательный JSON-массив с телефонами или E-mail клиентов, не более 100 шт. в запросе:
["79100000000","lastname@domain.com"]

Варианты ответа

Количество найденных совпадений выводится в параметре results. В массиве blacklist выводится подробная инфорамация о возврате.

{
   "status": "OK",
   "results": 2, Количество совпадений
   "blacklist": 
   [      
      {
         "contact": "79100000000", Контакт
         "date": "24.01.18", Дата события
         "status": "Отказ адресата", Статус
         "index": "249050", Индекс
         "region": "Обнинск УКД", Отделение
         "price": "2240" Наложенный платеж
      },      
      {
         "contact": "lastname@domain.com",
         "date": "27.11.17",
         "status": "Истек срок хранения",
         "index": "625003",
         "region": "Тюмень 3",
         "price": "1910"
      }
   ]
}

Ошибка (если аккаунт с указанным API_ID не найден):

{
   "status": "ERROR",
   "error": 
   {
      "code":200,
      "text":"Неправильный api_id"
   }
}

Коды ошибок

Параметр Описание
100 Успешный ответ
200 Неправильный api_id
201 Неправильно введен телефон
202 Неправильно введен трек-номер
203 Не указан тип отслеживания
204 Не хватает денежных средств
205 Заказ с таким телефоном и трек-номером уже отслеживается
206 Неправильно введен E-mail
207 Не указан параметр "reason"
208 Отслеживание не найдено
209 Не указан текст
210 Информация по треку пока не поступало
211 Для звонков на номера РФ добавьте исходящий номер в Настройках
212 Не указан ID отслеживания
213 Заказ не найден
214 Не указан период
215 Проверьте данные
216 Нет прав на эту операцию
217 Введите данные заказа