Сообщения (Messages)

Сообщения - ресурс платформы, манипулирующий с сообщениями в каждой записи в Бипиуме.

Получить сообщение с записи

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages

Метод: GET

Параметры:

• catalogId (number) — идентификатор каталога

• recordId (number) — идентификатор записи

Ответ

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

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages

Метод: POST

Параметры:

• catalogId (number) — идентификатор каталога

• recordId (number) - идентификатор записи

Запрос: (application/json)

{
  "text": "Как дела?",
  "mentions": [],
  "attachments": [],
  "replyMessageId": null
}

Ответ

Изменить сообщение

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages/{messageId}

Метод: PATCH

Параметры:

• catalogId (number) — идентификатор каталога

• recordId (number) - идентификатор записи

• messageId (number) - идентификатор сообщения

Запрос: (application/json)

{
  "text": "hello world",
  "mentions": [],
  "attachments": [],
  "replyMessageId": null
}

Ответ

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

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages/{messageId}

Метод: DELETE

Параметры:

• catalogId (number) — идентификатор каталога

• recordId (number) - идентификатор записи

• messageId (number) - идентификатор сообщения

Подписаться на сообщения в записи

Запрос

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/chatOptions/{recordId}

Метод: PATCH

Параметры:

• catalogId (number) — идентификатор каталога

• recordId (number) - идентификатор записи

Запрос: (application/json)

{
  "subscribe": true
}

Ответ