Группа методов Invitation предназначена для работы обслуживающих организаций с приглашениями для регистрации новых абонентов.
Сводка по методам
Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать одной из следующих ролей:
- Владелец абонента
- Оператор обслуживающей организации
Метод | Примечание |
---|---|
root | |
Возвращает список ранее созданных приглашений | |
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 |
Строка переменная (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 |
Строка переменная (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 |
Строка переменная (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) | ||
Нет параметров |