Перейти к содержанию

message#

Title: message
Type object
Required No
Additional properties Any type allowed

Description: Сообщение в переписке

Property Pattern Type Deprecated Definition Title/Description
- Id No string No - Идентификатор сообщения
- sentAt No string No - Дата и время отправки сообщения
- sentBy No object No In user.schema.json User
- type No enum (of string) No - Тип сообщения: TEXT-обычное сообщение, FILE-отправка файла, BACKWARD-автосообщение при возвратах
- text No string No - Текст сообщения. Пустой если messageType = FILE
- isPrivate No boolean No - Признак приватного сообщения
- isRead No boolean No - Признак, что сообщение прочитано второй стороной
- notReadBy No array of object No - Кем не прочитано. Исходя из этих отметок определяется и "есть ли у пользователя непрочитанное сообщение"
- hasReply No boolean No - Признак что на сообщение есть ответ
- replyForId No string No - Идентификатор сообщения, для которого текущее является ответом
- file No object No - -
- links No array of object No - Ссылки из сообщения

1. Property message > Id#
Type string
Required No
Format uuid

Description: Идентификатор сообщения

2. Property message > sentAt#
Type string
Required No
Format date-time

Description: Дата и время отправки сообщения

3. Property message > sentBy#

Title: User
Type object
Required No
Additional properties Any type allowed
Defined in user.schema.json

Description: Пользователь отправивший сообщение

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Уникальный идентификатор
+ type No enum (of string) No - Тип пользователя

- `CUSTOMER`: клиент
- `EMPLOYEE`: исполнитель
- `AGENT`: агент
- customer No object No In customer.schema.json Customer
- employee No object No In employee.schema.json Employee
- agent No object No In agent.schema.json Agent
+ email No string No Same as email E-mail пользователя
+ phone No string No - Номер мобильного телефона
+ role No enum (of string) No - Роль пользователя
+ status No enum (of string) No Same as status Статус пользователя
- statusPrevious No enum (of string) No Same as status Предыдущий статус пользователя
- statusReason No enum (of string) No - Причина установки текущего статуса

- `PASSWORD_MISTAKE`: ошибка ввода пароля
- `MANUAL_BLOCKED`: ручная блокировка
- passwordMistakeCounter No number No - Количество попыток ошибочного ввода пароля при входе в систему

3.1. Property message > sentBy > id#
Type string
Required Yes
Format uuid

Description: Уникальный идентификатор

3.2. Property message > sentBy > type#
Type enum (of string)
Required Yes

Description: Тип пользователя

  • CUSTOMER: клиент
  • EMPLOYEE: исполнитель
  • AGENT: агент

Must be one of: * "CUSTOMER" * "EMPLOYEE" * "AGENT"

3.3. Property message > sentBy > customer#

Title: Customer
Type object
Required No
Additional properties Not allowed
Defined in customer.schema.json

Description: Клиент

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Уникальный идентификатор
- createdBy No string No - id пользователя, создавшего клиента
+ type No enum (of string) No - Тип заказчика

- `COMPANY`: юр.лицо
- `PERSON`: физ.лицо
- `IP`: индивидуальный предприниматель
+ status No enum (of string) No In common/_common.schema.json#/status Статус клиента
- statusPrevious No enum (of string) No Same as status Предыдущий статус клиента
- email No string No In common/_common.schema.json#/email E-mail клиента
+ partner No string No - Партнер
- signingType No enum (of string) No - Способ подписания документов

- `HANDWRITTEN`: подписание вручную
- `SIMPLE_ELECTRONIC`: ПЭП
- canRequestSubsidiary No boolean No - Может запрашивать согласование плательщика
- prioritySubsidiaries No array No - -

3.3.1. Property message > sentBy > customer > id#
Type string
Required Yes
Format uuid

Description: Уникальный идентификатор

3.3.2. Property message > sentBy > customer > createdBy#
Type string
Required No

Description: id пользователя, создавшего клиента

3.3.3. Property message > sentBy > customer > type#
Type enum (of string)
Required Yes

Description: Тип заказчика

  • COMPANY: юр.лицо
  • PERSON: физ.лицо
  • IP: индивидуальный предприниматель

Must be one of: * "COMPANY" * "PERSON" * "IP"

3.3.4. Property message > sentBy > customer > status#
Type enum (of string)
Required Yes
Defined in common/_common.schema.json#/status

