Документация Связаться с нами Стать разработчиком Мегаплана

Сообщения

Карточка сообщения

URI: /BumsCommonApiV01/Message/card.api|xml

Входные параметры

Поле Тип Описание
Id integer ID сообщения

Выходные данные (поля сотрудника)

Поле Тип Описание
Id integer ID сообщения
Subject string Тема сообщения
Content string Текст сообщения
Folder string Папка сообщения. incoming - входящие, outgoing - исходящие
TimeCreated datetime Время создания сообщения
To array<object(Id, Name)> Получатели(Идентификатор, Имя сотрудника)

Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":1000387
  },
  "data":
  {
    "message":
    {
      "Id":1000387,
      "Subject":"Причина отсутствия на рабочем месте",
      "Content":"Отсутствовал на работе 04.07.2012 по семейным обстоятельствам",
      "Folder":"outgoing",
      "To":
         {
           "Id":1,
           "Name":"Директор Иванов"
         },
         {
            "Id":3,
            "Name":"Бухгалтер Петрова"
         }
    }
  }
}

Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <id>21497</id>
  </params>
  <data>
    <message>
      <id>21497</id>
      <subject>Объяснительная</subject>
      <content>Sidorov</content>
      <folder>outgoing</folder>
      <to>
         <item>
            <id>1</id>
            <name>Раиса Хабибулина</name>
         </item>
         <item>
            <id>2</id>
            <name>Иван Петров</name>
         </item>
      </to>
    </message>
  </data>
</response>

Создать сообщение

URI: /BumsCommonApiV01/Message/create.api|xml

Входные параметры

Параметр Тип Описание
Model[Content] string Текст сообщения
Model[Subject] string Тема сообщения
Model[To] integer ID пользователя (получателя сообщения). Можно указать получателей через запятую
Model[Attaches] array Массив приложенных файлов, должен передаваться POST-запросом
Model[Attaches][0..n][Name] string Пользовательское имя файла
Model[Attaches][0..n][Content] string Файл закодированный алгоритмом MIME base64
Reply integer Идентификатор сообщения, на которое нужно ответить
WithAnswer boolean Сообщение с ответом. По-умолчанию - FALSE

Удалить сообщение

URI: /BumsCommonApiV01/Message/delete.api|xml

Входные параметры

Параметр Тип Допустимые значения Значение по умолчанию Описание
Id integer     Идентификатор сообщения, которое нужно удалить

Список сообщений

URI: /BumsCommonApiV01/Message/list.api|xml

Входные параметры

Параметр Тип Допустимые значения Значение по умолчанию Описание
Folder string incoming (входящие),outgoing(исходящие), deleted(удаленные) incoming Папка
FavoritesOnly boolean   false Получить только избранные сообщения
DateFrom date     Дата самого старого сообщения в списке (Формат: YYYY-MM-DD)
DateTo date     Дата самого нового сообщения в списке (Формат: YYYY-MM-DD)
Limit integer   0 Количество сообщений, если «0», то выбираются все сообщения
TimeUpdated string Дата/время в одном из форматов ISO 8601 нет Возвращать только те объекты, которые были изменены после указанный даты
Offset integer   0 Количество сообщений, которые нужно пропустить

Выходные данные (массив сообщений с полями)

Поле Тип Описание    
Id integer Идентификатор сообщения    
Content string     Текст сообщения
Subject string     Тема сообщения
Folder     string Папка
TimeCreated     datetime Время создания сообщения
To     array<object(Id, Name)> Список получателей

Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Folder":"outgoing"
  },
  "data":
  {
    "messages":
    [
      {
         "Id":123,
         "Content": "Привет, всем!",
         "Subject": "Я новый сотрудник",
         "Folder": "outgoing",
         "To":
         [
           {
              "Id":1,
              "Name": "Иван Петров"
           },
           {
              "Id":2,
              "Name": "Андрей Сидоров"
           }
         ]
      },
      {
         "Id":124,
         "Content": "Народ, скажите а кто где обедает?",
         "Subject": "Обед",
         "Folder": "outgoing",
         "To":
         [
           {
              "Id":1,
              "Name": "Иван Петров"
           },
           {
              "Id":2,
              "Name": "Андрей Сидоров"
           }
         ]
      }
    ]
  }
}

Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <folder>all</folder>
    <status>any</status>
  </params>
  <data>
    <messages>
      <item>
        <id>841</id>
        <content>Привет, ребята</content>
        <subject>Я новый сотрудник</subject>
        <folder>outgoing</folder>
        <to>
          <item>
             <id>2</id>
             <name>Петр Петров</name>
          </item>
          <item>
             <id>3</id>
             <name>иван Иванов</name>
          </item>
        </to>
      </item>
      <item>
        <id>841</id>
        <content>Народ, а кто где обедает?:)</content>
        <subject>Обед</subject>
        <folder>outgoing</folder>
        <to>
          <item>
             <id>2</id>
             <name>Петр Петров</name>
          </item>
          <item>
             <id>3</id>
             <name>иван Иванов</name>
          </item>
        </to>
      </item>
    </messages>
  </data>
</response>