...
Параметр 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/ |
...
360.jpg" |
...
}, |
...
"message": |
...
{ |
...
...
"type": "text", |
...
...
"text": "Test text" |
...
}
} } |
Если запрос прошел успешно, то возвращается 200 ОК с телом, например,
{
"ok": true
}
Если прошел с ошибками, то в теле ответа будет указан текст ошибки, например,
{
"ok": false,
"error": "hook.message.attachment.image can't be empty"
}
Обратите внимание на то, что запрос с данным телом можно сделать через Postman. Он должен вернуть результат, однако, в интерфейсе Creatio чат создан не будет.
Коллекция запросов и пример выполнения:
...
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|