ОбзорДокументацияВойти
/
smsgate
/
jsonGateDoc
Код
Запросы
0
Задачи
0
Вики
Пакеты
0
Релизы
0
Аналитика
Безопасность

jsonGateDoc

0

Описание

143 KiB
README
В избранном0
Форки0
1
28
0
README.md
год назад
README.md

JSON

Общие принципы отправки

На определенный адрес сервера отправляются JSON документы (описание JSON документов, их назначение и адреса сервера приведены ниже). При этом используется POST метод.

Заголовки отправляемых данных должны содержать:

Content-Type: application/json; charset=utf-8

Кодировка JSON документов UTF-8.

Пример передачи JSON документа на php

Отправка SMS

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (sms - отправка SMS);
  • message - данные отправляемых SMS:
    • type - тип отправляемого SMS сообщения (sms - обычная SMS);
    • sender – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
    • text – текст SMS. При рассылке по базе можно использовать переменные из базы, например #number#, #name#;
    • name_delivery – Название рассылки. По умолчанию "Шлюз";
    • translite - транслитерация текста SMS с кириллицы на латиницу (не обязательный параметр). Для транслитерации данный параметр должен быть равен 1;
    • abonent - получатели SMS;
      • phone – номер абонента, которому адресована SMS. В международном формате, например, 79000000001 (Для России), 380441234567 (Для Украины) и т.д.;
      • 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 имеет максимальный срок жизни;
    • base - База рассылки;
      • base – Идентификатор базы, можно посмотреть в ЛК. Уточните у вашего менеджера, поддерживает ли платформа возможность рассылки по базе;
      • time_send – дата и время отправки в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS отправляется сразу же;
    • stop_base - База стоп-листа (Игнорирование номер из рассылаемых номеров). Уточните у вашего менеджера, поддерживает ли указание баз стоп-листов;
      • base – Идентификатор базы, можно посмотреть в ЛК. Уточните у вашего менеджера, поддерживает ли платформа возможность рассылки по базе.

В ответ может быть выдан один из следующих 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;
  • base - База рассылки, если рассылка была по базе;
  • phone - Номер телефона;
  • action - статус сообщения («send»), если SMS была отправлена. Или сообщение об ошибке, если в процессе отправки SMS произошла ошибка:
    1. У нас закончились SMS. Для разрешения проблемы свяжитесь с менеджером.
    2. Закончились SMS.
    3. Аккаунт заблокирован.
    4. Укажите номер телефона.
    5. Номер телефона присутствует в стоп-листе.
    6. Данное направление закрыто для вас.
    7. Данное направление закрыто.
    8. Недостаточно средств для отправки SMS. SMS будет отправлена как только вы пополните счет по данному направлению.
    9. Текст SMS отклонен модератором.
    10. Нет отправителя.
    11. Отправитель не должен превышать 15 символов для цифровых номеров и 11 символов для буквенно-числовых.
    12. Номер телефона должен быть меньше 15 символов.
    13. Нет текста сообщения.
    14. Нет ссылки.
    15. Такого отправителя Нет.
    16. Отправитель не прошел модерацию.
    17. Данное сообщение уже было отправлено.

Запрос статуса SMS сообщения

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (state - статусы SMS сообщений);
  • get_state - номера SMS сообщений, полученные в ответном JSON-документе в процессе отправки SMS сообщения.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • id_sms - номер SMS сообщения, полученный в ответном JSON-документа в процессе отправки SMS сообщения.
  • time - время изменения статуса.
  • state - статус сообщения:
    1. «send» - статус сообщения не получен. В этом случае передается пустой time (time="");
    2. «not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем);
    3. «expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем;
    4. «deliver» - сообщение доставлено. Конечный статус (не меняется со временем);
    5. «partly_deliver» - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • num_parts - Количество частей в СМС.
  • price - Цена за одну часть СМС.

Запрос проверки баланса

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - количество доступных сообщений для данного направления;
    • price - Цена за одно сообщения;
    • type_sms - Тип сообщения (sms / viber / vk / whatsapp);
    • type_text - Тип текста в сообщении (Рекламные / Сервисные / Транзакционные);
    • MCC - (англ. Mobile Country Code) мобильный код страны;
    • MNC - (англ. Mobile Network Code) код мобильной сети.

При этом количество SMS не может быть суммировано по разным направлениям. При отправке смс в одном направлении уменьшается количество доступных SMS сообщений во всех других направлениях в соответствии с их стоимостью.

Запрос ссылки на пополнение баланса

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (pay - Запрос на получение ссылки для дальнейшего пополнения баланса);
  • sum - Сумма пополнения баланса (сумма оплаты может быть увеличена, в связи с комиссией магазина).

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • sum_pay - Сумма, которую вы должны оплатить в платежной системе, для пополнения баланса указанной вами суммы;
  • url - Ссылка для перехода к платежной системе.

