Promo_Code — работа абонентов сервиса с промокодами

Группа методов Promo_Code внешнего программного интерфейса Менеджера сервиса предназначена для работы абонентов сервиса с промокодами.

Сводка по методам

Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:

  • Владелец абонента

Метод

Примечание

root

activate 

Выполняет активацию промокода

listПолучить список ранее активированных абонентом промокодов.

promo_code/activate

Метод выполняет активацию указанного промокода для указанного абонента. Аналогов для этого метода в интерфейсе Личного кабинета нет.

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента

code

Строка

Промо-код

subid*СтрокаДополнительная информация о промокоде
Ответ (1)

нет параметров

При неудачной активации метод возвращает значение кода возврата (параметр ответа  general.response):

  • 10452, если промокод не найден или для него исчерпано количество активаций
  • 10453, если промокод заблокирован
  • 10454, если срок действия промокода истек

Пример запроса  Развернуть
{
  "account": 1010,
  "subid": "email",
  "code": "Base",
  "auth": {
    "account": 1010
  },
  "general": {
    "type": "usr",
    "method": "promo_code/activate"
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 12,
    "sm_version": "1.0.100.24",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

promo_code/list

Метод возвращает список ранее активированных абонентом промокодов. Аналогов для этого метода в интерфейсе Личного кабинета нет.

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента.

Ответ code (0..)

idСтрокаПромо-код
activatedДата и время Момент активации промокода 
successБУлевоРезультат активации (успешно, или нет)
Пример запроса  Развернуть
{
  "account": 1010,
  "auth": {
    "account": 1010
  },
  "general": {
    "type": "usr",
    "method": "promo_code/list"
  }
}
Пример ответа  Развернуть
{
  "code": [
    {
      "activated": "2019-02-28T00:00:00",
      "success": true,
      "id": "CRMday"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 12,
    "sm_version": "1.0.100.24",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх