Начисление доп. баллов клиенту

Метод позволяет произвести начисление баллов клиенту по заранее созданному шаблону начисления дополнительных баллов, а также изменить часть данных сохраненных по шаблону дополнительного начисления во время выполнения данного метода. Перед выполнением данного метода, в админ. панели должен быть создан шаблон начисления доп. баллов по API.

Запрос:

POST: https://bm-app.com/internal/api/mark/setMarkIncrease

Description

orderId: (number, required) - id шаблона начисления для API из админ. панели на вкладке: Маркетинг > Начисление доп. баллов
customerPhone: (string, required) - номер телефона клиента, которому нужно произвести начисление баллов, клиент должен быть уже в системе
markIncrease: (number, optional) - количество баллов, которое нужно начислить клиенту. Нужно указывать, если оно отличается от сохраненного количества баллов в шаблоне доп. начисления для API. Если не указать, то начислится количество баллов из шаблона
push: (object, optional) - не обязательный объект, который уже содержится в шаблоне начисления для API, если нужно изменить значения отправляемого push, то отсылаем его в данном методе, в противном случае подставятся значения сохраненные в шаблоне начисления для API
header: (string, optional) - текст заголовка push
message: (string, optional) - текст соообщения push
sms: (object, optional) - не обязательный объект, который уже содержится в шаблоне начисления для API, если нужно изменить значения отправляемого sms, то отсылаем его в данном методе, в противном случае подставятся значения сохраненные в шаблоне начисления для API
message: (string, optional) - текст соообщения sms
includeShortURL: (boolean, optional) - добавлять короткую ссылку в сообщение или нет
notificationTypes: (object, optional) - если не нужно оповещать клиента, то отправляется null. Если нужно оповестить клиента, то формируется массив, в котором указываются каким типом оповещений произвести сообщение клиенту. Типы: “SMS”, “PUSH”. Порядок значений в массиве определяет приоритет по типу оповещения

Headers

BM-ApiKey: token

Body

{
"orderId": 9232,
"customerPhone": "+7 (999) 999-99-99",
"markIncrease": 200,
"push": {
"header": "Push header",
"message": "Push message 1"
},
"sms": {
"message": "message text 1",
"includeShortURL": false
},
"notificationTypes": [
"PUSH", "SMS"
]
}

Ответ:

Body:

{
"markIncrease": {
"abstractMarkIncreaseEvent": {
"state": "created",
"name": "zxczx",
"markIncrease": 200,
"notificationTypes": {},
"push": {
"header": "Push header",
"message": "Push message 1"
},
"sms": {
"message": "message text 1",
"includeShortURL": false
},
"fullMessage": {
"messageType": "AppSimpleMessage",
"header": "zcxzc",
"message": "czxcxzzxczx"
},
"markDecreaseConfig_v2": {
"deleted": false,
"timeCreate": "2023-08-22 19:31:02.475",
"company": {
"companyName": "VapeRoom",
"companyLogoUrl": "https://bmappmobileapp.s3-us-west-1.amazonaws.com/21_233a879c-855f-41fa-8dfc-e0ec8959369a.png",
"companyId": 21,
"timeZoneOffset": 3,
"timeCreate": "2019-06-28 08:51:13.0",
"isValid": true,
"countryCode": "RU",
"languageCode": "ru"
},
"eventType": "mIncrease",
"eventId": 9232,
"decreaseDays": 7,
"notifyBeforeDecreaseDays": 2,
"notifyIfMarkDecreaseMoreThan": 0,
"notificationPriorityList": [
"PUSH"
],
"push": {
"header": "Напоминание о сгорании баллов!",
"message": "${time} у Вас сгорят ${mark} баллов, успейте потратить!"
}
},
"company": {
"companyName": "VapeRoom",
"companyLogoUrl": "https://bmappmobileapp.s3-us-west-1.amazonaws.com/21_233a879c-855f-41fa-8dfc-e0ec8959369a.png",
"companyId": 21,
"timeZoneOffset": 3,
"timeCreate": "2019-06-28 08:51:13.0",
"isValid": true,
"countryCode": "RU",
"languageCode": "ru"
},
"orderId": 9232,
"orderTable": "mIncrease",
"time": "2023-08-22 22:31:02.0"
},
"customer": {
"customerId": 2859356,
"customerLogin": "+7 (921) 772-69-68",
"customerName": "Сергей",
"customerSurname": "Токаревggg",
"customerPatronymic": "Александрович",
"customerMale": true,
"numberVerified": false,
"customerQRCode": "2859356_303194257152699088",
"hasMobileApp": true,
"appName": "BonusMoney",
"timeCreate": "2023-07-25 07:23:21.492564",
"timeUpdate": "2023-08-23 10:53:57.992084",
"isBlocked": false,
"isDeleted": false,
"creationType": "REGISTRATION_LINK"
},
"markBefore": 1213.89,
"markIncrease": 200,
"markDecrease": 0,
"markCurrent": 1413.89,
"isSendSms": false,
"isReadFromSms": false,
"isSendPush": false,
"isReadFromPush": false,
"company": {
"companyName": "VapeRoom",
"companyLogoUrl": "https://bmappmobileapp.s3-us-west-1.amazonaws.com/21_233a879c-855f-41fa-8dfc-e0ec8959369a.png",
"companyId": 21,
"timeZoneOffset": 3,
"timeCreate": "2019-06-28 08:51:13.0",
"isValid": true,
"countryCode": "RU",
"languageCode": "ru"
},
"orderId": 1418260,
"orderTable": "relationCustomerMIncrease",
"time": "2023-08-23 14:21:17.0"
}
}

При выполнении запросов возможно получение следующих ошибок:

  • HTTP Status 503 Превышено максимальное число запросов в секунду
  • HTTP Status 413 Превышен максимальный размер тела запроса
  • HTTP Status 401 API ключ не найден
  • HTTP Status 402 Система Bonus Money не оплачена или закончилось число транзакций предусмотренное тарифом
  • HTTP Status 400 Некорректный запрос, описание ошибки присылается в теле ответа в формате Json, доступное по ключу: message