Description: Статус клиента

Must be one of: * "ACTIVE" * "INACTIVE" * "INVITED"

3.3.5. Property message > sentBy > customer > statusPrevious#
Type enum (of string)
Required No
Same definition as status

Description: Предыдущий статус клиента

3.3.6. Property message > sentBy > customer > email#
Type string
Required No
Defined in common/_common.schema.json#/email

Description: E-mail клиента

Restrictions
Must match regular expression (?=^[\w\W]{0,255}$)^\s*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])\s*$ Test

3.3.7. Property message > sentBy > customer > partner#
Type string
Required Yes

Description: Партнер

3.3.8. Property message > sentBy > customer > signingType#
Type enum (of string)
Required No

Description: Способ подписания документов

  • HANDWRITTEN: подписание вручную
  • SIMPLE_ELECTRONIC: ПЭП

Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"

3.3.9. Property message > sentBy > customer > canRequestSubsidiary#
Type boolean
Required No

Description: Может запрашивать согласование плательщика

3.3.10. Property message > sentBy > customer > prioritySubsidiaries#
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation N/A

3.4. Property message > sentBy > employee#

Title: Employee
Type object
Required No
Additional properties Not allowed
Defined in employee.schema.json

Description: Сотрудник

Property Pattern Type Deprecated Definition Title/Description
+ fio No object No In common/_common.schema.json#/fio ФИО

3.4.1. Property message > sentBy > employee > fio#
Type object
Required Yes
Additional properties Not allowed
Defined in common/_common.schema.json#/fio

Description: ФИО

Property Pattern Type Deprecated Definition Title/Description
+ lastName No string No - Фамилия
+ firstName No string No - Имя
- patronymic No string No - Отчество
3.4.1.1. Property message > sentBy > employee > fio > lastName#
Type string
Required Yes

Description: Фамилия

3.4.1.2. Property message > sentBy > employee > fio > firstName#
Type string
Required Yes

Description: Имя

3.4.1.3. Property message > sentBy > employee > fio > patronymic#
Type string
Required No

Description: Отчество

3.5. Property message > sentBy > agent#

Title: Agent
Type object
Required No
Additional properties Not allowed
Defined in agent.schema.json

Description: Agent

Property Pattern Type Deprecated Definition Title/Description
- id No string No - Уникальный идентификатор
- customer No object No - -
- fullName No string No - Название
- fullNameEnglish No string No - Название на английском языке
- inn No string No - ИНН
- kpp No string No - КПП
- ogrn No string No - ОГРН
- bankAccount No array of object No Same as bankAccounts Реквизиты банковского счета
- addressRegistration No object No Same as addressRegistrationEnglish Адрес регистрации
- addressRegistrationEnglish No object No Same as addressRegistrationEnglish Адрес регистрации на английском языке
- taxResidence No string No In common/_common.schema.json#/country Страна налогового резидентства
- representative No object No Same as representative Подписант
- stampPath No string No - Путь к файлу с изображением штампа
- additionalProperties No object No - -
- required No object No - -
+ status No enum (of string) No - Статус

- `ACTIVE`: действующий агент
- `INACTIVE`: заблокированный агент

3.5.1. Property message > sentBy > agent > id#
Type string
Required No
Format uuid

Description: Уникальный идентификатор

3.5.2. Property message > sentBy > agent > customer#
Type object
Required No
Additional properties Any type allowed

3.5.3. Property message > sentBy > agent > fullName#
Type string
Required No

Description: Название

3.5.4. Property message > sentBy > agent > fullNameEnglish#
Type string
Required No

Description: Название на английском языке

3.5.5. Property message > sentBy > agent > inn#
Type string
Required No

Description: ИНН

3.5.6. Property message > sentBy > agent > kpp#
Type string
Required No

Description: КПП

Restrictions
Min length 9
Max length 9
Must match regular expression ^[0-9]{9}$ Test

3.5.7. Property message > sentBy > agent > ogrn#
Type string
Required No

Description: ОГРН

3.5.8. Property message > sentBy > agent > bankAccount#
Type array of object
Required No
Same definition as bankAccounts

Description: Реквизиты банковского счета

3.5.9. Property message > sentBy > agent > addressRegistration#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

Description: Адрес регистрации

3.5.10. Property message > sentBy > agent > addressRegistrationEnglish#
Type object
Required No
Additional properties Any type allowed
Same definition as addressRegistrationEnglish

