CardsMobile#
Тип сообщения CARDSMOBILE относится только к приложению «Кошелёк».
В сообщениях типа CARDSMOBILE доступна передача заголовка, текста и, опционально, изображения.
Отправка сообщений#
1 {
2 "login": "Login",
3 "password": "Password",
4 "destAddr": "79211234567",
5 "message": {
6 "type": "CARDSMOBILE",
7 "data": {
8 "text": "Hello, world!",
9 "title": "Super Title!",
10 "serviceNumber": "0000",
11 "ttl": 3600,
12 "ttlUnit": "SECONDS",
13 "content": {
14 "contentUrl": "http://ya.ru/123.jpg"
15 },
16 "target": "campaign",
17 "campaignId": "123",
18 "pushType": "PROMO"
19 }
20 }
21 }
Параметр |
Обязат. |
Тип данных |
Описание |
|---|---|---|---|
login |
да |
string |
Имя Партнера в системе. |
password |
да |
string |
Пароль Партнера в системе. |
extraParam |
нет |
string |
Дополнительные параметры, передаваемые в виде
Подробнее
Символ запятой в название параметра входить не может, но может
входить в его значение — в этом случае он должен удваиваться.
Пример: строка
|
useTimeDiff |
нет |
boolean |
Учитывание часового пояса при запуске рассылки. Подробнее
Если
Если
Значение по умолчанию: |
scheduleInfo |
нет |
object |
Расписание рассылки. ПодробнееЕсли не указано, отправляется сразу же, в момент получения запроса. |
scheduleInfo/
timeBegin
|
нет |
string |
Время начала. Подробнее
Например, |
scheduleInfo/
timeEnd
|
нет |
string |
Время окончания. Подробнее
Например, |
scheduleInfo/
weekdaysSchedule
|
нет |
string |
Дни рассылки. Подробнее
Задаются цифрами от Если ограничений по дням недели нет, то данный параметр может быть пустой или не передан в запросе. |
scheduleInfo/
deadline
|
нет |
string |
Дата окончания рассылки. Подробнее
Например, |
id |
нет |
string |
Уникальный идентификатор на стороне Партнёра. ПодробнееДанный параметр используется для контроля повторных отправок и дублирования (сервис контроля включается отдельно). Партнёр может вызывать Сервис-провайдера (запрос на отправку сообщения) с одним и тем же id несколько раз. При этом:
Сервис-провайдер опционально возвращает Партнёру данный идентификатор при его наличии в отчёте о доставке сообщения. |
destAddr |
нет |
string |
Номер телефона абонента. ПодробнееСодержит код страны, код оператора и номер телефона.
Для РФ код может быть
Примеры номеров: |
message |
да |
object |
Параметры отправляемого сообщения. |
message/type |
да |
enum |
Тип сообщения. Подробнее
Передается значение |
message/data |
да |
object |
Параметры отправляемых данных. |
message/data/
ttl
|
нет |
integer |
Срок жизни сообщения. ПодробнееДопустимый диапазон, секунд: от 30 до 86400. Примечание При Если |
message/data/
ttlUnit
|
нет |
enum |
Единица измерения периода доставки сообщения. Подробнее
Передается только вместе с Допустимые значения:
|
message/data/
serviceNumber
|
да |
string |
Сервисное имя, от которого осуществляется отправка сообщения. ПодробнееДля сообщений с типом CardsMobile данный параметр не является обязательным. Если в запросе данный параметр не передан, то берется значение из настроек интеграции.
Также, если в настройках нет значения данного параметра,
то будет использоваться сервисное имя |
message/data/
text
|
да |
string |
Текст отправляемого сообщения. ПодробнееКоличество символов, не более: 150. |
message/data/
title
|
да |
string |
Заголовок для текстового сообщения. ПодробнееКоличество символов, не более: 50. |
message/data/
target
|
нет |
enum |
Текстовая константа для сообщений с типом CardsMobile. ПодробнееОпределяет экран приложения, к которому должен быть осуществлен переход при нажатии на сообщение. Возможные значения:
Значение по умолчанию: |
message/data/
campaignId
|
нет |
string |
Текстовый идентификатор промо-акции для перехода. Подробнее
Обязателен, если Указывается ID акции в системе партнера или в Личном кабинете партнера в системе «Кошелёк для бизнеса». Количество символов, не более: 128. |
message/data/
pushType
|
нет |
enum |
Текстовая константа для сообщений с типом CardsMobile. ПодробнееОпределяет тип трафика, присвоенный сообщению партнером Возможные значения:
|
message/data/
content
|
нет |
object |
Параметры для отправки изображений. |
message/data/content/
contentCategory
|
нет |
enum |
Категория содержимого по ссылке contentUrl. Подробнее
Возможное значение: |
message/data/content/
contentUrl
|
нет |
string |
URL-адрес изображения. ПодробнееМаксимальная длина ссылки, символов: 512. Требования к изображению:
|
registeredDelivery |
нет |
integer |
Необходимость отчётов о доставке. ПодробнееВозможные значения:
|
notifyUrl |
нет |
string |
Имя хоста входящего API для получения отчета о доставке (см. Сервис получения статусов доставки сообщений). ПодробнееЭтот параметр в запросе необязательный, но при его отправке нужно учесть следующее:
|
Ответ на запрос#
После отправки сообщения Сервис-провайдер синхронно возвращает ответ. В случае успешной отправки возвращается HTTP-код 200 OK.
Ответ при успешной отправке#
1 {
2 "mtNum": "7390612217"
3 "id": "8770599"
4 }
Параметр |
Тип данных |
Описание |
|---|---|---|
mtNum |
string |
Идентификатор цепочки отправки, присваиваемый платформой Сервис-провайдера. |
id |
string |
Уникальный идентификатор на стороне Партнёра. Присутствует, если был передан при отправке. |
Ошибки при отправке#
Для ошибочных результатов HTTP-код ответа будет отличный от 200 OK (см. Коды ошибок отправки).
1 {
2 "error": {
3 "code": 1,
4 "description": "Service is unavailable"
5 }
6 }
Параметр |
Тип данных |
Описание |
|---|---|---|
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 |
Статусы доставки сообщений CardsMobile#
Для получения статусов сообщений CardsMobile необходимо настроить Сервис получения статусов доставки сообщений.
Коды ошибок доставки#
Коды ошибок доставки, в зависимости от типа сообщения, приведены в соответствующей вкладке в разделе Описание кодов ошибок.