roschat bot api data body data

---

dataBodyData

Описание

Расширенный формат сообщения.

Тип данных

object, в зависимости от значения поля type внутри объекта, имеет соответствующий формат объекта.

Диапазон

Заначение type	Формат объекта
'text'	dataBodyDataText
'contact'	dataBodyDataContact
'channel'	dataBodyDataChannel
'publication'	dataBodyDataPublication
'location'	dataBodyDataLocation
'image'	dataBodyDataImage
'video'	dataBodyDataVideo
'audio'	dataBodyDataAudio
'file'	dataBodyDataFile
'poll'	dataBodyDataPoll

---

dataBodyDataText

Описание

Расширенный формат текстового сообщения

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'text'
text	string	Текст сообщения
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataText = {
  type: 'text',
  text: 'Привет, это я!',
  keyboard:[ [{text:'я кнопка сообщения'}] ] 
};

---

dataBodyDataContact

Описание

Сообщение для пересылки контакта.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'contact'
cid	int	Идентификатор контакта
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataContact = {
  type: 'contact',
  cid: 23,
  text: 'Это контакт.',
  keyboard:[ [{text:'я кнопка контакта'}] ] 
};

---

dataBodyDataChannel

Описание

Сообщение для пересылки канала.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'channel'
chId	int	Идентификатор канала
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataChannel = {
  type: 'channel',
  chId: 18,
  text: 'Это канал.'
};

---

dataBodyDataPublication

Описание

Сообщение для пересылки публикации.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'publication'
chId	int	Идентификатор канала
pubId	int	Идентификатор публикации
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataPub = {
  type: 'publication',
  chId: 18,
  pubId: 192,
  text: 'Информация о публикации.'
};

---

dataBodyDataLocation

Описание

Сообщение для пересылки геопозиции.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'location'
latitude	float	Широта заданой точки
longitude	float	Долгота заданой точки
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataLoc = {
  type: 'location',
  latitude: 55.752905,
  longitude: 37.617228,
  text: 'Мы здесь.'
};

---

dataBodyDataImage

Описание

Сообщение для пересылки изображения.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'image'
size	int	Размер файла в байтах
extension	string	Расширение файла, по умолчанию пустое
file	string	Имя файла присвоенное сервером
preview	string	Уменьшенная копия изображения 250×250 в формате base64 (не используется если указан previewFile)
previewFile	string	Имя файла присвоенное сервером для уменьшенного изображения), по умолчанию пустое
previewSize	size	Размеры уменьшенного изображения. Используется если указан параметр previewFile
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataImage = {
  type: 'Image',
  size: 2048,
  extension: 'jpeg',
  file:'7b3d31d1-b279-47bd-9a17-f9108d46a24b.enc',
  preview: 'vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0'
};

---

dataBodyDataVideo

Описание

Сообщение для пересылки видео.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'video'
size	int	Размер файла в байтах
extension	string	Расширение файла, по умолчанию пустое
file	string	Имя файла присвоенное сервером
preview	string	Уменьшенная копия изображения 250×250 в формате base64 (не используется если указан previewFile)
previewFile	string	Имя файла присвоенное сервером для уменьшенного изображения для видео), по умолчанию пустое
previewSize	size	Размеры уменьшенного изображения для видео. Используется если указан параметр previewFile
duration	int	Продолжительность видео в секундах
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataVideo = {
  type: 'video',
  size: 32422,
  extension: 'mpeg',
  file:'7b3d31d1-b279-47bd-9a17-f9108d43224b.enc',
  preview: 'vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBi4321',
  duration: 12
};

---

dataBodyDataAudio

Описание

Сообщение для пересылки аудиофайла.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'audio'
size	int	Размер файла в байтах
extension	string	Расширение файла, по умолчанию пустое
file	string	Имя файла присвоенное сервером
duration	int	Продолжительность аудиофайла в секундах
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataAudio = {
  type: 'audio',
  size: 14875,
  extension: 'mp3',
  file:'7b3d31d1-b279-47bd-9a17-f9108d43234452.enc'
  duration: 58
};

---

dataBodyDataFile

Описание

Сообщение для пересылки файла.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'file'
size	int	Размер файла в байтах
name	string	Имя файла без расширения
extension	string	Расширение файла, по умолчанию пустое
file	string	Имя файла присвоенное сервером
text	string	Текст сообщения, по умолчанию пустое
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataFile = {
  type: 'file',
  size: 13399,
  name: 'Финансовый отчет',
  extension: 'doc',
  file:'7b3d31d1-b279-47bd-9a17-f9108d43233242.enc'
};

---

dataBodyDataPoll

Описание

Сообщение для пересылки опроса.

Тип данных

object

Параметры

Название	Тип	Описание
type	string	Тип сообщения - 'poll'
pollId	int	Идентификатор опроса
topic	string	Заголовок опроса
answers	arrayString	Массив вариантов ответа, максимум 6 ответов.
keyboard	keyboard	Клавиатура сообщения, по умолчанию пустое

Пример

var dataPoll = {
  type: 'poll',
  pollId: 124,
  topic: 'Что это такое?',
  answers:['Это опрос','Это дерево','Затрудняюсь ответить']
};