Общее описание и условия работы

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

Оценка по шкале от 1 до 5 звёзд (оценка, stars)
Выбор одного варианта из нескольких предложенных (выбор, radio)
Комментарий пользователя (комментарий, comment)

Для каждого вопроса может быть только один ответ. В виджете чата между формами можно переключаться по нажатию на соответствующие кнопки (вперёд и назад), а также изменять свои ответы до отправки. В остальных доступных каналах общения формы не отображаются, вопросы идут друг за другом в последовательном порядке, изменение ответов не предусмотрено.

Опросник отправляется при соблюдении следующих условий:

Существует корректная конфигурация опроса в БД
Опросники включены в account config (опция surveys) и меню тарифов
Оценка оператора (опция rate_operator) отключена в account config
Посетитель не заблокирован
В чате есть оператор
Опросники поддерживаются в данном канале общения
Хотя бы один таймаут из представленных ниже имеет ненулевое значение и не истёк:
- surveyTimeout в location settings
- surveys_timeout в настройках канала
- default_survey_timeout в account config
Настройка account config operator_closes_chat_finally должна иметь значение false

В одном диалоге форма опросника отправляется только один раз. В случае переоткрытия чата до окончательного закрытия (например, из-за срабатывания тайм-аута) форма опросника повторно не отправляется, в том числе, если обращение обслуживалось несколькими операторами, поскольку опросник привязан к конкретному обращению, а не к оператору.

Опросники могут быть выведены посетителям через все каналы общения, кроме Авито, SevenTech и Email.

Отображение опросника в виджете на сайте

Результаты опросников отображаются в разделе История диалогов.

Конфигурация опросника

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

{
    "forms":
    [
        {
            "id": 0,
            "subjects": ["robot", "operator"],
            "questions":
            [
                {
                    "text": {
                        "ru": "Оцените, пожалуйста, скорость ответа оператора:",
                        "en": "Please, rate operator's answer speed:"
                    },
                    "type": "stars"
                },
                {
                    "text": {
                        "ru": "Нам удалось решить вашу проблему?",
                        "en": "Did operator solve your problem?"
                    },
                    "type": "radio",
                    "options": {
                        "ru": ["Да", "Нет"],
                        "en": ["Yes", "No"]
                    }
                },
                {
                    "text": {
                        "ru": "Поделитесь впечатлениями от общения с нашим клиентским центром! Что понравилось, а что стоит улучшить?",
                        "en": "Share your impression about chatting with our client support service! What did you like and what you think we should improve?"
                    },
                    "type": "comment"
                }
            ]
        },
        {
            "id": 1,
            "subjects": ["robot", "operator"],
            "questions":
            [
                {
                    "text": {
                        "ru": "Оцените, пожалуйста, работу нашего чат-бота:",
                        "en": "Please, rate our bot's work"
                    },
                    "type": "stars"
                },
                {
                    "text": {
                        "ru": "Хотите протестировать бота Webim на своем сайте?",
                        "en": "Do ypu want to test Webim bot on your own website?"
                    },
                    "type": "radio",
                    "options": {
                        "ru": ["Да", "Нет"],
                        "en": ["Yes", "No"]
                    }
                }
            ]
        },
        {
            "id": 2,
            "subjects": ["robot", "operator"],
            "questions":
            [
                {
                    "text": {
                        "ru": "Вы посещаете вебинары Webim?",
                        "en": "Do you visit Webim webinars?"
                    },
                    "type": "radio",
                    "options": {
                        "ru": ["Да", "Нет"],
                        "en": ["Yes", "No"]
                    }
                },
                {
                    "text": {
                        "ru": "Какую тему вы бы предложили для нашего следующего вебинара?",
                        "en": "Which theme would you suggest for our next webinar?"
                    },
                    "type": "comment"
                }
            ]
        }
    ]
}

Описание полей:

id: id формы. Формы выводятся в виджете чата последовательно друг за другом. Во всех остальных каналах вопросы выводятся в точно таком же последовательном порядке, но без форм.
subjects: субъекты, связанные с опросником. Может принимать значения bot и operator. Форма с соответствующими субъектами будет показана только в том случае, если в общении с посетителем принимали участие бот и/или оператор.
questions: массив вопросов, находящихся в форме.
text: текст вопроса. Вопрос можно локализовать на любой из доступных языков общения.
type: тип вопроса. Принимает 3 значения: stars, radio, comment.
options: специальное поле для вопроса типа radio. Является массивом вариантов ответа на поставленный вопрос. Ответы, как и вопросы, могут быть локализованы на любой из доступных языков общения.

Размещение опросника в системе

После создания конфигурации Вам необходимо:

в случае облачного размещения - обратиться в техническую поддержку
в случае hosted-размещения - самостоятельно добавить опросник в БД следующей командой:

INSERT INTO webim_service_pro_<Имя аккаунта>.surveyconfig(descriptor, created, version)
VALUES (<Конфигурация опросника>, <Дата и время создания>, <Номер версии опросника>)

N.B.

Конфигурация опросника в запрос должна поступать в виде json-encoded string.