Запрос на получения списка отправителей

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (originator - список отправителей).

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • any_originator - TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных. Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается. FALSE – можно использовать только отправителей со статусом «completed»;
  • state - статус отправителя:
    1. «order» - оформляется;
    2. «completed» - готов к использованию;
    3. «rejected» – отклонен.

Запрос входящих SMS

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - текст смс.

Запрос на получение информации по номеру телефона

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (def - информация по номерам указанных телефонов);
  • phones - Номера телефонов.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • phone - номер телефона;
  • operator - Оператор;
  • region - Регион;
  • time_zone - Смещение времени в часах относительно времени в Москве.

Запрос на получение списка баз

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - текст поздравления.

Запрос на изменение параметров/добавление/удаление баз

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • id_base - уникальный номер базы в системе;
  • action - действие, произведенное с базой:
    1. «edit» - изменение параметров базы;
    2. «insert» - добавление базы;
    3. «delete» - база удалена;
    4. «not_found» - база с указанным идентификатором не обнаружена;
  • number_base - номер базы в JSON запросе. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе).

Запрос на получение списка абонентов базы

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_phones - список абонентов базы);
  • base - база:
    • id_base - уникальный номер базы в системе;
    • page - номер страницы. Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички;
    • last_update - минимальная дата и время регистрации (или последнего изменения) данных абонента, которых Вам нужно запросить. Необязательный параметр.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;
  4. Базы с таким номером не существует;

В случае получения правильного 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 - дата и время регистрации (или последнего изменения) данных абонента.

Запрос на добавление/редактирование/удаление абонентов базы

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;
  4. Базы с таким номером не существует;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • id_base - номер базы в системе;
  • phones - номера телефонов;
    • phone - номер телефона абонента;
    • action - произведенное действие с номером телефона:
      1. «edit» - изменение параметров телефона;
      2. «insert» - добавление телефона;
      3. «delete» - телефон удален;
      4. «not_found» - телефон с указанным номером не обнаружен;
    • number_phone - номер телефона в JSON запросе. Используется для сопоставления ID работающих номеров.

Запрос на получение списка номеров из СТОП-листа

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_stop - список номеров в стоп-листе).

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • phones - номер телефона из СТОП-листа.

Запрос на добавление/удаление абонентов в СТОП-лист

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (stop - работа с СТОП-листом);
  • add_stop - номера телефонов абонентов, котороые нужно добавить в СТОП-лист;
  • delete_stop - номера телефонов абонентов, котороые нужно удалить из СТОП-листа.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • phones - номера телефонов;
    • phone - номер телефона абонента;
    • action - произведенное действие с номером телефона:
      1. «add» - добавление номера телефона в СТОП-лист;
      2. «delete» - номер телефона удален из СТОП-листа;
      3. «not_found» - номер телефона для удаления не обнаружен в СТОП-листе.

Запрос на получение списка запланированных SMS

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_scheduled - список запланированных SMS).
  • page - номер страницы. Весь список запланированных SMS делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. 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 сообщения:
      1. «sms» - обычная SMS;
      2. «flashsms» - flash SMS;
      3. «wappush» - WAP-Push;
      4. «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

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (scheduled - удаление запланированных SMS);
  • delete_schedule - Список удаления запланированных SMS:
    • id_sms - номер запланированной SMS, которую нужно удалить. Можно получить при запросе списка запланированных SMS.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • phones - номера телефонов;
    • id_sms - номер запланированной SMS;
    • action - произведенное действие с запланированными SMS:
      1. delete - запланированная SMS удалена;
      2. «not_found» - запланированная SMS не обнаружена.

Запрос проверки времени

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 месяцев можно через вашего менеджера.

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_stats - детальная статистика);
  • stats - параметры выгрузки статистики:
    • date_start - дата отправки СМС, не ранее указанного периода времени (по умолчанию сегодняшняя дата);
    • date_stop – дата отправки СМС, не позднее указанного периода времени (по умолчанию сегодняшняя дата);
    • from_hour - час отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 00);
    • from_minute - минута отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 00);
    • to_hour - час отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 59);
    • to_minute - минута отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 59);
    • state - cтатус сообщения:
      1. not_deliver - сообщение не было доставлено. Конечный статус (не меняется со временем);
      2. expired - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);
      3. deliver - сообщение доставлено. Конечный статус (не меняется со временем);
      4. partly_deliver - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
    • originator - имя отправителя;
    • phone - номер телефона получателя СМС;
    • operator - мобильный оператор получателя СМС (Beeline, Мегафон, МТС).

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;
  4. Некорректный формат даты;
  5. Такой оператор не обнаружен;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • num_stats - всего СМС;
  • stats - список детальной статистики:
    • id_sms - номер SMS сообщения;
    • id_state - идентификатор части СМС;
    • operator - оператор;
    • phone - номер телефона получателя СМС;
    • originator - имя отправителя;
    • time_change_state - последнее время смены состояния СМС;
    • time - время отправки СМС;
    • status - cтатус сообщения:
      1. not_deliver - сообщение не было доставлено. Конечный статус (не меняется со временем);
      2. expired - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);
      3. deliver - сообщение доставлено. Конечный статус (не меняется со временем);
      4. partly_deliver - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
    • status_translate - статус сообщения, на русском языке;
    • price - цена за одну часть СМС;
    • num_parts - количество частей СМС;
    • part_no - порядковый номер части СМС.

