Skip to content

roschat bot api data body system

MarkFomin edited this page Jun 25, 2019 · 1 revision

dataBodySystem

Описание

Системное сообщение

Тип данных

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

Диапазон

Заначение type Формат объекта
'chat-created' dataBodySystemChatCreated
'chat-user-added' dataBodySystemChatUserAdded
'chat-user-changed' dataBodySystemChatUserChanged
'chat-user-deleted' dataBodySystemChatUserDeleted
'chat-updated' dataBodySystemChatUpdated

dataBodySystemChatCreated

Описание

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

Тип данных

object

Параметры

Название Тип Описание
type string Тип сообщения - 'chat-created'
cid int Идентификатор контакта создавшего беседу

Пример

var chatCreated = {
  type: 'chat-created',
  cid: 23
};

dataBodySystemChatUserAdded

Описание

Сообщение для оповещения о добавлении контакта в беседу

Тип данных

object

Параметры

Название Тип Описание
type string Тип сообщения - 'chat-user-added'
cid int Идентификатор добавленного контакта
editorId int Идентификатор добавившего контакт

Пример

var userAdded = {
  type: 'chat-user-added',
  cid: 15,
  editorId: 23
};

dataBodySystemChatUserChanged

Описание

Сообщение для оповещения о изменении привелегий контакта в беседе

Тип данных

object

Параметры

Название Тип Описание
type string Тип сообщения - 'chat-user-changed'
cid int Идентификатор измененного контакта
editorId int Идентификатор изменившего привилегии контакту

Пример

var userChanged = {
  type: 'chat-user-changed',
  cid: 15,
  editorId: 23
};

dataBodySystemChatUserDeleted

Описание

Сообщение для оповещения о удалении контакта из беседы

Тип данных

object

Параметры

Название Тип Описание
type string Тип сообщения - 'chat-user-deleted'
cid int Идентификатор удаленного контакта
editorId int Идентификатор удалившего контакт, по умолчанию пустое - учатсник беседы вышел сам

Пример

var userDeleted = {
  type: 'chat-user-deleted',
  cid: 15,
  editorId: 23
};

dataBodySystemChatUpdated

Описание

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

Тип данных

object

Параметры

Название Тип Описание
type string Тип сообщения - 'chat-updated'
cid int Идентификатор контакта изменившего беседу
title string Название беседы, по умолчанию пустое
icon string Имя файла, логотип чата, по умолчанию пустое
pinMessage string Идентификатор прикреплённого сообщения, по умолчанию пустое

Пример

var сhatUpdated = {
  type: 'chat-updated',
  cid: 15,
  title: 'Новое название беседы.'
};
Clone this wiki locally