Загрузка электронных писем
| Метод | upload.emails |
|---|---|
| Описание | Загрузка электронных писем |
| Кому доступен | Агент, Клиент |
| Необходимые компоненты для работы с методом | Емейл-трекинг |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
emails |
array | нет | Массив писем | |
site_id |
number | нет | Идентификатор сайта. Метод получение списка существующих сайтов: "get.sites" | |
session_id |
number | нет | Идентификатор сессии | |
source_id |
number | нет | Идентификатор источника. Метод получение списка существующих Источников: "get.get_sources" | |
date_time |
date | да | Дата и время получения письма на почту в таймзоне клиента | |
sender_name |
string | нет | Имя отправителя | |
subject |
string | нет | Тема письма | |
message |
string | да | Текст письма. | |
message_html |
string | да | HTML письма. | |
email_from |
string | да | Отправитель. | |
email_to |
string | да | Получатель. Обязательно одно из полей: email_to, email_to_cc, email_to_bcc | |
email_to_cc |
array | нет | Копия. | |
email_to_bcc |
array | нет | Скрытая копия. |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
id |
number | да | Уникальные идентификатор загруженного письма |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"upload.emails",
"params":{
"access_token":"string",
"user_id":"number",
"emails":[
{
"date_time": "2023-02-16 00:00:00",
"session_id": 122343,
"source_id": -999,
"site_id": 258,
"sender_name": "Имя",
"subject": "Тема",
"message": "Сообщение",
"message_html": "HTML",
"email_from": "email_from@gmail.com",
"email_to": "email_to@gmail.com",
"email_to_cc": ["email_cc@gmail.com"],
"email_to_bcc": ["email_bcc@gmail.com"]
}
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"id": "number"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"