jsonGateDoc
Общие принципы отправки
На определенный адрес сервера отправляются JSON документы (описание JSON документов, их назначение и адреса сервера приведены ниже). При этом используется POST метод.
Для просчета стоимости рассылки необходимо передавать "type":"price"
вместо "type":"sms"
.
Заголовки отправляемых данных должны содержать:
Content-Type: application/json; charset=utf-8
Кодировка JSON документов UTF-8.
Пример передачи JSON документа на php
$param = array(
'security' => array('login' => 'Логин', 'password' => 'Пароль'),
'type' => 'sms'
);
$param_json = json_encode($param, true);
// JSON-документ
$href = 'https://clk.prontosms.ru/sendsmsjson.php'; // адрес сервера
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json','charset=utf-8','Expect:'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $param_json);
curl_setopt($ch, CURLOPT_TIMEOUT, 600);
curl_setopt($ch, CURLOPT_URL, $href);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);
$res = curl_exec($ch);
$result = json_decode($res, true);
curl_close($ch);
print_r($result);
Отправка SMS
Адрес сервера:
https://clk.prontosms.ru/sendsmsjson.php
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (sms - отправка SMS);
message
данные отправляемых SMS:
type
тип отправляемого SMS сообщения (sms - обычная SMS);
sender – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
text – текст SMS;
name_delivery – Название рассылки. По умолчанию "Шлюз";
translite
транслитерация текста SMS с кириллицы на латиницу (не обязательный параметр). Для транслитерации данный параметр должен быть равен 1;
abonent
получатели SMS;
phone – номер абонента, которому адресована SMS. В международном формате, например, 79000000001 (Для России), 380442589632 (Для Украины) и т.д.;
number_sms
номер сообщения в пределах отправляемого JSON документа;
client_id_sms
число. Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS;
time_send – дата и время отправки в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS отправляется сразу же;
validity_period – дата и время, после которых не будут делаться попытки доставить SMS в формате: YYYY-MM-DD hh:mm, где YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS имеет максимальный срок жизни.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения: 1. Неправильный формат JSON документа; 2. Неправильный логин или пароль; 3. POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
number_sms
номер сообщения указанный при отправке JSON документа;
id_sms
номер SMS сообщения. Используется для проверки статуса SMS. Если в процессе отправки SMS произошла ошибка, то id_sms не передается;
parts
количество частей SMS;
action
статус сообщения («send»), если SMS была отправлена. Или сообщение об ошибке, если в процессе отправки SMS произошла ошибка:
Запрос статуса SMS сообщения
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (state - статусы SMS сообщений);
get_state
номера SMS сообщений, полученные в ответном JSON-документе в процессе отправки SMS сообщения.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где: id_sms
номер SMS сообщения, полученный в ответном JSON-документа в процессе отправки SMS сообщения.
time
время изменения статуса. *
state
статус сообщения:
num_parts
Количество частей в СМС.
price
Цена за одну часть СМС.
Запрос проверки баланса
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (balance - баланс и количество доступных SMS по операторам).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения: 1. Неправильный формат JSON документа; 2. Неправильный логин или пароль; 3. POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
money
баланс пользователя:
currency
валюта баланса;
value
сумма средств;
sms
количество доступных SMS сообщений по направлениям:
area
направление в котором может быть отправлено SMS;
number
количество доступных SMS сообщений для данного направления.
При этом количество SMS не может быть суммировано по разным направлениям. При отправке смс в одном направлении уменьшается количество доступных SMS сообщений во всех других направлениях в соответствии с их стоимостью.
Пример
У вас на балансе 10 y.e. Стоимость SMS сообщения отправленного на МТС составляет 1 y.e. Стоимость SMS сообщения отправленного на Мегафон составляет 2 y.e.
При этом вам вернется документ следующего содержания. JSON:
PHP (массив, полученный через php функцию json_decode):
Запрос на получения списка отправителей
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (originator - список отправителей).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
any_originator
TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных. Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается. FALSE – можно использовать только отправителей со статусом «completed»;
state
статус отправителя:
«order» - оформляется;
«completed» - готов к использованию;
«rejected» – отклонен.
Запрос входящих SMS
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (incoming - cписок входящих SMS);
time
время входящие SMS:
start
время (не включительно), с которого запрашиваются входящие SMS;
end
время (не включительно), по которое запрашиваются входящие SMS. Не обязательный параметр. Если не задан, то будут возвращены все смс.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения: 1. Неправильный формат JSON документа; 2. Неправильный логин или пароль; 3. POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
id_sms
уникальный номер, состоящий только из цифр;
date_receive
дата и время получения SMS;
originator
номер телефона абонента, отправившего SMS;
prefix
префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами.);
phone
номер телефона, на который бала отправлена SMS;
text_sms
текст смс.
Запрос на получение информации по номеру телефона
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (def - информация по номерам указанных телефонов);
phones
Номера телефонов.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
phone
номер телефона;
operator
Оператор;
region
Регион;
time_zone
Смещение времени в часах относительно времени в Москве.
Запрос на получение списка баз
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_bases - список баз).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения: 1. Неправильный формат JSON документа; 2. Неправильный логин или пароль; 3. POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
id_base
уникальный номер базы в системе;
name_base
название базы;
time_birth
время поздравления;
local_time_birth
ччитать время поздравления относительно местного времени абонента(yes) или относительно времени системы (no);
day_before
за сколько дней до дня рождения поздравлять;
originator_birth
отправитель поздравления;
on_birth
включены ли поздравления yes – включены, no - выключены;
base
текст поздравления.
Запрос на изменение параметров/добавление/удаление баз
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (bases - работа с базами);
bases
Добавление либо изменение параметров баз:
id_base
уникальный номер базы в системе. Если не указан произойдет добавление базы. При этом нужно указать параметр number_base;
number_base
номер базы в JSON запросе. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе);
name_base
название базы;
time_birth
время поздравления;
local_time_birth
считать время поздравления относительно местного времени абонента (yes) или относительно времени системы (no);
originator_birth
отправитель поздравления;
on_birth
включены ли поздравления yes – включены, no - выключены;
text_birth
текст поздравления;
delete_bases
удаление указанных баз:
id_base
уникальный номер базы в системе.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
id_base
уникальный номер базы в системе;
action
действие, произведенное с базой:
«edit» - изменение параметров базы;
«insert» - добавление базы;
«delete» - база удалена;
«not_found» - база с указанным идентификатором не обнаружена;
number_base
номер базы в JSON запросе. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе).
Запрос на получение списка абонентов базы
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_phones - список абонентов базы);
base
база:
id_base
уникальный номер базы в системе;
page
номер страницы. Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички;
last_update
минимальная дата и время регистрации (или последнего изменения) данных абонента, которых Вам нужно запросить. Необязательный параметр.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
Базы с таким номером не существует;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
page
номер страницы;
num_pages
всего страниц;
phone
номер телефона абонента;
region
регион;
operator
оператор;
name
имя абонента;
surname
фамилия абонента;
patronymic
отчество абонента;
date_birth
дата рождения;
male
пол. «m» - мужской, «f»- женский;
addition_1 – первое дополнительное поле;
addition_2 – второе дополнительное поле;
addition_3 – третье дополнительное поле;
addition_4 – четвертое дополнительное поле;
addition_5 – пятое дополнительное поле;
last_update
дата и время регистрации (или последнего изменения) данных абонента.
Запрос на добавление/редактирование/удаление абонентов базы
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (phones - работа с абонентами базы);
id_base
номер базы в системе;
phones
номера телефонов;
phone
номер телефона абонента. Если абонент с таким номером уже существует, то он будет отредактирован;
region
регион. Необязательное поле. Если не задано определяется автоматически;
operator
оператор. Необязательное поле. Если не задано определяется автоматически;
name
имя абонента. Необязательное поле;
surname
фамилия абонента. Необязательное поле;
patronymic
отчество абонента. Необязательное поле;
date_birth
дата рождения. Необязательное поле;
male
пол. «мужской» или «женский». Необязательное поле;
addition_1
первое дополнительное поле. Необязательное поле;
addition_2
второе дополнительное поле. Необязательное поле;
addition_3 – третье дополнительное поле. Необязательное поле;
addition_4 – четвертое дополнительное поле. Необязательное поле;
addition_5 – пятое дополнительное поле. Необязательное поле;
action
Действие производимое над телефоном (delete - удалить номер телефона из базы);
number_phone
номер телефона в JSON запросе. Используется для сопоставления ID работающих номеров.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
Базы с таким номером не существует;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
id_base
номер базы в системе;
phones
номера телефонов;
phone
номер телефона абонента;
action
произведенное действие с номером телефона:
«edit» - изменение параметров телефона;
«insert» - добавление телефона;
«delete» - телефон удален;
«not_found» - телефон с указанным номером не обнаружен;
number_phone
номер телефона в JSON запросе. Используется для сопоставления ID работающих номеров.
Запрос на получение списка номеров из СТОП-листа
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_stop - список номеров в стоп-листе).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
phones
номер телефона из СТОП-листа.
Запрос на добавление/удаление абонентов в СТОП-лист
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (stop - работа с СТОП-листом);
add_stop
номера телефонов абонентов, котороые нужно добавить в СТОП-лист;
delete_stop
номера телефонов абонентов, котороые нужно удалить из СТОП-листа.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
phones
номера телефонов;
phone
номер телефона абонента;
action
произведенное действие с номером телефона:
«add» - добавление номера телефона в СТОП-лист;
«delete» - номер телефона удален из СТОП-листа;
«not_found» - номер телефона для удаления не обнаружен в СТОП-листе.
Запрос на получение списка запланированных SMS
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_scheduled - список запланированных SMS).
page
номер страницы. Весь список запланированных SMS делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
page
номер страницы;
num_pages
всего страниц;
scheduled
список запланированных SMS;
id_sms
номерSMS. Используется для удаления запланированной SMS;
time_put_turn
время добавления в планировщик;
operator – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
phone
номер абонента, которому адресована SMS;
type – тип отправляемого SMS сообщения:
«sms» - обычная SMS;
«flashsms» - flash SMS;
«wappush» - WAP-Push;
«vcard» - визитная карточка (vCard);
text_sms
Текст SMS-сообщения;
count_sms –Количество частей SMS-сообщения;
name_delivery
Название рассылки;
time_send
дата и время отправки в формате: YYYY-MM-DDHH:MM где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты;
validity_period
дата и время, после которых не будут делаться попытки доставить SMS в формате: YYYY-MM-DDHH:MM:SS где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты, SS-секунды.
Запрос на удаление запланированных SMS
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (scheduled - удаление запланированных SMS);
delete_schedule
Список удаления запланированных SMS:
id_sms
номер запланированной SMS, которую нужно удалить. Можно получить при запросе списка запланированных SMS.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
phones
номера телефонов;
id_sms
номер запланированной SMS;
action
произведенное действие с запланированными SMS:
delete - запланированная SMS удалена;
«not_found» - запланированная SMS не обнаружена.
Запрос проверки времени
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (time - проверка времени).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения: 1. Неправильный формат JSON документа; 2. Неправильный логин или пароль; 3. POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
time
локальное время пользователя.
При этом время рассчитывается как время на сервере минус разница часовых поясов пользователя и сервера.
Пример
Сервер находится в Москве и серверное время у него московское, в момент запроса оно составляло: 15:34:27. А пользователь числился в Новосибирске и разница часовых поясов (между сервером и пользователем) у него равнялась +3. При этом вам вернется JSON документ следующего содержания:
Запрос на получение статистики
Статистику можно получить только за последние 3 месяца. Смс старше 3 месяцев переносятся в архив. Запросить выгрузку статистики по смс старше 3 месяцев можно через вашего менеджера.
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_stats - деиальная статистика);
stats
параметры выгрузки статистики:
date_start
дата отправки СМС, не ранее указанного периода времени (по умолчанию сегодняшняя дата);
date_stop – дата отправки СМС, не позднее указанного периода времени (по умолчанию сегодняшняя дата);
from_hour
час отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 00);
from_minute
минута отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 00);
to_hour
час отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 59);
to_minute
минута отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 59);
state
cтатус сообщения:
not_deliver
сообщение не было доставлено. Конечный статус (не меняется со временем);
expired
абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);
deliver
сообщение доставлено. Конечный статус (не меняется со временем);
partly_deliver
сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
originator
имя отправителя;
phone
номер телефона получателя СМС;
operator
мобильный оператор получателя СМС (Beeline, Мегафон, МТС).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
Некорректный формат даты;
Такой оператор не обнаружен;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
num_stats
всего СМС;
stats
список детальной статистики:
id_sms
номер SMS сообщения;
id_state
идентификатор части СМС;
operator
оператор;
phone
номер телефона получателя СМС;
originator
имя отправителя;
time_change_state
последнее время смены состояния СМС;
time
время отправки СМС;
status
cтатус сообщения:
not_deliver
сообщение не было доставлено. Конечный статус (не меняется со временем);
expired
абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);
deliver
сообщение доставлено. Конечный статус (не меняется со временем);
partly_deliver
сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
status_translate
статус сообщения, на русском языке;
price
цена за одну часть СМС;
num_parts
количество частей СМС;
part_no
порядковый номер части СМС.
Запрос на получение списка шаблонов SMS
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (list_patterns - шаблоны sms).
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
patterns
шаблоны SMS:
id_pattern
идентификатор шаблона в системе;
name
заголовок шаблона;
pattern
шаблон;
Запрос на изменение параметров/добавление/удаление шаблонов SMS
Адрес сервера:
JSON-документ:
PHP-данные:
Где:
security
данные для авторизации:
login
ваш логин в системе;
password
ваш пароль в системе;
type
тип запроса (patterns - работа с шаблонами SMS);
patterns
Добавление либо изменение шаблонов SMS:
id_pattern
уникальный номер шаблона в системе. Если не указан произойдет добавление базы. При этом нужно указать параметр number_pattern;
number_pattern
номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблонов (если их было не сколько в запросе);
name
заголовок шаблона;
pattern
шаблон;
delete_patterns
удаление указанных баз:
id_pattern
уникальный номер шаблона в системе.
В ответ может быть выдан один из следующих JSON-документов:
В случае возникновения ошибки в отправляемом JSON-документе:
JSON:
PHP (массив, полученный через php функцию json_decode):
error
текст ошибки может принимать следующие значения:
Неправильный формат JSON документа;
Неправильный логин или пароль;
POST данные отсутствуют;
В случае получения правильного JSON-документа:
JSON:
PHP (массив, полученный через php функцию json_decode):
Где:
id_pattern
уникальный номер шаблона sms в системе;
action
действие, произведенное с шаблоном:
«edit» - изменение параметров шаблона;
«insert» - добавление шаблона;
not_edit - не удалось обновить шаблон. Возможно данные идентичны с обновляемым шаблоном;
«delete» - шаблон удалена;
«not_found» - шаблон с указанным идентификатором не обнаружен;
number_pattern
номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблона(если их было не сколько в запросе).