JSON-протокол
Введение
API личного кабинета предоставляет доступ к некоторым функциям личного кабинета, таким как работа с телефонной книгой.
Этот вид интеграции работает посредством простого вызова скрипта с нашего сервера при помощи GET-запроса илиPOST-запроса.
Например, в PHP, это можно сделать так:
file_get_contents("https://lcab.smsint.ru/lcabApi/sendSms.php?login=ЛОГИН&password=ПАРОЛЬ&txt=привет&to=89010003333");
Ответ от сервера приходит в виде json-строки
Рассылка СМС
Отправка СМС
Адрес:
https://lcab.smsint.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
|
Имя отправителя
|
Нет. Если не задано, берется имя отправителя по-умолчанию.
|
smsid
|
SMSID – идентификатор СМС (группы СМС). Данный параметр необходим для идентификации отправляемой СМС (группы СМС). Длина идентификатора должна быть не более 32 символов.
|
Если не задано, генерируется автоматически.
|
|
dateTimeSend
|
Дата\время отправки СМС в MySQL формате ГГГГ-ММ-ДД чч:мм:сс
|
Нет. Если не задано, сразу ставиться в очередь.
|
channel
|
ID канала для отправки СМС
- 0 - Прямой (гарантия, мультиподпись)
- 1 - Прямой (гарантия, без выбора подписи)
- 2 - Альтернативный (цифровая подпись)
|
Нет.
|
|
check
|
По умолчанию: 0
|
Да.
|
|
discountID
|
ID акции из раздела СМС-купон. Если вы передадите его, то обязательными параметрами станут только login, password и получатели.
|
Нет.
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Успешно обработано',
'colsmsOfSending' => 1,
'priceOfSending' => '10.15',
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
colsmsOfSending
|
Количество СМС в рассылке (если code == 1)
|
|
priceOfSending
|
Стоимость рассылки (если code == 1)
|
Запрос имени отправителя
Адрес:
https://lcab.smsint.ru/lcabApi/requestSource.php
Описание параметров:
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
source
|
Желаемое имя отправителя
|
Да
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Запрос на подпись принят!'
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
deleted
|
Количество удаленных контактов
|
Информация о номере
Адрес:
https://lcab.smsint.ru/lcabApi/getPhoneInfo.php
Описание параметров:
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
phone
|
Номер телефона, по которому хотите получить информацию
|
Да
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Операция завершена успешно',
'phone' => '79000000000',
'country' => 'Россия',
'district' => 'Московская обл.',
'opsos' => 'Теле2'
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
phone
|
Номер телефона, приведенный в стандартный формат
|
|
country
|
Страна, которой принадлежит этот номер
|
|
district
|
Регион, которому принадлежит этот номер
|
|
opsos
|
Оператор сотовой связи
|
Контакты
Список контактов
Адрес:
https://lcab.smsint.ru/lcabApi/getContacts.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
idGroup
|
ID группы, контакты из которой вы хотите получить
|
Нет
|
|
phone
|
Искомый номер телефона
|
Нет
|
Ответ сервера:
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
|
Массив, содержащий список контактов
|
Добавление контакта
Адрес:
https://lcab.smsint.ru/lcabApi/addContact.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
idGroup
|
id группы, в которую нужно добавить контакт.
|
Да
|
|
phone
|
Номер телефона
|
Да
|
|
email
|
Email
|
нет, если задан телефон
|
|
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)
|
Удаление контакта
Адрес:
https://lcab.smsint.ru/lcabApi/removeContact.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
phone
|
Номер телефона удаляемого контакта
|
Да
|
|
idGroup
|
ID группы, в которой находится контакт
|
Нет
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Контакт успешно удален',
'deleted' => 1
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
deleted
|
Количество удаленных контактов
|
Список групп
Адрес:
https://lcab.smsint.ru/lcabApi/getGroups.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
id
|
id группы
|
Нет
|
|
name
|
Название группы
|
Нет
|
Ответ сервера:
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
|
Дата последней синхронизации
|
Создание/редактирование групп
Адрес:
https://lcab.smsint.ru/lcabApi/saveGroup.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
|
name
|
Название группы
|
Да
|
|
id
|
ID группы
|
Да, при редактировании существущей группы
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Операция завершена успешно',
'id' => (int)id группы
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
id
|
ID сохраненной группы
|
Данные об аккаунте
Адрес:
https://lcab.smsint.ru/lcabApi/info.php
|
Параметр
|
Описание
|
Обязательный параметр
|
|
login
|
Ваш логин от личного кабинета
|
Да
|
|
password
|
Ваш пароль от личного кабинета
|
Да
|
Ответ сервера:
array (
'code' => 1,
'descr' => 'Описание результата обработки',
'account' => '583.12',
'ocode' => '8000*******',
'source' => array (
0 => 'MyShop',
1 => 'Ded Moroz'
),
'receive_numbers' => array (
0 => '7902*******',
1 => '7902*******'
)
)
|
Параметр
|
Описание
|
|
code
|
Результат обработки
|
|
descr
|
Описание результата обработки
|
|
account
|
Состояние баланса
|
|
ocode
|
Номер электронного лицевого счёта
|
|
source
|
Массив, содержащий имена отправителей
|
|
receive_numbers
|
Массив, содержащий список арендованных входящих номеров
|
