Документация по API личного кабинета
Введение
API личного кабинета предоставляет доступ к некоторым функциям личного кабинета, таким как работа с телефонной книгой.
Этот вид интеграции работает посредством простого вызова скрипта с нашего сервера при помощи GET-запроса.
Например, в PHP, это можно сделать так:
file_get_contents("http://lcab.sms-sending.ru/lcabApi/sendSms.php?login=ЛОГИН&password=ПАРОЛЬ&txt=привет&to=89010003333");
Ответ от сервера приходит в виде json-строки
Отправка СМС
Адрес:
http://lcab.sms-sending.ru/lcabApi/sendSms.php
Текст смс должен быть в кодировке utf-8.
К примеру, если у вас скрипты в кодировке windows-1251:
$txt = "Привет!"; $txt = iconv("cp1251","utf-8",$txt);
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
txt | Текст СМС в кодировке utf-8 | Да |
to |
Номер телефона получателя СМС. Если вы хотите отправить СМС нескольким абонентам, то укажите их номера через запятую. |
Должен быть задан либо to, либо idGroup, либо и оба. |
idGroup | id группы получателей СМС в вашей телефонной книге. | Должен быть задан либо to, либо idGroup, либо и оба. |
source | Имя отправителя | Нет. Если не задано, берется имя отправителя по-умолчанию. |
flash | Отправлять в виде Flash-СМС. Принимает значения 0 и 1. | Нет. По-умолчанию 0. |
dateTimeSend | Дата\время отправки СМС в MySQL формате ГГГГ-ММ-ДД чч:мм:сс | Нет. Если не задано, сразу ставиться в очередь. |
onlydelivery | Оплата только за доставленные. Принимает значения 0 и 1. | Нет. По-умолчанию 0. |
discountID | ID акции из раздела СМС-купон. Если вы передадите его, то обязательными параметрами станут только login, password и получатели. | Нет. |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Успешно обработано', 'colsmsOfSending' => 1, 'priceOfSending' => '10.15', )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
colsmsOfSending | Количество СМС в рассылке (если code == 1) |
priceOfSending | Стоимость рассылки (если code == 1) |
Телефонная книга>>Получение списка контактов
Адрес:
http://lcab.sms-sending.ru/lcabApi/getContacts.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
idGroup | ID группы, контакты из которой вы хотите получить | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Контакты выгружены', 'contacts' => array ( "data" => 0 => array ( 'id' => '1', 'phone' => '7900.......', 'fio' => 'Иван Иванов', 'bday' => '1980-01-01', 'sex' => 1 ), 1 => array ( ... ) ), "allCol" => 123 ) )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
contacts | Массив, содержащий список контактов |
Телефонная книга » Добавление контакта
Адрес:
http://lcab.sms-sending.ru/lcabApi/addContact.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
idGroup | id группы, в которую нужно добавить контакт. | Да |
phone | Номер телефона | Да |
f | Фамилия | Нет |
i | Имя | Нет |
o | Отчество | Нет |
bday | День рождения в формате ГГГГ-ММ-ДД. | Нет. |
sex | Пол. 1 - мужской, 2 - женский. | Нет. |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Контакт сохранен', 'id' => 1133, 'phone' => '79010003333', 'idGroup' => 1 )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
id | id контакта в телефонной книге (если code == 1) |
phone | Номер телефона в верном формате (если code == 1) |
idGroup | id группы, куда он был добавлен (если code == 1) |
Телефонная книга » Удаление контакта
Адрес:
http://lcab.sms-sending.ru/lcabApi/removeContact.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
phone | Номер телефона удаляемого контакта | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Контакт успешно удален', 'deleted' => 1 )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
deleted | Количество удаленных контактов |
Телефонная книга » Проверка контакта на существование
Адрес:
http://lcab.sms-sending.ru/lcabApi/contactExists.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
phone | Номер телефона искомого контакта | Да |
idGroup | ID группы, в которой искать контакт | Нет |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Операция завершена успешно', 'contactExists' => true, 'contacts' => array ( 0 => array ( 'id' => '135', 'idGroup' => '16', 'f' => 'Иванов', 'i' => 'Иван', 'o' => 'Иванович', 'phone' => '79010003333', 'bday' => '1982-02-15', 'sex' => '1', 'dtCreate' => '2011-10-21 14:05:36' ), 1 => array ( 'id' => '225', 'idGroup' => '21', 'f' => '', 'i' => '', 'o' => '', 'phone' => '79010003333', 'bday' => '', 'sex' => '1', 'dtCreate' => '2011-11-11 12:00:21' ) ) )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
contactExists | Найден ли контакт true|false |
contacts | Массив, содержащий найденные контакты |
Телефонная книга » Получение списка групп
Адрес:
http://lcab.sms-sending.ru/lcabApi/getGroups.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Группы выгружены', 'groups' => array ( 0 => array ( 'id' => '1', 'name' => 'Моя группа', 'count' => '3', 'createBy' => '1', 'dateCreated' => '2011-10-20 12:22:41', 'stop' => '0', 'sync' => '0', 'syncUrl' => 'http://', 'lastSync' => '0000-00-00 00:00:00' ), 1 => array ( ... ) ) )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
groups | Массив, содержащий список групп |
id | id группы |
name | Название группы |
count | Количество контактов в группе |
createBy | id пользователя, создавшего группу |
dateCreated | Дата создания группы |
stop | Является ли группа стоп-листом |
sync | Синхронизируется ли группа с каким-либо вашим внешним ресурсом |
syncUrl | Ссылка на внешний ресурс для синхронизации |
lastSync | Дата последней синхронизации |
Телефонная книга » Проверка группы на существование
Адрес:
http://lcab.sms-sending.ru/lcabApi/saveGroup.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
name | Название группы | Да |
id | ID группы | Да, при редактировании существущей группы |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Операция завершена успешно', 'id' => (int)id группы )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
id | ID сохраненной группы |
Телефонная книга » Создание-редактирование групп
Адрес:
http://lcab.sms-sending.ru/lcabApi/saveGroup.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
name | Название группы | Да |
id | ID группы | Да, при редактировании существущей группы |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Операция завершена успешно', 'id' => (int)id группы )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
id | ID сохраненной группы |
Телефонная книга » Количество контактов в группе
Адрес:
http://lcab.sms-sending.ru/lcabApi/getCount.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
idGroup | id группы, у которой нужно узнать количество содержащихся контактов | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Значение счетчика успешно получено', 'count' => '3' )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
count | Количество контактов в группе |
Данные об организации
Адрес:
http://lcab.sms-sending.ru/lcabApi/info.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Операция завершена успешно', 'account' => '583.12', 'ocode' => '8000*******', 'tarif' => 'Мой тариф', 'price' => '0.80', 'source' => array ( 0 => 'MyShop', 1 => 'Ded Moroz' ), 'receive_numbers' => array ( 0 => '7902*******', 1 => '7902*******' ) )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |
account | Состояние баланса |
ocode | Номер электронного лицевого счёта |
tarif | Название тарифного плана |
price | Цена за 1 СМС |
source | Массив, содержащий имена отправителей |
receive_numbers | Массив, содержащий список арендованных входящих номеров |
Запрос нового имени отправителя
Адрес:
http://lcab.sms-sending.ru/lcabApi/requestSource.php
Описание параметров
Параметр | Описание | Обязательный параметр |
---|---|---|
login | Ваш логин от личного кабинета | Да |
password | Ваш пароль от личного кабинета | Да |
source | Желаемое имя отправителя | Да |
Ответ сервера
array ( 'code' => 1, 'descr' => 'Запрос на подпись принят!' )
Параметр | Описание |
---|---|
code | Результат обработки |
descr | Описание результата обработки |