Данный REST API предназначен для взаимодействия клиентов с сервером уведомлений PLAY MOBILE. Все запросы к API осуществляются по протоколу HTTP. Тело запроса передается в формате JSON. При этом необходимо устанавливать Content-type: application/json. Также в параметре charset необходимо передавать значение кодировки - UTF-8. Формат для отправки даты и времени ISO 8601. Время передается в часовом поясе UTC.

Используется Basic аутентификация. При базовой аутентификации клиент вместе с запросом отправляет серверу логин и пароль. Эти данные отправляются в заголовке запроса Authorization в виде base64 кода. Authorization: Basic base64_encode(login:password) Так например, если логин и пароль admin, нужно добавить такой заголовок: Authorization: Basic YWRtaW46YWRtaW4=

Используются HTTP ответы с соответствующими кодами. Если какая-либо переменная ответа имеет несколько значений, они формируются в виде массива. Если в запросе было несколько значений какой-либо переменной, в ответе значения будут в том же порядке.

Если запрос содержит ошибку(код 400), то в теле ответа обязательно присутствует JSON-объект со следующими полями.

Данные коды возвращаются при получении HTTP ответа с кодом 400. И являются значениями поля “error_code”, описанного выше.

Сервер Play Mobile принимает запросы от сервера клиента на URL:
https://send.smsxabar.uz/broker-api/send
http://91.204.239.39/broker-api/send

Приведенный JSON демонстрирует все доступные в запросе параметры.

allexample.json

{
  "template-id": "",
  "priority": "",
  "blacklist-id": "", 
“timing”: {
    "localtime": "",
    "start-datetime": "",
    "end-datetime": "", “allowed-starttime”: “”, 
“allowed-endtime”: “”,
    "send-evenly": ""
  },
  "sms": { 
“originator”: “smsSender”, 
“ttl”: “300”, 
“content”: { 
“text”: “Test text”
    }
  },
  "call": {  
“originator”: “998900000000”, 
“ttl”: “300”, 
“content”: { 
“text”: “Test text”, 
“menu”: “Test”, 
“file”: “”
    },
    "retry-attempts": "",
    "retry-timeout": ""
  },
  "messages": [
    { 
“recipient”: “998900000001”, 
“message-id”: “abc000001”,
      "template-id": "",
      "priority": "",
      "variables": [], 
“timing”: {
        "localtime": "",
        "start-datetime": "",
        "end- datetime": "",  	 
	 	“allowed-starttime”: “”, 
 	“allowed-endtime”: “”
      },
      "sms": { 
 
	“originator”: “smsSender”, 	“ttl”: “300”, 
“content”: { 
“text”: “Test text”
        }
      },
      "call": {  
“originator”: “998900000002”, 
“ttl”: “300”, 
“content”: { 
“text”: “Test text”, 
“menu”: “Test”, 
“file”: “”
        },
        "retry-attempts": "",
        "retry-timeout": ""
      }
    ]
  }

Общие параметры.

Параметры объекта timing.

Параметры объектов каналов (sms, call).

Параметры объекта content для sms.

Параметры объекта content для call.

Параметры элемента массива messages.

Параметры ответа Успешный запрос имеет статус 200/OK и тела ответа Request is received

URL партнера: <base-url>/status
URL партнера используется для принудительного получения статусов отправленных сообщений от СМСЦ «Play Mobile».
Статус отправляется на URL партнера, как только получим его от сотового оператора.

Отправка единичного статуса

status.json

{ 
“messages”: [
        { 
“message-id”: “”, 
“channel”: “”, 
“status”: “”, 
“status-date”: “”, 
“description”: “”
        }
    ]
}

Массовая рассылка статуса

status.json

{ 
“messages”: [
        { 
“message-id”: “”, 
“channel”: “”, 
“status”: “”, 
“status-date”: “”, 
“description”: “”
        },
        { 
“message-id”: “”, 
“channel”: “”, 
“status”: “”, 
“status-date”: “”, 
“description”: “”
        }
    ]
}

Запрос статусов возвращает следующие статусы сообщений:
Delivered - доставлено;
Transmitted - передано оператору, от вас смс получили и отправили оператору, оператор еще не обработал, причиной может быть когда абонент вне зоны сети или выключен. После 24 часов статус сменится на Доставлено.;
NotDelivered - недоставлено, обычно причиной может быть то что абонент блокируется со стороны оператора(недостаточно средст или долг);
Rejected - один из основных причин это то что номер находится в черном списке;
Failed - ошибка при отправки запроса(например когда адрес отправителя указан неверно);
Expired - срок жизни смс истек(когда абонент в течение сутки не выходил на связь. У билайн если в теение часа).

Отправка единичного сообщения

send.json

{
    "messages": [
      {
        "recipient": "998900000000",
        "message-id": "abc000000001",
        "sms": {
          "originator": "3700",
          "content": {
            "text": "Test message"
          }
        }
      }
    ]
  }
 

Отправка массовой рассылки

sendMas.json

{
    "messages": [
        {
            "recipient": "9989хххххххх",
            "message-id": "abc00000001",
            "sms": {
                "originator": "3700",
                "content": {
                    "text": "Test text"
                }
            }
        },
        {
            "recipient": "9989xxxxxxxx",
            "message-id": "abc00000002",
            "sms": {
                "originator": "3700",
                "content": {
                    "text": "Test text 1"
                }
            }
        },
        {
            "recipient": "998970000000",
            "message-id": "abc00000003",
            "sms": {
                "originator": 3700,
                "content": {
                    "text": "Test text 2"
                }
            }
        }
    ]
}

Отправка единичного сообщения по шаблону

sendTemplate.json

{
    "messages": [
        {
            "template-id": "111",
            "recipient": "998900000000",
            "message-id": "abc0000001",
            "variables": {
                "NAME": "IVAN",
                "SURNAME": "IVANOV"
            }
        }
    ]
} 

Отправка массовой рассылки по расписанию

sendTiming.json

{priority": "",
    "timing": 
        {"localtime": "true",
            "start-datetime": "2017-11-05 10-00",
            "end-datetime": "2017-11-25 19-00",
            "allowed-starttime'""': "10-00 ","allowed-endtime": "19-00""send-evenly": "false"
},
"sms": {
    "originator": "smsSender",
    "content": {
        "text": "Test text"
    }
},
"messages": [
    {
        "recipient": "998900000000",
        "message-id": "abc00000145"
    },
    {
        "recipient": "998900000001",
        "message-id": "abc00000146"
    }
]
}
} 

Отправка массовой рассылки по шаблону

sendMasTemplate.json

{
"template-id": "112",
"messages": [
{
    "recipient": "998900000000",
    "message-id": "abc000001",
    "variables": {
        "NAME": "IVAN",
        "SURNAME": "IVANOV"
    }
},
{
    "recipient": "998900000001",
    "message-id": "abc000002",
    "variables": {
        "NAME": "PETR",
        "SURNAME": "KUZIN"
    }
},
{
    "recipient": "998900000002",
    "message-id": "abc000003",
    "variables": {
        "NAME": "VLADIMIR",
        "SURNAME": "NESTEROV"
    }
}
]
}