Настройка Endpoint и добавление канала API
Для того, чтобы сервис мог писать сообщения на Creatio, используя Beesender, требуется наделить сервис функцией отправки этих сообщений в JSON-формате.
В качестве хоста берется адрес коннектора, который используется при общении из Creatio. Это значение находится в системной настройке BeesenderOperatoHost.
Параметр type определяет тип отправляемого сообщения: text, image, file, location. Если type == 'text', то поле text должен быть заполнен. Аналогично и для остальных типов.
SendMessage
Описание | Интерфейс для отправки сообщения на Beesender в Creatio |
Путь | {HOST}/api/v1.0/sendmessage/{Appid}/{ChannelId} |
Тип метода | POST |
AppId – ваш секретный ключ
ChannelId – guid, пришедший в тестовом hook
Спецификация запроса
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
sender | Отправитель | Sender | yes | |
message | Сообщение | Messagee | yes | |
clientId | Идентификатор пользователя | string | no |
Структура класса Sender
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
id | Ид пользователя вашей системы (сеанса) | string | yes | |
name | Имя пользователя вашей системы | string | yes | |
avatar | Ссылка на аватар пользователя вашей системы | string | no |
Структура класса Message
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
type | Тип отправляемого сообщения | string | yes | Возможные значения: text, image, file, location |
text | Текст сообщения | string | ||
attachment | Приложение | Attachment |
Структура класса Attachment
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
image | Ссылка на изображение | string | ||
location | Местоположение | Location | ||
file | Файл | File |
Структура класса Location
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
lat | Широта | string | ||
lng | Долгота | string |
Структура класса File
Name | Description | Data type | Required | Comments |
|---|---|---|---|---|
name | Название файла | string | ||
size | Размер файла | long | В байтах. Пока не используется | |
url | Ссылка на файл | string |
Пример отправленного текстового сообщение в Creatio
| Code Block |
|---|
{
"sender":
{
"id": "4",
"name": "Test User",
"avatar":
"https://media.fox9.com/media.fox9.com/photo/2018/03/02/5%20P%20MISSING%20DOG%20FOUND%20DEAD_00.00.06.04_1520042792006.png_5029487_ver1.0_640_360.jpg"
},
"message":
{
"type": "text",
"text": "Test text"
}
} |
Если запрос прошел успешно, то возвращается 200 ОК.
Коллекция запросов и пример выполнения:
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|