| Table of Contents | ||
|---|---|---|
|
Якщо ви хочете, щоб ваш сервіс відправляв повідомлення з Creatio за допомогою Beesender, вам потрібно увімкнути відправлення повідомлень у форматі JSON для вашого сервісу.
...
Параметр type визначає тип відправленого повідомлення: текст, зображення, файл, місцезнаходження. Якщо type == 'text', поле text має бути заповненим. Те саме стосується інших типів.
SendMessage
Опис | Інтерфейс для надсилання повідомлень на Beesender за допомогою Creatio |
Путь | {HOST}/api/v1.0/sendmessage/{AppidAppId}/{ChannelId} |
Метод запиту | POST |
AppId – ваш секретний ключ
ChannelId – guid, напрям, отриманий в тестовому хуку
...
Назва | Опис | Тип даних | Необхідно | Коментарі |
|---|---|---|---|---|
sender | Sender | string | yesТак | |
message | Message | string | yesТак |
Структура класу
Структура класу Sender
Назва | Опис | Тип даних | Необхідно | Коментарі |
|---|---|---|---|---|
id | ID користувача вашої системи | string | yesТак | |
name | Ім'я користувача вашої системи | string | yesТак | |
avatar | Посилання на аватар користувача вашої системи | string | yesТак |
Структура класу Message
Назва | Опис | Тип даних | Необхідно | Коментарі |
|---|---|---|---|---|
type | Тип повідомлення | string | yesТак | Допустимі значення:
|
text | Текст повідомлення | string | ||
attachment | Вкладені файли | Attachment |
...
Назва | Опис | Тип даних | Необхідно | Коментарі |
|---|---|---|---|---|
name | Назва файлу | string | ||
size | Розмір файлу | long | У байтах. Наразі не використовується | |
url | Адреса файлу | string |
Приклад текстового повідомлення, надісланого до Creatio
| Code Block |
|---|
{
"sender":
{
"id": 4,
"name": "Alex Wilson",
"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"
}
}
If the request was successful, then 200 OK is returned with the body, for example,
{
"ok": true
}
If there are errors, then the text of the error will be indicated in the response body, for example,
{
"ok": false,
"error": "hook.message.attachment.image can't be empty"
} |
...