Для получения сообщений из Creatio необходимо реализовать сервис, принимающий POST запросы. В теле пост запроса – JSON с информацией о полученном сообщении.
На данный момент поддерживается несколько типов сообщений: с кнопками, без кнопок, файл, картинка, местоположение. Тип указан в параметре type. В случае, если тип сообщения – кнопочное, оно может также содержать текст, который идет перед кнопками.
Спецификация запроса
Name | Description | Data type | Comments |
channel_id | Ид канала в Creatio | string | |
receiver_id | Ид пользователя, который получает сообщение в Вашем канале | string | |
type | Тип присылаемого сообщения | string | text, buttons, file, image, location, operator_info, |
content | Присланные кнопки | Content |
Спецификация класса Content
Name | Description | Data type | Comments |
text | Текст, идущий перед кнопками | string | Если тип сообщения файл или картинка, то ссылка на файл или картинку, если местоположение to объект location |
buttons | Тексты кнопок сообщений | string[] | |
| operatorInfo | Информация об операторе | OperatorInfo | Если тип запроса operator_info |
Спецификация класса Location
| Name | Description | Data type | Comments |
| lat | Latitude | string | |
| lng | Longtitude | string |
Спецификация класса OperatorInfo
| Name | Describtion | Date type | Comments |
| OperatorPhotoLink | Ссылка на фото оператора | string | |
| OperatorName | Имя оператора | string |
Для корректной работы, необходимо возвращать 200 ОК на каждый запрос к вашему Endpoint.
В случае если в настройках канала проставлена галочка "Отправлять информацию об операторе", то при смене оператора будет приходить
сообщение с типом operator_info;
Пример принимаемого json сообщения с типом text:
{
"channel_id" : "28528776-3130-4C66-E811-08D55CEAB346",
"receiver_id" : "123",
"type" : "text",
"content" :
{
"text" : "test",
"buttons" : []
},
"operatorInfo": ""
}