Список

Нужно помнить: если нет значений в параметре user_ids, по умолчанию будет показан список писем аккаунтов, которые принадлежат собственнику токена.

Список писем с постраничной выдачей

POST https://do.myfreshcloud.com/common/list/paging/24

Path Parameters

Name
Type
Description

/24*

Int

Код модуля

Query Parameters

Name
Type
Description

columns

String

Список колонок

records_onpage

Int

Записей на странице, но не более 500

page

Int

Номер страницы

sorting_column

String

Колонка сортировки

sorting_direction

Int

Сортировка {0} Asc / {1} Desc

Headers

Name
Type
Description

Authorization*

String

Bearer XXXXX-XXXXXXX-XXXXX

Content-Type*

String

application/json

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "[
       {"id":1,"subject":"Happy!"}
  ]"

Пример

curl --location --request 
POST 'https://do.myfreshcloud.com/common/list/paging/24
?records_onpage=50
&sorting_column=id
&user_ids=37
&sorting_direction=1
&date1=2021-01-01
&date2=2021-12-31
&page=1
&columns=id,subject,from,from_address,to,to_address,small_part_of_body' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \
--data-raw ''

Columns

На заметку: колонки с префиксом company_ содержат информацию о контрагенте, это может быть как юридическое лицо, так и физическое. В случае с юридическим лицом company_name это название компании, а в случае с физическим лицом это ФИО физ лица.

Имя
Описание

id

Код письма

from

От кого, имя или адрес

from_address

Адрес отправителя

to

Кому, имя или адрес

to_address

Адрес получателя

cc

Копия получателя

bcc

Скрытая копия получателя

subject

Тема

date

Дата

user_name

Имя собственника аккаунта

company_name

Наименование контрагента

company_id

Идентификатор контрагента

contact_id

Код контактного лица

contact

Имя контактного лица

company_type_id

Код типа контрагента

company_type

Тип контрагента

company_category_id

Код категории контрагента

company_category

Категория контрагента

company_status_id

Код статуса контрагента

company_status

Статус контрагента

deal

Наименование сделки

deal_id

Идентификатор сделки

message_id

Уникальной ID сообщения сформированный почтённым сервером

attachment_flag

Признак наличия прикрепления (0/1)

small_part_of_body

Первый 255 символов от контента письма

body

Содержание письма в формате HTML ⚡️ Не рекомендуется указывать колонку в больших списочных запросах. По возможности получайте позицию одного письма по id. Параметр фильтрации id=xx

Фильтрация

На заметку: можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: https://help.myfreshcloud.com/settings/filters ⚡️

Колонки фильтрации


?id=1
?segment=1 
?user_ids=1  0r ?user_ids=1,3,5
?date1=2021-12-01
?date2=2021-12-31
?subject=Hapy!
?to_address="support@myfreshcloud.com"
?from_address="support@myfreshcloud.com"
?company_id=1
?deal_id=1
?page=1

// id - Код письма 
// segment - Код папки письма (см.описание)
// user_ids - Код пользователя чьи аккаунты нужно просмотреть
// date1 - С даты (формат YYYY.MM.DD)
// date2 - По дату (формат YYYY.MM.DD)
// subject - Тема письма
// to_address - Email адрес кому
// from_address - Email адрес от кого (все письма по сделке)
// company_id - Код контрагента (все письма по компании)
// deal_id - Код сделки
// page - Номер страницы которую нужно получить

⚡️user_ids

Коды пользователей можно найти в раздели - пользоватли

⚡️segment

  1. Входящие

  2. Отправленные

  3. Черновики

  4. Корзина

  5. Спам

  6. Еще

Готовые пользовательские фильтры


?user_filter_ids = 1
or
?user_filter_ids=1,2

⚡️ user_filter_ids

Коды фильтров можно найти в раздели - фильтры

Last updated