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

Дата последней модификации страницы: 19.09.2024

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

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

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

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

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

invitation/block

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

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
idСтрока переменная (9)Номер приглашения000000001
block_cause *Строка переменная (255)Причина блокировкиТестовое приглашение
Ответ
Нет параметров
Пример запроса  Развернуть 
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": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

invitation/info

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

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код обслуживающей организации1000
id *Строка переменная (9)Номер приглашения000000001
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Дата изменения состояния
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
Пример запроса  Развернуть 
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",
  "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",
    "state": "activated",
    "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": 28,
    "sm_version": "1.1.37.1",
    "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": 28,
    "sm_version": "1.1.37.1",
    "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
Ответ: 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",
  "auth": {
    "account": 1000
  }
}
Пример ответа  Развернуть 
{
  "invitation": "000000003",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "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": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх