Invitation — приглашения для регистрации новых абонентов (для обслуживающих организаций)

Группа методов Invitation предназначена для работы обслуживающих организаций с приглашениями для регистрации новых абонентов.

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

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

  • Владелец абонента
  • Оператор обслуживающей организации

Метод

Примечание

root

list 

Возвращает список ранее созданных приглашений

infoВозвращает информацию об указанном приглашении
sendСоздает приглашение и высылает адресату
blockБлокирует ранее созданное приглашение
unblockСнимает ранее установленную блокировку приглашения

invitation/list

Cписок приглашений для регистрации.

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1 000
customer *Число (+12.0)Код абонента1 010
start_date *Дата и время в строке формата ISOВыводить приглашения с датой создания не ранее start_date
end_date *Дата и время в строке формата ISOВыводить приглашения с датой создания не позднее end_date
Ответ
invitationСписок (0..*)Список приглашений
  - idСтрока переменная (9)Номер приглашения000000001
  - createdДата и время в строке формата ISOДата оформления приглашения28.02.2019 0:00:00
  - emailСтрока переменная (254)Адрес электронной почтыabramov@example.com
  - public_id *Строка переменная (36)Публичный идентификатор7713026678
  - activated *Дата и время в строке формата ISOДата активации приглашения01.01.0001 0:00:00
  - accountЧисло (+12.0)Код обслуживающей организации1 000
  - customer *Число (+12.0)Код абонента1 010
Пример запроса
{
  "account": 1000,
  "start_date": "2020-06-01T00:00:00",
  "end_date": "2020-07-31T23:59:59",
  "auth": {
    "account": 1000
  },
  "general": {
    "type": "usr",
    "method": "invitation/list"
  }
}
Пример ответа
{
  "invitation": [
    {
      "id": "000000001",
      "created": "2020-06-22T00:00:00",
      "email": "abramov@example.com",
      "public_id": "7713026678",
      "activated": "0001-01-01T00:00:00",
      "account": 1000,
      "customer": 1010
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 8,
    "sm_version": "1.0.90.7",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

invitation/info

Информация о приглашении для регистрации

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1 000
id *Строка переменная (9)Номер приглашения000000001
email *Строка переменная (254)Адрес электронной почтыabramov@example.com
customer *Число (+12.0)Код абонента1 010
Ответ
invitation *
Информация о приглашении
  - idСтрока переменная (9)Номер приглашения000000001
  - createdДата и время в строке формата ISOДата оформления приглашения28.02.2019 0:00:00
  - name *Строка переменная (64)Имя абонентаAbramov
  - emailСтрока переменная (254)Адрес электронной почтыabramov@example.com
  - phone *Строка переменная (500)Телефон абонента+7 (495) 123-45-67
  - public_id *Строка переменная (36)Публичный идентификатор7713026678
  - activated *Дата и время в строке формата ISOДата активации приглашения01.01.0001 0:00:00
  - blocked *Дата и время в строке формата ISOМомент блокирования приглашения01.01.0001 0:00:00
  - state_changed *Дата и время в строке формата ISOМомент последнего изменения состояния приглашения01.01.0001 0:00:00
  - state *СтрокаСостояние приглашения. Допустимые значения: activated (активировано), blocked (заблокировано), expired (истек срок активации), pending (ожидание активации)activated
  - block_cause *Строка переменная (255)Причина блокировки
  - timezone *Строка переменная (100)Часовой пояс абонентаEurope/Moscow
  - accountЧисло (+12.0)Код обслуживающей организации1 000
  - customer *Число (+12.0)Код абонента1 010
  - tariffsСписок (0..*)Тарифы приглашения
  -- numberЧисло (+5.0)Номер строки1
  -- amountЧисло (+3.0)Количество лицензий1
  -- parent *Число (+3.0)Номер строки родителя0
  -- periodicityСтрока неограниченной длиныТип периода действияmonth
  -- idСтрока переменная (9)Код тарифа000000001
Пример запроса
{
  "account": 1000,
  "id": "000000001",
  "email": "abramov@example.com",
  "customer": 1010,
  "auth": {
    "account": 1000
  },
  "general": {
    "type": "usr",
    "method": "invitation/info",
  }
}
Пример ответа
{
  "invitation": {
    "id": "000000001",
    "created": "2019-02-28T00:00:00",
    "name": "Abramov",
    "email": "abramov@example.com",
    "phone": "+7 (495) 123-45-67",
    "public_id": "7713026678",
    "activated": "0001-01-01T00:00:00",
    "blocked": "0001-01-01T00:00:00",
    "block_cause": "",
    "timezone": "Europe/Moscow",
    "account": 1000,
    "customer": 1010,
    "tariffs": [{
      "number": 1,
      "amount": 1,
      "parent": 0,
      "periodicity": "month",
      "id": "000000001"
     }]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 8,
    "sm_version": "1.0.90.7",
    "sm_timezone": "Europe/Moscow"
  }
}

Возможные значения поля periodicity:

  • day - День 

  • week - Неделя 

  • decade - Декада 

  • month - Месяц 

  • quarter - Квартал

  • half_year - Полугодие 

  • year - Год

 Вверх

invitation/send

Создать новое приглашение для регистрации

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1 000
emailСтрока переменная (254)Адрес электронной почтыpetrov@example.com
nameСтрока переменная (64)Имя абонентаPetrov
phone *Строка переменная (500)Телефон абонента+7 (495) 123-45-67
public_id *Строка переменная (36)Публичный идентификатор7713026678
Ответ
invitation *Строка переменная (9)Номер созданного приглашения000000003
Пример запроса
{
  "account": 1000,
  "email": "petrov@example.com",
  "name": "Petrov",
  "phone": "+7 (495) 123-45-67",
  "public_id": "7713026678",
  "auth": {
    "account": 1000
  },
  "general": {
    "type": "usr",
    "method": "invitation/send",
  }
}
Пример ответа
{
  "invitation": "000000003",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 8,
    "sm_version": "1.0.90.7",
    "sm_timezone": "Europe/Moscow"
  }
}

 Вверх

invitation/block

Метод устанавливает блокировку ранее созданного приглашения. Выполнение метода равнозначно установке флага "Блокировать приглашение" и выполнению команды "Записать" в карточке приглашения в интерфейсе Личного кабинета. Заблокировать можно только те приглашения, которые еще не были активированы адресатом (пустое значение поля activated).

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента (ОО).

idЧислоНомер блокируемого приглашения
block_cause *СтрокаОписание причин блокировки

Ответ: (1)



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

 Вверх

invitation/unblock

Метод снимает ранее установленную блокировку приглашения. Выполнение метода равнозначно отключению флага "Блокировать приглашение" и выполнению команды "Записать" в карточке приглашения в интерфейсе Личного кабинета. Снять Разблокировать можно только те приглашения, которые ранее были заблокированы (непустое значение поля blocked).

Параметр

Тип

Примечание

Запрос

account

Число

Код абонента (ОО).

idЧислоНомер разблокируемого приглашения

Ответ (1)



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

 Вверх