Отправка сообщений¶
Отправка сообщения¶
POST /v1.3/messaging/<lead-id>/send
- lead-id - идентификатор обращения
Тело запроса:
- message - объект отправляемого сообщения
- text - текст сообщения
- attachment - объект прикрепленного файла, полученный запросом ниже
- type - тип передаваемого файла: photo, doc
- media - объект сохраненного файла
- source - идентификатор канала в Umnico (source.realId) [*]
- userId - идентификатор пользователя в Umnico
- saId - (необязательный параметр) - идентификатор интеграции, соответствующий переданному в source каналу
- customId - (необязательный параметр) - специальный идентификатор для внешних интеграторов, который вернется в webhook’е Исходящее сообщение
[*] | Если у выбранного вами канала отсутствует realId, отправляйте source.id. Кроме того должен совпадать с тем же, что был передан при загрузке файла. |
Пример:
POST https://api.umnico.com/v1.3/messaging/90/send
Body:
{
"message":{
"text":"Добрый день",
"attachment": {
"media": {
"id": 457243706,
"url": "https://sun9-6.userapi.com/c8024/v857416/136d/Kj3gSAQeG4.jpg"
},
"type": "photo"
}
},
"source": "255",
"userId": 15,
"customId": "my-identifier"
}
Response: status 200
Написать первым¶
Предупреждение
Функционал работает только для Whatsapp интеграций
POST /v1.3/messaging/post
Тело запроса:
- message - объект отправляемого сообщения
- text - текст сообщения
- attachment - объект прикрепленного файла, полученный запросом ниже
- type - тип передаваемого файла: photo, doc
- media - объект сохраненного файла
- destination - номер телефона в международном формате для интеграции типа Whatsapp
- saId - идентификатор интеграции, через которую был загружен файл и будет отправлено сообщение. Доступные типы: whatsapp и whatsapp2 - Whatsapp
- customId - (необязательный параметр) - специальный идентификатор для внешних интеграторов, который вернется в webhook’е Исходящее сообщение, но в Umnico учитываться и сохраняться не будет
Пример:
POST https://api.umnico.com/v1.3/messaging/post
Body:
{
"message": {
"text": "Добрый день."
},
"destination": "79865432211",
"saId": 75,
"customId": "8c035f28f0dae452"
}
Пример с файлом:
POST https://api.umnico.com/v1.3/messaging/post
Body:
{
"message": {
"text": "Добрый день. Скидываем вам прайс.",
"attachment": {
"media": {
"path":"/uploads/b5705f4abbb76cdd02849b9395953298",
"name":"price.xlsx",
"mime":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
},
"type":"doc"
}
},
"destination": "79865432211",
"saId": 75,
"customId": "my-identifier"
}
Загрузить файл¶
Примечание
Content-Type: multipart/form-data
Предупреждение
Для корректного определения mime типа файла следует передать заголовок
Content-Type: <mime/type>
где <mime/type> - тип передаваемого файла, например image/jpeg или application/pdf
POST /v1.3/messaging/upload
Тело запроса:
Внимание! В запросе следует использовать только одно из следующих двух полей (source, said).
- source - использовать это поле для «Отправить сообщение» - идентификатор канала в Umnico (source.realId)
- saId - использовать это поле для «Написать первым» - идентификатор интеграции в Umnico (sa.id)
- media - файл
После успешного выполнения возвращается следующий объект.
type | string | Тип передаваемого файла: photo, doc |
media | объект | Описание вложения к сообщению |
Объект media имеет следующие поля:
Для ВКонтакте:
id | integer | Идентификатор загруженного файла в ВКонтакте |
url | string | Ссылка на загруженный файл |
Для Whatsapp Enterprise:
type | string | Mime тип |
filename | string | Имя сохраненного файла |
src | string | Ссылка на загруженный файл |
Для остальных интеграций:
mime | string | Mime тип |
name | string | Имя сохраненного файла |
path | string | Место хранения файла |
Пример (на языке javascript):
POST https://api.umnico.com/v1.3/messaging/upload
Body:
{
"source": "255",
"media": {
"value": fs.createReadStream("/home/user/Pictures/0CPtX4dF2a8.jpg"),
"options": {
"filename": "0CPtX4dF2a8.jpg",
"contentType": "image/jpeg"
}
}
}
Response:
{
"media": {
"id": 457243706,
"url": "https://sun9-6.userapi.com/c8024/v857416/136d/Kj3gSAQeG4.jpg"
},
"type": "photo"
}