Запрос на получение данных последних 10 SMS

Статистику можно получить только за последние 3 месяца. Смс старше 3 месяцев переносятся в архив. Запросить выгрузку статистики по смс старше 3 месяцев можно через вашего менеджера.

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_stats_last - детальная статистика);

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • num_stats - всего СМС;
  • stats - список детальной статистики:
    • id_sms - номер SMS сообщения;
    • operator - оператор;
    • phone - номер телефона получателя СМС;
    • originator - имя отправителя;
    • time - время отправки СМС;
    • status - cтатус сообщения:
      1. not_deliver - сообщение не было доставлено. Конечный статус (не меняется со временем);
      2. expired - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);
      3. deliver - сообщение доставлено. Конечный статус (не меняется со временем);
      4. partly_deliver - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
    • status_translate - статус сообщения, на русском языке;
    • price - цена за одну часть СМС;
    • num_parts - количество частей СМС.

Запрос на получение списка шаблонов SMS

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_patterns - шаблоны sms).

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • patterns - шаблоны SMS:
    • id_pattern - идентификатор шаблона в системе;
    • name - заголовок шаблона;
    • pattern - шаблон;

Запрос на изменение параметров/добавление/удаление шаблонов SMS

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • 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 - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • id_pattern - уникальный номер шаблона sms в системе;
  • action - действие, произведенное с шаблоном:
    1. «edit» - изменение параметров шаблона;
    2. «insert» - добавление шаблона;
    3. not_edit - не удалось обновить шаблон. Возможно данные идентичны с обновляемым шаблоном;
    4. «delete» - шаблон удалена;
    5. «not_found» - шаблон с указанным идентификатором не обнаружен;
  • number_pattern - номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблона(если их было не сколько в запросе).

Запрос на получение реестра имен отправителей

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

Где:

  • security - данные для авторизации:
    • login - ваш логин в системе;
    • password - ваш пароль в системе;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • type - тип запроса (list_registry_originator - список реестра имен);
  • registry_originator - Фильтр вывода реестра имен отправителей:
    • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2. Необязательное поле.
    • originator - Имя отправителя. Необязательное поле.
    • inn - Идентификационный номер налогоплательщика. Необязательное поле.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • operator name - Оператор. mts, mega, tele2.
  • operator title - Заголовок оператора. МТС, Мегафон, Теле2.
  • originator - Имя Отправителя.
  • date_from - Дата начала.
  • legal_entity - Юр.Лицо.
  • inn - Идентификационный номер налогоплательщика.
  • comment - Комментарий.
  • status - Статус:
    1. «posted_for_approval» - Подано на согласование;
    2. «send_for_approval» - Отправлено на согласование;
    3. «approval» - Согласовано;
    4. «not_approval» - Не согласовано;
    5. «send_for_delete» - Подано на удаление;
    6. «delete» - Удалено;
  • status_text - Статус, описание.

Запрос на добавление удаление имен отправителей в реестре имен отправителей

Адрес сервера:

https://имя_хоста/sendsmsjson.php

JSON-документ:

PHP-данные:

  • login - ваш логин в системе.
  • password - ваш пароль в системе.
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • registry_originator - Добавление имени отправителя:
    • originator - Имя отправителя.
    • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2.
    • legal_entity - Юр.Лицо.
    • inn - Идентификационный номер налогоплательщика.
    • comment - Комментарий. Необязательное поле.
  • delete_registry_originator - Удаление имени отправителя:
    • originator - Имя отправителя.
    • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2. Необязательное поле. Если отсутствует, будет удалено имя отправителя по всем операторам.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе:

JSON:

PHP (массив, полученный через php функцию json_decode):

error - текст ошибки может принимать следующие значения:

  1. Неправильный формат JSON документа;
  2. Неправильный логин или пароль;
  3. POST данные отсутствуют;

В случае получения правильного JSON-документа:

JSON:

PHP (массив, полученный через php функцию json_decode):

Где:

  • registry_originator - Добавленые имена отправителей:
    • originator - Имя отправителя.
    • operator - Оператор. mts, mega, tele2.
    • inn - Идентификационный номер налогоплательщика.
    • status - Статус. add - добавлено имя отправителя, error - ошибка.
    • error - Описание ошибки.
  • delete_registry_originator - Удаленные имена отправителей:
    • originator - Имя отправителя.
    • operator - Оператор. mts, mega, tele2. Если отсутствует, удалено имя отправителя по всем операторам.
    • status - Статус. not_found - подано на удаление, error - ошибка.
    • error - Описание ошибки.