Проверка статусов

Для проверки статусов сообщения возможны 2 сценария:
1) Запрос Партнера для получения текущего статуса сообщения по id в платформе TERASMS
2) Запрос Партнера для получения произвольного количества конечных статусов

Запрос Партнера для получения текущего статуса сообщения по id в платформе TERASMS

Запрос Партнером на Платформу TERA SMS, для проверки статуса доставки сообщений, передается на:

https://auth.terasms.ru/outbox/status/ - для обычного GET/POST запроса;
https://auth.terasms.ru/outbox/status/json/ - для JSON запроса;
https://auth.terasms.ru/outbox/status/xml/ - для запроса в формате XML.

Параметры запроса

Параметр Значение Описание
login строка обязательный параметр
Логин и пароль Партнера на Платформе TERASMS
password
id число обязательный параметр
Идентификатор сообщения на Платформе TERASMS. Можно указать несколько ID через запятую

Ответ от платформы TERASMS для обычного GET/POST запроса

Пример запроса:
https://auth.terasms.ru/outbox/status/?login=Login&password=Password&id=ID

Для обычного GET/POSTзапроса результатом является строка в виде:
[ID Сообщения]:[ID Сегмента]:[Статус доставки]

Если сообщение состоит из нескольких сегментов, то результатом будет строка в виде:
[ID Сообщения]:[ID 1 Сегмента]:[Статус доставки],
[ID Сообщения]:[ID 2 Сегмента]:[Статус доставки]

Ответ от платформы TERASMS для XML запроса

Пример XML-запроса:

<?xml version="1.0"?>
    <request>
    <login>login</login>
        <password>password</password>
        <id>ID1, ID2</id>
    </request>

Пример XML-ответа:

<?xml version="1.0"?>
    <response>
        <status>0</status>
        <status_description>OK</status_description>
        <message_infos>
            <message_info>
                <id>id1</id>
                <pdu_id>pdu_id1</pdu_id>
                <status>12</status>
            </message_info>
            <message_info>
                <id>id2</id>
                <pdu_id>id2</pdu_id>
                <status>1</status>
            </message_info>
        </message_infos>
    </response>

Ответ от платформы TERASMS для JSON запроса

Пример JSON-запроса:

[
 {"id":1,
  "parts":[
   {"pdu_id":"1","status":"12"},
   {"pdu_id":"2","status":"12"}
  ]},
 ...
 {"id":n,
  "parts":[
   {"pdu_id":"n1","status":"13"},
   {"pdu_id":"n2","status":"13"}
  ]}
]

Пример JSON-ответа:

{
    "message_infos" : [
        {
            "id" : "id1",
            "pdu_id" :pdu_id1,
            "status" : "12"
        },
        {
            "id" : "id2",
            "pdu_id" : pdu_id2,
            "status" : "12"
        }
    ],
  "status" : 0,
  "status_description" : "OK"
}

Возможные статусы доставки SMS-сообщений

Статус Код Описание Тип
В очереди (queued) 0 Говорит о передаче сообщения в SMS-центр и попытках доставить сообщение, статус временный, и через некоторое время изменится
Возможные причины:
- Телефон выключен ли находится вне зоны действия сети
- Память телефона переполнена
- Не получен новый статус сообщения от SMS-центра
Стандартное время при котором предпринимаются попытки доставить сообщение 24 часа
промежуточный
Отправлено (sent) 1 Сообщение принято и находиться в локальной очереди, статус сообщения временный и через некоторое время изменится промежуточный
Доставлено (delivered) 12 Сообщение доставлено на телефон Конечный
Просрочено (expired) 13 Были предприняты попытки доставить сообщение в течение допустимого времени, но срок истек, и сообщение не было доставлено
Возможные причины:
- Телефон был выключен или находился вне зоны действия сети в течение возможного времени доставки
- Память телефона переполнена и не была освобождена, в течение возможного времени доставки
конечный
Не доставлено (not_delivered) 15 Сообщение не доставлено на телефон, повторных попыток доставить сообщение не будут предприниматься
Возможные причины:
- Номер не существует
- Абонент заблокирован
- Запрет приема сообщений
конечный
Отказ в передаче (rejected) 18 Получен отказ в передаче от SMS-центра, сообщение не доставлено
Возможные причины:
- Спам фильтр
- Неправильный формат номера абонента
- Неправильный формат имени отправителя
- Неправильный формат сообщения
конечный
Неизвестный статус (unknown) 17 Не был получен статус доставки сообщения от SMS-центра
Возможные причины:
- SMS-центр не предоставляет информацию о статусе доставки
- Ошибка на стороне оператора
конечный
Недействительно (error) 255 Cтатус говорит о том, что сообщение было отбито со стороны шлюза конечный

Запрос Партнера для получения произвольного количества конечных статусов

http://auth.terasms.ru/outbox/mstatus/?login=login&password=password&status_cnt=60 - для обычного GET/POST В ответе предоставляются только конечные статусы

Параметры запроса

Параметр Значение Описание
login строка обязательный параметр
Логин и пароль Партнера на Платформе TERASMS
password
status_cnt число не обязательный параметр
Количество статусов которое вы хотите получить в ответе. Максимальное количество статусов в ответе 2000, если параметр не указан по умолчанию количество равно 50
json 0 или 1 не обязательный параметр
По умолчанию равен 0.
Если установлен равным 1, то ответ будет в виде JSON-строки.

Формат ответа

json=0 или не используется:

{request_id}
{url_query_string_1}
...
{url_query_string_n}
Параметр Значение Описание
request_id строка Уникальный идентификатор ответа, с помощью него можно повторить запрос, если по какой-то причине вы не обработали полученные статусы
url_query_string строка url кодированная строка статуса по сегменту, где id - ID cообщения, pdu_id - ID cегмента, status - cтатус доставки

Пример ответа:

201311051311425278b64e0593e
id=59163896&pdu_id=90767812&status=12
id=59175729&pdu_id=90789240&status=12
id=59175737&pdu_id=90789273&status=12
id=59175727&pdu_id=90789233&status=12
id=59175739&pdu_id=90789279&status=12
id=59175730&pdu_id=90789244&status=12
id=59175730&pdu_id=90789245&status=12
id=59171659&pdu_id=90783497&status=15
id=59175739&pdu_id=90789281&status=12
id=59175729&pdu_id=90789241&status=12
id=59175739&pdu_id=90789280&status=12
id=59175730&pdu_id=90789243&status=12
id=59175750&pdu_id=90789295&status=12

Формат ответа (json=1):

[
 {"id":1,
  "parts":[
   {"pdu_id":"1","status":"12"},
   {"pdu_id":"2","status":"12"}
  ]},
 ...
 {"id":n,
  "parts":[
   {"pdu_id":"n1","status":"13"},
   {"pdu_id":"n2","status":"13"}
  ]}
]

Возможные коды ошибок:

Статус Описание Тип
-300 В очереди нет статусов
-301 Неизвестная ошибка
Готовы начать работу?
Если остались вопросы, свяжитесь с нами по телефону: 8 800 555-9412