MAX#
В разделе приведено описание особенностей передачи абонентам сообщений на устройства с установленным мессенджером MAX, в котором у Партнёров есть возможность взаимодействовать со своими клиентами через бота.
На данный момент Сервис-провайдер обеспечивает:
отправку текстовых сообщений;
получение статусов доставки сообщений;
при необходимости, в случае недоставки в MAX - доотправку сообщений в SMS (каскадная передача).
Запрос на отправку#
Содержание запроса соответствует требованиям к стандартному запросу, см. Структура запроса.
1 {
2 "login":"ВАШ_ЛОГИН",
3 "password":"ВАШ_ПАРОЛЬ",
4 "destAddr":"НОМЕР_АБОНЕНТА",
5 "message":{
6 "type":"MAX",
7 "data":{
8 "text":"ТЕКСТ_СООБЩЕНИЯ.",
9 "serviceNumber":"ИМЯ_ОТПРАВИТЕЛЯ"
10 }
11 }
12 }
Параметр |
Обязат. |
Тип |
Описание |
---|---|---|---|
login |
да |
string |
Имя Партнёра. |
password |
да |
string |
Пароль Партнёра. |
destAddr |
да |
string |
Номер телефона абонента. ПодробнееЦелое положительное число. Максимальная длина: 15 цифр.
Содержит код страны, код оператора и номер телефона.
Для РФ код может быть
Примеры: Если номер абонента не передан, либо не является валидным номером телефона, запрос будет отклонён с ошибкой (см. Ошибки при отправке). |
message |
да |
object |
Параметры отправляемого сообщения. ПодробнееСодержит информацию о типе сообщения и его содержимом. |
{message}
type
|
да |
enum |
Тип сообщения. Указать значение |
{message}
data
|
да |
object |
Параметры отправляемых данных. |
{message/data}
text
|
да |
string |
Текст отправляемого сообщения. ПодробнееТекст сообщения может быть на кириллице или латинице, содержать эмоджи. Количество символов: не более 4000. Если параметр не передан, либо его значение не валидно, запрос будет отклонён с ошибкой (см. Ошибки при отправке). |
{message/data}
serviceNumber
|
да |
string |
Сервисное имя, от которого осуществляется отправка сообщения. ПодробнееПри каскадной отправке в запросе (в основном канале MAX) необходимо указывать сервисное имя, отдельно согласованное со службой технической поддержки Сервис-провайдера. Если параметр не передан, либо его значение не валидно, запрос будет отклонён с ошибкой (см. Ошибки при отправке). |
cascadeChainLink |
нет |
object |
Параметры каскадных сообщений. См. Каскадная рассылка.
|
Ответ на запрос#
После отправки сообщения Сервис-провайдер синхронно возвращает ответ.
Ответ при успешной отправке#
В случае успешной отправки возвращается HTTP-код 200 OK
.
1 {
2 "mtNum": "7390612217"
3 "id": "1234567"
4 }
Параметр |
Тип данных |
Описание |
---|---|---|
mtNum |
string |
Идентификатор цепочки отправки, присваиваемый платформой Сервис-провайдера. |
id |
string |
Уникальный идентификатор на стороне Партнёра. Присутствует, если был передан при отправке. |
Ошибки при отправке#
Для ошибочных результатов HTTP-код ответа будет отличный от 200 OK
(см. Коды ошибок отправки).
1 {
2 "error": {
3 "code": 8,
4 "description": "destAddr is not correct"
5 },
6 "extendedDescription": "Невалидный номер: 7999999999999999"
7 }
Параметр |
Тип данных |
Описание |
---|---|---|
error |
object |
Информация об ошибке. |
error/code |
int |
Код ошибки. |
error/description |
string |
Краткое описание ошибки. |
extendedDescription |
string |
Необязательный параметр. Содержит подробное описание ошибки. |
Коды ошибок отправки#
Код |
Описание |
HTTP-код |
---|---|---|
1 |
Service is unavailable |
503 |
2 |
Invalid IP-address |
403 |
3 |
Too many connections |
429 |
4 |
Invalid request |
400 |
5 |
Invalid login |
401 |
6 |
Invalid password |
401 |
7 |
serviceNumber is not defined |
400 |
8 |
destAddr is not correct |
406 |
9 |
Message type is not correct |
406 |
10 |
Prohibited sending duplicates |
409 |
11 |
Invalid TTL |
406 |
100 |
100 |
500 |
Статусы доставки сообщений#
Для получения статусов сообщений необходимо настроить Сервис получения статусов доставки сообщений.