Интеграция с сервисом (API) - HTTP/HTTPS

Параметр;Значение

login;Логин Клиента. psw;Пароль Клиента. name;Название контакта или группы. grp;Идентификатор группы, которой принадлежит создаваемый контакт. Можно привязать контакт сразу к нескольким группам, указав их идентификаторы через запятую. num;Номер группы для рассылок сообщений. phone;Список номеров телефонов через любой разделитель (команда add), либо номер телефона (команды move_group, add_black). Используется для операций с номерами телефонов в скрипте phones.php. mail;Список e-mail адресов через любой разделитель (команда add), либо e-mail адрес (команды move_group, add_black). Используется для операций с e-mail адресами в скрипте mails.php. Формат запросов аналогичен формату для phones.php. new_phone;Новый список номеров телефонов через любой разделитель (команда chg). new_mail;Новый список e-mail адресов через любой разделитель (команда chg). lnm;Фамилия fnm;Имя mnm;Отчество fio;ФИО контакта. Данный параметр используется в команде get для получения списка контактов по любому из инициалов (фамилии, имени и (или) отчеству). search;Выборка контактов для команды get по названию контакта и (или) номеру телефона. after_id;Идентификатор контакта (int_id), начиная с которого необходимо вернуть список контактов (команда get, формат fmt=3), за исключением самого after_id. bd;Дата рождения в формате дд.мм.гггг. myid;ID контакта, назначенный Клиентом. cmt;Комментарии tags;Теги (метки). pho;Другие номера телефонов. По данным номерам рассылка SMS-сообщений не выполняется. type;Тип блокировки (команды add_black):<br>0 – все сообщения.<br>1 – массовые рассылки.<br>2 – одиночные сообщения.<br>Либо тип группы (команды add_group и get_group):<br>0 – группа для номеров телефонов.<br>1 – группа для e-mail адресов. prev_id;Глобальный идентификатор элемента "черного" списка (параметр id в ответе Сервера), назначаемый Сервером автоматически. Используется в команде get_black для запроса элементов "черного списка", добавленных ранее до данного элемента. cnt;Количество записей, возвращаемых в ответе Сервера. Максимальное значение равно 1000. fmt;Формат ответа сервера:<br>0 – (по умолчанию) в виде строки (ID = 12345).<br>1 – в виде строки (12345).<br>2 – в xml формате.<br>3 – в json формате.

Значение;Описание

1;Ошибка в параметрах. 2;Неверный логин или пароль. Также возникает при попытке отправки сообщения с IP-адреса, не входящего в список разрешенных Клиентом (если такой список был настроен Клиентом ранее). 3;Записи не найдены. 4;IP-адрес временно заблокирован. 5;Ошибка выполнения операции. 9;Попытка отправки более трех одинаковых запросов на операции с группами, контактами или записями "черного" списка в течение минуты. Данная ошибка возникает также при попытке отправки пятнадцати и более запросов одновременно с разных подключений под одним логином (too many concurrent requests).

Параметр;Значение

