Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • num_parts

    • Количество частей в СМС.

  • price

    • Цена за одну часть СМС.

Получение статуса SMS сообщения

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

Система отправляет серверу клиента JSON следующего содержания:

Code Block
languagejson
{
  "state":
    [
      {"id_sms":"Идентификатор СМС (Первого сегмента)","id_turn":"Идентификатор целого смс","time":"ВРЕМЯ","state":"Статус","num_parts":"Частей","price":"Цена","phone":"Номер"}
    ]
}

Где:

  • id_sms - номер SMS сообщения, полученный в ответном JSON в процессе отправки SMS сообщения. Как правило, это идентификатор первого сегмента.

  • time - время изменения статуса

  • id_turn - Идентификатор СМС (сборочная)

  • num_parts - Количество частей в СМС

  • price - Цена за одну часть СМС.

  • phone - Номер абонента.

  • state - статус сообщения:

    1. «send» - статус сообщения не получен. В этом случае передается пустой time (time="").

    2. «not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем).

    3. «expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем).

    4. «deliver» - сообщение доставлено. Конечный статус (не меняется со временем).

    5. «partly_deliver» - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.

В ответ мы ожидаем от сервера клиента 200 заголовок ответа и ответ «OK»

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

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

...

  • any_originator

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

  • state

    1. статус отправителя:

    2. «order» - оформляется;

    3. «completed» - готов к использованию;

    4. «rejected» – отклонен.

...

  • id_base

    • уникальный номер базы в системе;

  • action

    1. действие, произведенное с базой:

    2. «edit» - изменение параметров базы;

    3. «insert» - добавление базы;

    4. «delete» - база удалена;

    5. «not_found» - база с указанным идентификатором не обнаружена;

  • number_base

    • номер базы в JSON запросе. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе).

...

  • id_base

    • номер базы в системе;

  • phones

    • номера телефонов;

    • phone

      • номер телефона абонента;

    • action

      1. произведенное действие с номером телефона:

      2. «edit» - изменение параметров телефона;

      3. «insert» - добавление телефона;

      4. «delete» - телефон удален;

      5. «not_found» - телефон с указанным номером не обнаружен;

    • number_phone

      • номер телефона в JSON запросе. Используется для сопоставления ID работающих номеров.

...

  • phones

    • номера телефонов;

    • phone

      • номер телефона абонента;

    • action

      1. произведенное действие с номером телефона:

      2. «add» - добавление номера телефона в СТОП-лист;

      3. «delete» - номер телефона удален из СТОП-листа;

      4. «not_found» - номер телефона для удаления не обнаружен в СТОП-листе.

...

  • phones

    • номера телефонов;

    • id_sms

      • номер запланированной SMS;

    • action

      1. произведенное действие с запланированными SMS:

      2. delete - запланированная SMS удалена;

      3. «not_found» - запланированная SMS не обнаружена.

...

  • security

    • данные для авторизации:

    • login

      • ваш логин в системе;

    • password

      • ваш пароль в системе;

  • type

    • тип запроса (list_stats - деиальная статистика);

  • stats

    • параметры выгрузки статистики:

    • date_start

      • дата отправки СМС, не ранее указанного периода времени (по умолчанию сегодняшняя дата);

    • date_stop – дата отправки СМС, не позднее указанного периода времени (по умолчанию сегодняшняя дата);

    • from_hour

      • час отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 00);

    • from_minute

      • минута отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 00);

    • to_hour

      • час отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 59);

    • to_minute

      • минута отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 59);

    • state

      1. cтатус сообщения:

      2. not_deliver

        • сообщение не было доставлено. Конечный статус (не меняется со временем);

      3. expired

        • абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);

      4. deliver

        • сообщение доставлено. Конечный статус (не меняется со временем);

      5. partly_deliver

        • сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;

    • originator

      • имя отправителя;

    • phone

      • номер телефона получателя СМС;

    • operator

      • мобильный оператор получателя СМС (Beeline, Мегафон, МТС).

...

  • num_stats

    • всего СМС;

  • stats

    • список детальной статистики:

    • id_sms

      • номер SMS сообщения;

    • id_state

      • идентификатор части СМС;

    • operator

      • оператор;

    • phone

      • номер телефона получателя СМС;

    • originator

      • имя отправителя;

    • time_change_state

      • последнее время смены состояния СМС;

    • time

      • время отправки СМС;

    • status

      1. cтатус сообщения:

      2. not_deliver

        • сообщение не было доставлено. Конечный статус (не меняется со временем);

      3. expired

        • абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем);

      4. deliver

        • сообщение доставлено. Конечный статус (не меняется со временем);

      5. partly_deliver

        • сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;

    • status_translate

      • статус сообщения, на русском языке;

    • price

      • цена за одну часть СМС;

    • num_parts

      • количество частей СМС;

    • part_no

      • порядковый номер части СМС.

...

  • id_pattern

    • уникальный номер шаблона sms в системе;

  • action

    1. действие, произведенное с шаблоном:

    2. «edit» - изменение параметров шаблона;

    3. «insert» - добавление шаблона;

    4. not_edit - не удалось обновить шаблон. Возможно данные идентичны с обновляемым шаблоном;

    5. «delete» - шаблон удалена;

    6. «not_found» - шаблон с указанным идентификатором не обнаружен;

  • number_pattern

    • номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблона(если их было не сколько в запросе).

...