Invitation — приглашения для регистрации новых абонентов

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

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

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

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

Метод	Назначение
invitation/info	Информация о приглашении для регистрации
invitation/list	Cписок приглашений для регистрации
invitation/send	Создать новое приглашение для регистрации
invitation/unblock	Снять ранее установленную блокировку приглашения
invitation/block	Заблокировать ранее созданное приглашение

invitation/info

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

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код обслуживающей организации	1000
id *	Строка переменная (9)	Номер приглашения. Обязательно, если не указан код приглашения.	000000001
code *	Строка переменная (36)	Код приглашения. Обязательно, если не указан номер приглашения.	5b89cc77-e4f6-479a-8839-95fee4c3c464
email *	Строка переменная (254)	Адрес электронной почты	abramov@example.com
customer *	Число (+12.0)	Код абонента	1010
Ответ: invitation (1)
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	Дата активации приглашения
blocked *	Дата и время в строке формата ISO	Момент блокирования приглашения
state_changed *	Дата и время в строке формата ISO	Дата изменения состояния
fast_completion *	Булево	Пропустить подтверждение регистрационных данных	true
state *	Строка (перечисление)	Состояние: activated (Активировано) blocked (Заблокировано) expired (Истек срок активации) pending (Ожидание активации)	activated
block_cause *	Строка переменная (255)	Причина блокировки
timezone *	Строка переменная (100)	Часовой пояс абонента	Europe/Moscow
account	Число (+12.0)	Код обслуживающей организации	1000
customer *	Число (+12.0)	Код абонента	1010
tariffs	Список (0..*)	Тарифы приглашения
- number	Число (+5.0)	Номер строки	1
- amount	Число (+5.0)	Количество лицензий	1
- parent *	Число (+3.0)	Номер строки родителя
- periodicity	Строка неограниченной длины	Тип периода действия	month
- id	Строка переменная (9)	Код тарифа	000000001
creation_apps	Список (0..*)	Создаваемые приложения
- apptype_id *	Строка переменная (22)	Код вида приложения	smtl
- amount	Число (+4.0)	Количество	1
properties	Список (0..*)	Дополнительные сведения
- key	Строка переменная (100)	Имя свойства	Тариф
- name *	Строка переменная (75)	Заголовок свойства	Тариф
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение свойства	Базовый
- type	Строка (перечисление)	Тип свойства: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Булево) date (Дата) decimal (Число) service (Услуга) service_provider_tariff (Тариф поставщика услуг) string (Строка) subscriber (Абонент) subscription (Подписка) tariff (Тариф) tariff_period (Период действия) undefined (Не определено) user (Пользователь)	additional_value
fields	Список (0..*)	Дополнительные реквизиты
- key	Строка переменная (100)	Имя реквизита	ИНН
- name *	Строка переменная (75)	Заголовок реквизита	ИНН
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение реквизита	7799555550
- type	Строка (перечисление)	Тип реквизита: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Булево) date (Дата) decimal (Число) service (Услуга) service_provider_tariff (Тариф поставщика услуг) string (Строка) subscriber (Абонент) subscription (Подписка) tariff (Тариф) tariff_period (Период действия) undefined (Не определено) user (Пользователь)	string

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/invitation/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "id": "000000001",
  "code": "5b89cc77-e4f6-479a-8839-95fee4c3c464",
  "email": "abramov@example.com",
  "customer": 1010,
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "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",
    "state_changed": "0001-01-01T00:00:00",
    "fast_completion": true,
    "state": "activated",
    "block_cause": "",
    "timezone": "Europe/Moscow",
    "account": 1000,
    "customer": 1010,
    "tariffs": [
      {
        "number": 1,
        "amount": 1,
        "parent": 0,
        "periodicity": "month",
        "id": "000000001"
      }
    ],
    "creation_apps": [
      {
        "apptype_id": "smtl",
        "amount": 1
      }
    ],
    "properties": [
      {
        "key": "Тариф",
        "name": "Тариф",
        "value": "Базовый",
        "type": "additional_value"
      }
    ],
    "fields": [
      {
        "key": "ИНН",
        "name": "ИНН",
        "value": "7799555550",
        "type": "string"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

invitation/list

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

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код обслуживающей организации	1000
customer *	Число (+12.0)	Код абонента	1010
start_date *	Дата и время в строке формата ISO	Дата создания приглашения. Начальная, для отбора по периоду	28.02.2019 0:00:00
end_date *	Дата и время в строке формата ISO	Дата создания приглашения. Конечная, для отбора по периоду	26.03.2020 0:00:00
Ответ: invitation (0..*)
id	Строка переменная (9)	Номер приглашения	000000001
created	Дата и время в строке формата ISO	Дата оформления приглашения	28.02.2019 0:00:00
email *	Строка переменная (254)	Адрес электронной почты	abramov@example.com
public_id *	Строка переменная (36)	Публичный идентификатор абонента	7713026678
activated *	Дата и время в строке формата ISO	Дата активации приглашения
account	Число (+12.0)	Код обслуживающей организации	1000
customer *	Число (+12.0)	Код абонента	1010

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/invitation/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "invitation": [
    {
      "id": "000000001",
      "created": "2019-02-28T00: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": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

invitation/send

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

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код обслуживающей организации	1000
email	Строка переменная (254)	Адрес электронной почты	petrov@example.com
name	Строка переменная (64)	Полное имя пользователя	Petrov
phone *	Строка переменная (500)	Телефон	+7 (495) 123-45-67
public_id *	Строка переменная (36)	Публичный идентификатор абонента	7713026678
properties *		Дополнительные сведения
- key	Строка переменная (100)	Имя свойства	Тариф
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение свойства	Базовый
- type *	Строка (перечисление)	Тип свойства: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Булево) date (Дата) decimal (Число) service (Услуга) service_provider_tariff (Тариф поставщика услуг) string (Строка) subscriber (Абонент) subscription (Подписка) tariff (Тариф) tariff_period (Период действия) undefined (Не определено) user (Пользователь)	additional_value
fields *		Дополнительные реквизиты
- key	Строка переменная (100)	Имя реквизита	ИНН
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение реквизита	7799555550
- type *	Строка (перечисление)	Тип реквизита: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Булево) date (Дата) decimal (Число) service (Услуга) service_provider_tariff (Тариф поставщика услуг) string (Строка) subscriber (Абонент) subscription (Подписка) tariff (Тариф) tariff_period (Период действия) undefined (Не определено) user (Пользователь)	string
Ответ: invitation (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/invitation/send
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "email": "petrov@example.com",
  "name": "Petrov",
  "phone": "+7 (495) 123-45-67",
  "public_id": "7713026678",
  "properties": [
    {
      "key": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "invitation": "000000003",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

invitation/unblock

Снять ранее установленную блокировку приглашения

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код обслуживающей организации	1000
id	Строка переменная (9)	Номер приглашения	000000002
Ответ: invitation (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/invitation/unblock
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "id": "000000002",
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

invitation/block

Заблокировать ранее созданное приглашение

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код обслуживающей организации	1000
id	Строка переменная (9)	Номер приглашения	000000001
block_cause *	Строка переменная (255)	Причина блокировки	Тестовое приглашение
Ответ: invitation (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/invitation/block
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1000,
  "id": "000000001",
  "block_cause": "Тестовое приглашение",
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх