POST запрос

Спецификации для запроса статуса: JSON, XML, HTTP GET

Метод отправки POST

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

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml/state.php

Параметры запроса на отправку сообщения

Параметр
Тип
Описание

request

.security

.login

[value]*

String

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

request

.security

.password

[value]*

String

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

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

request

.get_state

.id_sms*

Int

Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.

*- обязательный параметр

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

<?xml version="1.0" encoding="utf-8" ?>
<response>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус" viber="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" viber="Статус">Статус</state>
</response>
Параметр
Тип
Описание

response

.state

[id_sms]

Int

Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения

response

.state

[time]

Date

Время изменения статуса

response

.state

String

Последний статус сообщения:

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

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

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

  • «deliver» - сообщение доставлено.

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

  • «partly_deliver» - сообщение было отправлено, но статус так и не был получен

response

.state

[sms]

String

Статус SMS сообщения.

response

.state

[viber]

String

Статус Viber сообщения.

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

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
Параметр
Тип
Описание

response

.error

String

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

  • Неправильный формат XML документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

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

<?xml  version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
    <get_state>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
    </get_state>
</request>

Last updated