API

https://docs.google.com/document/d/1lYaqsIKoCmTj1tVIPyGvJjxEwMx0pVOMVJ9eqeavPd8/edit#

Методы 2 Получить токен доступа 2 Получить список филиалов 3 Отправить запрос на оставление отзывов 3 Удалить запрос на оставление отзывов 4 Получить чаты с сообщениями 5 Chat 5 Message 6 MessageType 6 Отправить сообщение с произвольным текстом 8 Методы ПРИМЕЧАНИЯ: Адрес сервера https://revvy.ru. Все методы начинаются с /api/ Тело запроса и тело ответа должно быть в формате JSON Для методов требующих авторизацию необходимо указывать jwtToken (который можно получить с помощью метода получения токена) в заголовке запроса в формате: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR……. Получить токен доступа Токен выдается на фиксированный интервал времени. По умолчанию это - 30 дней. /api/authentication Метод HTTP POST HEADERS Content-Type: application/json Параметры тела запроса name string Email пользователя * password string Пароль пользователя * Ответ jwtToken string Токен доступа userName string Имя авторизованного пользователя userId string Идентификатор авторизованного пользователя Получить список филиалов /api/places/list Метод HTTP GET HEADERS Content-Type:application/json Authorization: Bearer jwtToken Ответ id GUID Идентификатор филиала name string Название филиала address string Адрес филиала deleted bool Признак удаленности Отправить запрос на оставление отзывов Примечение: На один номер телефона можно отправлять не более одного запроса на отзыв. В целях тестирования можно удалить запрос на оставления отзыва (см. ниже). /api/reviews/request Метод HTTP POST HEADERS Content-Type:application/json Authorization: Bearer jwtToken Параметры тела запроса name string Имя клиента * phone string Телефон клиента в международном формате номеров мобильных телефонов, для России это - 7ХХХХХХХХХХ * placeId GUID? Id филиала по которому запрашивается (может быть пустым) additionalData string? Дополнительная информация, которой можно будет воспользоваться потом в сообщениях (к примеру, динамическая ссылка на Ваш ресурс или промокод). Для того, чтобы воспользоваться полем, нужно в шаблон сообщений подставить строку {AdditionalData}. number string? Номер (заказа/сделки/транзакции), который будет подставлен в указанное место в сообщении запроса оценки. Для того, чтобы воспользоваться полем, нужно в шаблон сообщений подставить строку {Number}. Удалить запрос на оставление отзывов Примечание: полезно для тестирования, так как Revvy не отправляет более 1 запроса отзыва (чтобы не спамить клиента). /api/reviews/request Метод HTTP DELETE HEADERS Content-Type:application/json Authorization: Bearer jwtToken Параметры тела запроса phone string Телефон клиента * Получить чаты с сообщениями Получить список чатов с сообщениями по заданному фильтру. /api/chats/list Метод HTTP GET HEADERS Content-Type:application/json Authorization: Bearer jwtToken Параметры GET запроса from DateTime Обязательный параметр. Дата и время с которой были отправлены сообщения to DateTime Дата и время до которого были отправлены сообщения place_id Guid Идентификатор филиала message_type MessageType Тип сообщения Пример запроса: https://revvy.ru/api/chats/list?from=2021-05-21T09:00:00&message_type=1&to=2021-05-21T10:00:00&place_id=2df530d4-e1f9-49ee-018f-08d920f3e804 Ответ: Список (массив) элементов Chat: Chat creationDate DateTime Дата и время создания чата clientPhone string Номер телефона клиента placeId Guid Идентификатор филиала additionalData string | null Дополнительная информация о чате messages Message[] Сообщение Message message string Текст сообщения client bool Если false – сообщение отправлено сервисом Revvy, если false – отправлено клиентом senderInfo string | null Информация об отправителе type MessageType Тип отправленного сообщения date DateTime Дата и время сообщения MessageType 0 Запрос обратной связи (первое сообщение) 1 Запрос отзыва (второе сообщение) 2 Нейтральное сообщение клиента 3 Ответ на автоматическое сообщения в случае отрицательного отзыва 4 Отрицательный отзыв 5 Положительный отзыв 6 Ответ от организации 7 Уведомление от организации 8 Дополнительная информация от клиента 9 Ответ на дополнительную информацию от пользователя 10 Сообщение из массовой рассылки 11 Сообщение для дополнительной продажи 12 Запрос подтверждения записи в УС 13 Подтверждение записи в УС 14 Отмена записи в УС 15 Ответ организации на подтверждение записи в УС 16 Ответ организации на отмену записи в УС 17 Пояснения клиента к негативному отзыву 18 Уведомление об изменении заказа в Iiko Пример ответа на запрос чатов с сообщениями: [ { "creationDate": "2020-05-01T08:00:00", "clientPhone": "70708630140", "placeId": "2df530d4-e1f9-49ee-018f-08d920f3e804", "additionalData": null, "messages": [ { "message": " Артем, здравствуйте! Спасибо, что выбрали сервис Revvy! Пожалуйста, оцените качество сервиса от 1 до 5.", "client": false, "senderInfo": “79800000001”, "type": 0, "date": "2021-05-02T09:00:00" }, { "message": "5", "client": true, "senderInfo": “79800000009”, "type": 5, "date": "2021-05-03T09:00:00" } ] }, { "creationDate": "2020-05-04T09:00:00", "clientPhone": "70088601041", "placeId": "2df530d4-e1f9-49ee-018f-08d920f3e804", "additionalData": null, "messages": [ { "message": " Артем, здравствуйте! Спасибо, что выбрали сервис Revvy! Пожалуйста, оцените качество сервиса от 1 до 5.", "client": false, "senderInfo": “79800000004”, "type": 2, "date": "2021-05-04T09:00:00" }, { "message": "Добрый день!5!😌", "client": true, "senderInfo": "79800000008", "type": 5, "date": "2021-05-04T09:10:00" } ] } ] Отправить сообщение с произвольным текстом Примечание: Существует лимит на создание новых чатов в сутки. /api/message/send Метод HTTP POST HEADERS Content-Type:application/json Authorization: Bearer jwtToken Параметры тела запроса phone string Телефон клиента Телефон клиента в международном формате номеров мобильных телефонов, для России это - 7ХХХХХХХХХХ placeId GUID? Id филиала по которому запрашивается Для отправки сообщений без placeId, должен присутствовать аккаунт, который привязан ко всем филиалам, иначе возможна ситуация, когда сообщение не отправится. Если филиал пустой, то берём первый активный (placeId можно не передавать, если в личном кабинете Revvy, в разделе «Настройка канала WhatsApp-аккаунтыà Филиал, к которому привязан телефон» выбрана привязка «Все филиалы») messageText string Текст для отправки Запрещать отправлять сообщение, не содержащее текст (то есть пустое)