Перейти к основному содержимому

DialogueFeedbackBundleRead

Полный набор обратной связи по диалогу — его ревью, оценки, комментарии и канбан-карточки.

review object
anyOf
idIdrequired

Уникальный числовой идентификатор записи.

submitted_at objectrequired
anyOf
date-time
dialogue_idDialogue Idrequired

Идентификатор диалога, к которому относится запись.

author_idAuthor Idrequired
ratings object[]
  • Array [
  • idIdrequired

    Уникальный числовой идентификатор записи.

    option_idOption Idrequired
    review_idReview Idrequired
    scoreScorerequired
    selected_suggestionsstring[]
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

  • ]
  • dialogue_comment object
    anyOf
    textTextrequired

    Текст комментария.

    author_idAuthor Idrequired
    stateFeedbackCommentState

    Открыт комментарий или решён.

    Possible values: [open, resolved]

    Default value: open
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    message_id object

    Идентификатор сообщения, к которому привязан комментарий, если он привязан к сообщению.

    anyOf
    integer
    msg_start_idx object

    Начальный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    msg_end_idx object

    Конечный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    rating_id object

    Идентификатор оценки, к которой привязан комментарий, если он привязан к оценке.

    anyOf
    integer
    comment_id object

    Идентификатор родительского комментария, если это ответ.

    anyOf
    integer
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    author objectrequired

    Пользователь платформы (без учётных данных).

    idIdrequired

    Уникальный числовой идентификатор записи.

    usernameUsernamerequired

    Логин пользователя.

    email object

    Email, по которому локальный пользователь сопоставляется при входе через Яндекс ID, если задан.

    anyOf
    string
    roleUserRolerequired

    Роль пользователя — user, manager или admin.

    Possible values: [user, manager, admin]

    is_activeIs Active

    Может ли пользователь аутентифицироваться и работать в платформе.

    Default value: true
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    company_idsinteger[]

    Компании, к которым у пользователя есть доступ. Пользователи admin имеют доступ ко всем компаниям.

    message_context object
    anyOf
    idIdrequired

    Уникальный числовой идентификатор записи.

    messageMessagerequired
    file_caption object
    anyOf
    string
    display_textDisplay Textrequired
    quote object
    anyOf
    string
    repliesundefined[]
    kanban_card object
    anyOf
    comment_idComment Idrequired
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    columnFeedbackKanbanColumnrequired

    Possible values: [new, grooming, in_progress, done]

    orderOrderrequired

    Possible values: >= 0

    notesNotes
    Default value:
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    inline_comments object[]
  • Array [
  • textTextrequired

    Текст комментария.

    author_idAuthor Idrequired
    stateFeedbackCommentState

    Открыт комментарий или решён.

    Possible values: [open, resolved]

    Default value: open
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    message_id object

    Идентификатор сообщения, к которому привязан комментарий, если он привязан к сообщению.

    anyOf
    integer
    msg_start_idx object

    Начальный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    msg_end_idx object

    Конечный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    rating_id object

    Идентификатор оценки, к которой привязан комментарий, если он привязан к оценке.

    anyOf
    integer
    comment_id object

    Идентификатор родительского комментария, если это ответ.

    anyOf
    integer
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    author objectrequired

    Пользователь платформы (без учётных данных).

    idIdrequired

    Уникальный числовой идентификатор записи.

    usernameUsernamerequired

    Логин пользователя.

    email object

    Email, по которому локальный пользователь сопоставляется при входе через Яндекс ID, если задан.

    anyOf
    string
    roleUserRolerequired

    Роль пользователя — user, manager или admin.

    Possible values: [user, manager, admin]

    is_activeIs Active

    Может ли пользователь аутентифицироваться и работать в платформе.

    Default value: true
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    company_idsinteger[]

    Компании, к которым у пользователя есть доступ. Пользователи admin имеют доступ ко всем компаниям.

    message_context object
    anyOf
    idIdrequired

    Уникальный числовой идентификатор записи.

    messageMessagerequired
    file_caption object
    anyOf
    string
    display_textDisplay Textrequired
    quote object
    anyOf
    string
    repliesundefined[]
    kanban_card object
    anyOf
    comment_idComment Idrequired
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    columnFeedbackKanbanColumnrequired

    Possible values: [new, grooming, in_progress, done]

    orderOrderrequired

    Possible values: >= 0

    notesNotes
    Default value:
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

  • ]
  • rating_comments object[]
  • Array [
  • textTextrequired

    Текст комментария.

    author_idAuthor Idrequired
    stateFeedbackCommentState

    Открыт комментарий или решён.

    Possible values: [open, resolved]

    Default value: open
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    message_id object

    Идентификатор сообщения, к которому привязан комментарий, если он привязан к сообщению.

    anyOf
    integer
    msg_start_idx object

    Начальный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    msg_end_idx object

    Конечный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    rating_id object

    Идентификатор оценки, к которой привязан комментарий, если он привязан к оценке.

    anyOf
    integer
    comment_id object

    Идентификатор родительского комментария, если это ответ.

    anyOf
    integer
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    author objectrequired

    Пользователь платформы (без учётных данных).

    idIdrequired

    Уникальный числовой идентификатор записи.

    usernameUsernamerequired

    Логин пользователя.

    email object

    Email, по которому локальный пользователь сопоставляется при входе через Яндекс ID, если задан.

    anyOf
    string
    roleUserRolerequired

    Роль пользователя — user, manager или admin.

    Possible values: [user, manager, admin]

    is_activeIs Active

    Может ли пользователь аутентифицироваться и работать в платформе.

    Default value: true
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    company_idsinteger[]

    Компании, к которым у пользователя есть доступ. Пользователи admin имеют доступ ко всем компаниям.

    message_context object
    anyOf
    idIdrequired

    Уникальный числовой идентификатор записи.

    messageMessagerequired
    file_caption object
    anyOf
    string
    display_textDisplay Textrequired
    quote object
    anyOf
    string
    repliesundefined[]
    kanban_card object
    anyOf
    comment_idComment Idrequired
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    columnFeedbackKanbanColumnrequired

    Possible values: [new, grooming, in_progress, done]

    orderOrderrequired

    Possible values: >= 0

    notesNotes
    Default value:
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

  • ]
  • kanban_cards object[]
  • Array [
  • comment_idComment Idrequired
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    columnFeedbackKanbanColumnrequired

    Колонка канбана, в которой находится карточка (new, grooming, in_progress, done).

    Possible values: [new, grooming, in_progress, done]

    orderOrderrequired

    Порядок карточки внутри её колонки.

    Possible values: >= 0

    notesNotes

    Произвольные заметки на карточке.

    Default value:
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    comment objectrequired

    Комментарий ревьюера к диалогу вместе с вложенными ответами. Комментарий привязан ровно к одному из: сообщению (опционально к диапазону символов в нём), оценке или другому комментарию; иначе он относится к диалогу в целом.

    textTextrequired

    Текст комментария.

    author_idAuthor Idrequired
    stateFeedbackCommentState

    Открыт комментарий или решён.

    Possible values: [open, resolved]

    Default value: open
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    message_id object

    Идентификатор сообщения, к которому привязан комментарий, если он привязан к сообщению.

    anyOf
    integer
    msg_start_idx object

    Начальный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    msg_end_idx object

    Конечный индекс символа для встроенного комментария к части сообщения.

    anyOf
    integer
    rating_id object

    Идентификатор оценки, к которой привязан комментарий, если он привязан к оценке.

    anyOf
    integer
    comment_id object

    Идентификатор родительского комментария, если это ответ.

    anyOf
    integer
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    author objectrequired

    Пользователь платформы (без учётных данных).

    idIdrequired

    Уникальный числовой идентификатор записи.

    usernameUsernamerequired

    Логин пользователя.

    email object

    Email, по которому локальный пользователь сопоставляется при входе через Яндекс ID, если задан.

    anyOf
    string
    roleUserRolerequired

    Роль пользователя — user, manager или admin.

    Possible values: [user, manager, admin]

    is_activeIs Active

    Может ли пользователь аутентифицироваться и работать в платформе.

    Default value: true
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    company_idsinteger[]

    Компании, к которым у пользователя есть доступ. Пользователи admin имеют доступ ко всем компаниям.

    message_context object
    anyOf
    idIdrequired

    Уникальный числовой идентификатор записи.

    messageMessagerequired
    file_caption object
    anyOf
    string
    display_textDisplay Textrequired
    quote object
    anyOf
    string
    repliesundefined[]
    kanban_card object
    anyOf
    comment_idComment Idrequired
    dialogue_idDialogue Idrequired

    Идентификатор диалога, к которому относится запись.

    columnFeedbackKanbanColumnrequired

    Possible values: [new, grooming, in_progress, done]

    orderOrderrequired

    Possible values: >= 0

    notesNotes
    Default value:
    idIdrequired

    Уникальный числовой идентификатор записи.

    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

  • ]
  • DialogueFeedbackBundleRead
    {
    "review": {
    "id": 0,
    "submitted_at": "2024-07-29T15:51:28.071Z",
    "dialogue_id": 0,
    "author_id": 0
    },
    "ratings": [
    {
    "id": 0,
    "option_id": 0,
    "review_id": 0,
    "score": 0,
    "selected_suggestions": [
    "string"
    ],
    "created_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "dialogue_comment": {
    "text": "string",
    "author_id": 0,
    "state": "open",
    "dialogue_id": 0,
    "message_id": 0,
    "msg_start_idx": 0,
    "msg_end_idx": 0,
    "rating_id": 0,
    "comment_id": 0,
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": {
    "id": 0,
    "username": "string",
    "email": "string",
    "role": "user",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "company_ids": [
    0
    ]
    },
    "message_context": {
    "id": 0,
    "message": "string",
    "file_caption": "string",
    "display_text": "string",
    "quote": "string"
    },
    "replies": [
    null
    ],
    "kanban_card": {
    "comment_id": 0,
    "dialogue_id": 0,
    "column": "new",
    "order": 0,
    "notes": "",
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    },
    "inline_comments": [
    {
    "text": "string",
    "author_id": 0,
    "state": "open",
    "dialogue_id": 0,
    "message_id": 0,
    "msg_start_idx": 0,
    "msg_end_idx": 0,
    "rating_id": 0,
    "comment_id": 0,
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": {
    "id": 0,
    "username": "string",
    "email": "string",
    "role": "user",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "company_ids": [
    0
    ]
    },
    "message_context": {
    "id": 0,
    "message": "string",
    "file_caption": "string",
    "display_text": "string",
    "quote": "string"
    },
    "replies": [
    null
    ],
    "kanban_card": {
    "comment_id": 0,
    "dialogue_id": 0,
    "column": "new",
    "order": 0,
    "notes": "",
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    }
    ],
    "rating_comments": [
    {
    "text": "string",
    "author_id": 0,
    "state": "open",
    "dialogue_id": 0,
    "message_id": 0,
    "msg_start_idx": 0,
    "msg_end_idx": 0,
    "rating_id": 0,
    "comment_id": 0,
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": {
    "id": 0,
    "username": "string",
    "email": "string",
    "role": "user",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "company_ids": [
    0
    ]
    },
    "message_context": {
    "id": 0,
    "message": "string",
    "file_caption": "string",
    "display_text": "string",
    "quote": "string"
    },
    "replies": [
    null
    ],
    "kanban_card": {
    "comment_id": 0,
    "dialogue_id": 0,
    "column": "new",
    "order": 0,
    "notes": "",
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    }
    ],
    "kanban_cards": [
    {
    "comment_id": 0,
    "dialogue_id": 0,
    "column": "new",
    "order": 0,
    "notes": "",
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "comment": {
    "text": "string",
    "author_id": 0,
    "state": "open",
    "dialogue_id": 0,
    "message_id": 0,
    "msg_start_idx": 0,
    "msg_end_idx": 0,
    "rating_id": 0,
    "comment_id": 0,
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": {
    "id": 0,
    "username": "string",
    "email": "string",
    "role": "user",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "company_ids": [
    0
    ]
    },
    "message_context": {
    "id": 0,
    "message": "string",
    "file_caption": "string",
    "display_text": "string",
    "quote": "string"
    },
    "replies": [
    null
    ],
    "kanban_card": {
    "comment_id": 0,
    "dialogue_id": 0,
    "column": "new",
    "order": 0,
    "notes": "",
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    }
    }
    ]
    }