4.10.2.1 Отправка сообщения, либо файла, либо оценки обслуживания
POST /cc/send_message
Данный метод позволяет из вашего приложения отправлять в Контакт-центр MANGO OFFICE:
- текстовое сообщение;
- оценку качества обслуживания;
- отправлять файл или изображение.
Обратите внимание:
- данный метод позволяет отправлять файл или изображение из внешнего истоничка (например, файлового хранилища) в Контакт-центр MANGO OFFICE. Загрузка файла выполняется по url, поэтому у вас должно быть файловое хранилище с файлами, которые вы хотите отправить. Отправка локально сохраняемых файлов не поддерживается. Тип сообщения "text";
- данный метод позволяет отправлять оценку качества обслуживания из внешнего приложения в Контакт-центр MANGO OFFICE. При этом, со стороны внешнего приложения необходимо убирать вопросы после того, как Клиент выставил оценку, в противном случае оценка будет некорректной. Также при выставлении оценки необходимо отправлять id вопроса, на который выставляется оценка.
Важно! Со стороны внешнего приложения необходимо выставлять временное ограничение в 5 мин на выставление оценки.
Параметры:
| № | Параметр | Тип | Обязательный | Описание |
|---|---|---|---|---|
| Базовые параметры запроса | Базовые параметры запроса | Базовые параметры запроса | Базовые параметры запроса | Базовые параметры запроса |
| 1 | channelId | Число | Да | Id текстового канала Манго Диалогов, через который отправится сообщение \ файл. |
| 2 | userId | Строка | Да | Id клиента на стороне внешней системы |
| 3 | messageId | Строка | Да | Id сообщения на стороне внешней системы |
| 4 | firstName | Строка | Да | Имя клиента внешней системы |
| 5 | lastName | Строка | Да | Фамилия клиента внешней системы |
| Эти параметры следует отправлять, если вы отправляете текстовое сообщение или оценку качества | Эти параметры следует отправлять, если вы отправляете текстовое сообщение или оценку качества | Эти параметры следует отправлять, если вы отправляете текстовое сообщение или оценку качества | Эти параметры следует отправлять, если вы отправляете текстовое сообщение или оценку качества | Эти параметры следует отправлять, если вы отправляете текстовое сообщение или оценку качества |
| 6 | content | Строка | Нет | В этом поле нужно указать текст сообщения, либо оценку качества (цифру от 1 до 5). |
| 7 | type | Строка | Нет | Тип сообщения "text". |
| Эти параметры следует отправлять, если вы отправляете файл или изображение | Эти параметры следует отправлять, если вы отправляете файл или изображение | Эти параметры следует отправлять, если вы отправляете файл или изображение | Эти параметры следует отправлять, если вы отправляете файл или изображение | Эти параметры следует отправлять, если вы отправляете файл или изображение |
| 8 | type | Строка | Нет | Тип файла "image" или "file" |
| 9 | link | Строка | Нет | Ссылка на файл, размещенный во внешнем истоничке (например, файловом хранилище). |
| 10 | fileName | Строка | Нет | Имя файла |
| 11 | fileSize | Строка | Нет | Размер файла в байтах |
Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign. Подробнее об этих обязательных полях…
Примеры запросов.
Пример отправки текстового сообщения "Frost and sun; wonderful day!":
POST https://app.mango-office.ru/cc/send_message
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"channelId": 40771,
"userId": "ikRr7aLbBhe",
"messageId": "100500",
"firstName": "Саша",
"lastName": "Пушкин",
"type": "text",
"content": "Frost and sun; wonderful day!"
}
Пример отправки файла "file.ext":
POST https://app.mango-office.ru/cc/send_message
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"channelId": 40771,
"userId": "ikRr7aLbBh",
"messageId": "100500",
"firstName": "Вася",
"lastName": "Пушкин",
"type": "file",
"link": "https://some-site.ru/folder/file.ext",
"fileName": "file.ext",
"fileSize": "123"
}
Пример отправки оценки качества:
POST https://app.mango-office.ru/cc/send_message
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"channelId": 40771,
"userId": "ikRr7aLbBhe",
"messageId": "100500",
"firstName": "Саша",
"lastName": "Пушкин",
"type": "text",
"content": "1"
}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| Параметр | Тип | Описание |
|---|---|---|
| messageId | Строка | Id сессии |
Примеры ответа.
Пример успешного ответа:
{
"result": 1000,
"messageId": "liD0fcxvbiPDW9xzyF9jzMlo"
}
Пример ответа с ошибкой
{
"result": 5000
}
Примечание.
Для того, чтобы добавление значений оценки работало, необходимо в системе Контроля качества MANGO OFFICE настроить правило для выставления оценки. Для настройки выставления оценки нужны следующие действия:
- Перейти по ссылке https://qm.mango-office.ru/,
- Добавить правило в настройках, указав, что нужна оценка качества в чатах. Что обеспечит возможность выставлять оценки после завершения обращения в КЦ.
- Далее нужно подключить услугу "Омниканальная оценка диалогов" - включить галочку "Оценивать качество обслуживания по завершению диалога"
- Если не настроить данный функционал, то попытка оценки будет приходить как новое обращение, в КЦ в виде нового чата.