login;Логин Клиента. psw;Пароль Клиента. user;Логин субклиента. pswc;Текущий пароль субклиента. password;Новый пароль субклиента. Длина должна быть не менее 8 символов, и выполняться 3 из условий: буквы, цифры, разный регистр, символы. sum;Сумма, перечисляемая клиенту с главного аккаунта в валюте главного аккаунта. balance2;Флаг, устанавливающий возможность использования электронного баланса для зачислений, списаний и получения статистики по сообщениям site_id;ID сайта, которому будет принадлежать создаваемый субклиент new_login;Новый логин субклиента при изменении type;Тип учетной записи.<br>0 (по умолчанию) – независимые тариф и баланс.<br>1 – тариф главного аккаунта, независимый баланс.<br>2 – тариф и баланс главного аккаунта.<br>3 – баланс главного аккаунта, независимый тариф.<br>4 – дополнительный логин главного аккаунта. email;Основной адрес электронной почты. fl[9];Флаг, устанавливающий возможность пересылки входящих SMS на e-mail email2;Альтернативный адрес электронной почты для пересылки входящих SMS. phone;Основной номер телефона. fl[8];Флаг, устанавливающий возможность пересылки входящих SMS на телефон phone2;Альтернативный номер телефона для пересылки входящих SMS. start;Начальная дата в периоде, за который запрашивается статистика. Формат: 'дд.мм.гггг'. end;Конечная дата в периоде. Если не указана, то возвращаются данные с начальной даты. Формат: 'дд.мм.гггг'. user_id;Идентификатор субклиента, назначаемый сервером автоматически при создании. reseller;Типы субклиентов.<br>0 или отсутствует – cубклиенты, использующие баланс главного аккаунта.<br>1 – субклиенты с независимым балансом. hide_deleted;Скрыть статистику по удаленным субклиентам.<br>0 или отсутствует – вывести статистику по всем субклиентам.<br>1 – скрыть статистику по удаленным субклиентам. mycur;Флаг, позволяющий выводить статистику в валюте главного аккаунта. fio;Инициалы (фамилия, имя, отчество) или название компании props;Поле "Другие реквизиты" субклиента cntr;Номер договора. tariff;Текущий тарифный план. Субклиенту можно установить тарифный план не выше тарифного плана Клиента. Параметр может принимать следующие значения:<br>0 (по умолчанию) – 1 тариф (от 1 р.).<br>1 – 2 тариф (от 1000 р.).<br>...<br>8 – 9 тариф (от 100000 р.). mintrf;Минимальный тариф. Определяет минимальное значение тарифа субклиента независимо от суммы платежа curr;Валюта расчетов субклиента. Используется в командах add и chg. Может принимать следующие основные значения:<br>1 – российский рубль<br>2 – доллар США<br>3 – евро<br>4 – украинская гривна<br>5 – казахстанский тенге tz;Часовой пояс. По умолчанию устанавливается часовой пояс Клиента. Возможные значения:<br>0 – GMT-12.<br>...<br>12 – GMT+00<br>...<br>24 – GMT+12. sender;Имя отправителя (Sender ID) по умолчанию. sender2;Резервное имя отправителя fl[29];Флаг, определяющий возможность использования списка отправителей Клиента (главного аккаунта) fl2[9];Флаг, разрешающий использование более дорогих маршрутов для гарантированной доставки сообщений fl2[24];Флаг, позволяющий отправлять сначала через дешевые маршруты, при недоставке повторять через дорогие (кроме массовых рассылок) fl2[12];Флаг запрещает отправку сообщений с автоматической заменой имени отправителя. fl2[13];Флаг отключает добавление имени отправителя в текст сообщений без удорожания в случае автозамены nb;Баланс для уведомлений. При достижении указанной суммы будут отправляться уведомления на e-mail субклиента ktm;Данный параметр устанавливает количество дней для хранения отправленных сообщений, по истечении которых SMS-сообщения будут автоматически удаляться из истории fmts;Список телефонных кодов, на которые разрешена отправка сообщений notes;Комментарии главного аккаунта. Недоступны субклиенту fl2[23];Запрет массовых и рекламных рассылок fl[26];Разрешение использования списка контактов главного аккаунта. fl2[8];Флаг, устанавливающий расширенный режим личного кабинета fl[16];Включить распознавание автоответчиков при звонках fl2[31];Разрешить использование шаблонов главного аккаунта Дополнительные параметры для настройки доступа к сервису fl3[20];Флаг, позволяющий отключить подтверждение доступа с новых IP-адресов при входе ph;Список телефонов или номеров групп через запятую для выполнения рассылок по SMS-командам fl[27];Запретить изменения настроек субклиентом fl[28];Запретить оплаты субаккаунтом fl[6];Запретить рассылки fl2[1];Скрыть сообщения для субклиента fl2[10];Заблокировать субаккаунт. Дополнительные параметры для лимитов и ограничений dlim;Общий лимит SMS за день. Определяет максимальное количество отправляемых за сутки сообщений plim;Лимит на один номер. Устанавливает максимальное количество отправляемых за сутки сообщений на один номер телефона tlim;Лимит на номер и текст. Устанавливает максимальное количество отправляемых за сутки сообщений с одним текстом на один номер телефона ilim;Лимит с одного IP-адреса. Задает максимальное количество отправляемых за сутки сообщений с одного IP-адреса tmlim;Диапазон времени в часах h1-h2, в который разрешено отправлять сообщения. Если текущее время меньше h1, то SMS-сообщение будет отправлено абоненту при наступлении времени h1, если текущее время попадает в промежуток от h1 до h2, то сообщение будет отправлено немедленно, в другом случае отправка будет выполнена на следующий день при достижении времени h1. Данная функция, например, полезна для того, чтобы не допустить получение SMS-сообщений абонентами в ночное время fl2[15];Запретить отправку в другое время, кроме указанного в параметре tmlim, вместо переноса на следующий день fl2[16];При использовании параметра tmlim учитывать часовой пояс абонентов. vld;Максимальный срок доставки сообщений временно недоступным абонентам (мин.) Дополнительные параметры для автоответов answ;Автоответ на входящие SMS answ_call;Автоответ на входящие звонки fl2[4];Отключить пересылку звонков (на e-mail, телефон и обработчик) Дополнительные параметры для настроек API url;http-адрес (URL) скрипта для обработки статусов доставки SMS-сообщений и (или) входящих SMS-сообщений на стороне субклиента. Указанный скрипт будет вызываться Сервером после каждого получения статуса доставки ранее отправленного субклиентом SMS-сообщения и (или) после получения входящего SMS-сообщения от абонента fl[10];Включение пересылки статусов сообщений на http-адрес, указанный в параметре url fl[11];Включение пересылки входящих SMS-сообщений на http-адрес, установленный в параметре url fl[2];Включить SMPP-доступ (предварительно необходимо зарегистрировать IP-адрес через ONLINE-поддержку) fl[1];Передавать входящие SMS по SMPP-подключению fl[23];Отслеживать статусы отдельных SMS-частей fl2[27];Режим тестирования (виртуальная отправка без оплаты) fl[5];Включить контроль за доставкой сообщений fl[30];Включение лога API. Позволяет просматривать 20 последних http-запросов. Хранится 10 минут после последнего запроса Дополнительные параметры для E-mail2sms mfl[0];Флаг, позволяющий отключить функцию e-mail2sms. mph;Разделенный запятой список номеров телефонов, на которые будут отправляться сообщения mfl[5];Включает возможность указания списка телефонов в теле письма mfl[6];Включает возможность указания списка телефонов в адресе письма mfl[1];Пересылка письма без темы mfl[2];Пересылка письма без текста mfl[3];Пересылка письма без обратного адреса (от кого) mfl[4];Перевод текста письма в транслит mh1;Начальное значение диапазона времени для отправки входящих писем. Вместе с параметром mh2 определяет диапазон, в течение которого возможна пересылка входящих писем в виде SMS-сообщений mh2;Конечное значение диапазона времени для отправки входящих писем mlen;Максимальная длина сообщения, до которой обрезается входящее письмо при отправке в виде SMS-сообщения (число больше 12 задает максимальную длину сообщения, меньше 12 - количество SMS)