Description: Адрес регистрации на английском языке

3.5.11. Property message > sentBy > agent > taxResidence#
Type string
Required No
Defined in common/_common.schema.json#/country

Description: Страна налогового резидентства

Restrictions
Min length 3
Max length 3
Must match regular expression ^[A-Z]{3}$ Test

3.5.12. Property message > sentBy > agent > representative#
Type object
Required No
Additional properties Not allowed
Same definition as representative

Description: Подписант

3.5.13. Property message > sentBy > agent > stampPath#
Type string
Required No

Description: Путь к файлу с изображением штампа

3.5.14. Property message > sentBy > agent > additionalProperties#
Type object
Required No
Additional properties Any type allowed

3.5.15. Property message > sentBy > agent > required#
Type object
Required No
Additional properties Any type allowed

3.5.16. Property message > sentBy > agent > status#
Type enum (of string)
Required Yes

Description: Статус

  • ACTIVE: действующий агент
  • INACTIVE: заблокированный агент

Must be one of: * "ACTIVE" * "INACTIVE"

3.6. Property message > sentBy > email#
Type string
Required Yes
Same definition as email

Description: E-mail пользователя

3.7. Property message > sentBy > phone#
Type string
Required Yes

Description: Номер мобильного телефона

Restrictions
Must match regular expression ^(79)\d{9}$ Test

3.8. Property message > sentBy > role#
Type enum (of string)
Required Yes

Description: Роль пользователя

Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"

3.9. Property message > sentBy > status#
Type enum (of string)
Required Yes
Same definition as status

Description: Статус пользователя

3.10. Property message > sentBy > statusPrevious#
Type enum (of string)
Required No
Same definition as status

Description: Предыдущий статус пользователя

3.11. Property message > sentBy > statusReason#
Type enum (of string)
Required No

Description: Причина установки текущего статуса

  • PASSWORD_MISTAKE: ошибка ввода пароля
  • MANUAL_BLOCKED: ручная блокировка

Must be one of: * "PASSWORD_MISTAKE" * "MANUAL_BLOCKED"

3.12. Property message > sentBy > passwordMistakeCounter#
Type number
Required No

Description: Количество попыток ошибочного ввода пароля при входе в систему

4. Property message > type#
Type enum (of string)
Required No

Description: Тип сообщения: TEXT-обычное сообщение, FILE-отправка файла, BACKWARD-автосообщение при возвратах

Must be one of: * "TEXT" * "FILE" * "BACKWARD"

5. Property message > text#
Type string
Required No

Description: Текст сообщения. Пустой если messageType = FILE

6. Property message > isPrivate#
Type boolean
Required No

Description: Признак приватного сообщения

7. Property message > isRead#
Type boolean
Required No

Description: Признак, что сообщение прочитано второй стороной

8. Property message > notReadBy#
Type array of object
Required No

Description: Кем не прочитано. Исходя из этих отметок определяется и "есть ли у пользователя непрочитанное сообщение"

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
notReadBy items -

8.1. message > notReadBy > notReadBy items#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- role No string No - Роль пользователя, прочитавшего сообщение
- isNotificationSent No boolean No - Уведомление отправлено

8.1.1. Property message > notReadBy > notReadBy items > role#
Type string
Required No

Description: Роль пользователя, прочитавшего сообщение

8.1.2. Property message > notReadBy > notReadBy items > isNotificationSent#
Type boolean
Required No

Description: Уведомление отправлено

9. Property message > hasReply#
Type boolean
Required No
Format uuid

Description: Признак что на сообщение есть ответ

10. Property message > replyForId#
Type string
Required No
Format uuid

Description: Идентификатор сообщения, для которого текущее является ответом

11. Property message > file#
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- path No string No - Путь к сохраненному файлу
- name No string No - отображаемое название файла
- size No in64 No - Отображаемый размер файла

11.1. Property message > file > path#
Type string
Required No

Description: Путь к сохраненному файлу

11.2. Property message > file > name#
Type string
Required No

Description: отображаемое название файла

11.3. Property message > file > size#
Type in64
Required No

Description: Отображаемый размер файла
Type array of object
Required No

Description: Ссылки из сообщения

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
links items -
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- url No string No - URL адрес
Type string
Required No

Description: URL адрес

Generated using json-schema-for-humans on 2025-02-11 at 14:28:17 +0000