Список
Примечание
Нужно помнить: если нет значений в параметре user_ids, по умолчанию будет показан список писем аккаунтов, которые принадлежат собственнику токена.
Список писем с постраничной выдачей
POST https://do.freshoffice.ru/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!"}
]"
{
// Response
}
Пример
curl --location --request
POST 'https://do.freshoffice.ru/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 ''
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://do.freshoffice.ru/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',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Authorization: Bearer XXXXX.XXXXXX.XXXXXX'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://do.freshoffice.ru/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',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer XXXXXXX.XXXXXXX.XXXXXXX'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
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 |
Фильтрация
Примечание
На заметку: можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: фильтры в приложении ⚡️
Колонки фильтрации
?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@freshoffice.ru"
?from_address="support@freshoffice.ru"
?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
- Входящие
- Отправленные
- Черновики
- Корзина
- Спам
- Еще
Готовые пользовательские фильтры
?user_filter_ids = 1
or
?user_filter_ids=1,2
⚡️ user_filter_ids
Коды фильтров можно найти в раздели - фильтры