{
"openapi": "3.1.0",
"info": {
"title": "Haskimail API",
"version": "1.0.0",
"description": "Транзакционное API Haskimail: отправка писем, сообщения, возвраты,\nшаблоны, потоки, серверы, домены, подписи, статистика и вебхуки.\n\n**Перед первым запросом** заполните переменные коллекции.\nТокенов два, и они не взаимозаменяемы:\n\n- `server_token` — права в пределах одного сервера: отправка,\n сообщения, возвраты, шаблоны, статистика. Настройки сервера →\n «Токены API».\n- `account_token` — права на весь аккаунт: серверы, домены, подписи\n отправителей. Настройки аккаунта → «Токены API».\n\nКакой токен нужен методу — видно в заголовках его запроса.\n\nДокументация: [https://haskimail.ru/developer/](https://haskimail.ru/developer/)."
},
"servers": [
{
"url": "https://api.haskimail.ru"
}
],
"security": [
{
"bearerAuth": []
},
{
"apiKeyQuery": []
}
],
"tags": [
{
"name": "API для отправки писем",
"description": "Этот API-эндпоинт предназначен для отправки писем через сервер Haskimail. Для пакетной отправки (ссылку нужно будет добавить) предусмотрена отдельная конечная точка, которая позволяет отправлять до 500 сообщений (до 50 МБ, включая вложения) за один вызов."
},
{
"name": "API Сообщений",
"description": "Позволяет получить подробную информацию о любом исходящем или входящем сообщении, отправленном или полученном через определенный сервер. Сообщения удаляются по истечении периода хранения, который по умолчанию составляет 45 дней (но может быть настроен в диапазоне от 7 до 365 дней)."
},
{
"name": "API возвратов",
"description": "Позволяет получить доступ ко всем отчетам о ваших отклоненных письмах для конкретного сервера. Информация об отклоненных письмах доступна в течение периода хранения, который по умолчанию составляет 45 дней."
},
{
"name": "API Шаблонов",
"description": "Позволяет управлять шаблонами для конкретного сервера."
},
{
"name": "API Каналов",
"description": "Позволяет управлять каналами для конкретного сервера. Обратите внимание: на одном сервере может быть до 10 каналов, включая каналы по умолчанию. Каналы по умолчанию не могут быть удалены, и на сервере может быть только один входящий канал."
},
{
"name": "API Серверов",
"description": "Позволяет управлять SMTP-серверами для конкретного аккаунта."
},
{
"name": "API Доменов",
"description": "Позволяет управлять всеми деталями ваших доменов для конкретного аккаунта."
},
{
"name": "API подписей отправителей",
"description": "Позволяет управлять всеми подписями отправителей вашего аккаунта."
},
{
"name": "API Статистики",
"description": "Позволяет получить всю статистику по вашим исходящим письмам для конкретного сервера. Эта статистика хранится постоянно и не имеет срока действия. Все статистические данные используют часовой пояс МСК (GMT+3). Если даты from/to не указаны, возвращается статистика за все время."
},
{
"name": "API Стоп-списков",
"description": "Этот раздел API позволяет вам управлять (просматривать, создавать и удалять) стоп-списками в вашем канале. Если адрес находится в стоп-списке, это означает, что отправка писем на него временно приостановлена. Удаление исключения, созданного из-за жесткого возврата (HardBounce), равносильно повторной активации этого email-адреса."
},
{
"name": "API Вебхуков",
"description": "Позволяет управлять вебхуками для определенного транзакционного или массового канала."
}
],
"paths": {
"/email": {
"post": {
"operationId": "send-a-single-email",
"summary": "Отправка одного письма",
"tags": [
"API для отправки писем"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Необходимо наличие зарегистрированной и подтвержденной Подписи отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия <отправитель@домен.com>\"`. Знаки препинания в имени необходимо экранировать. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов разделяются запятой. Не более 50. |\n| Cc | string | Получатель копии (Cc). Несколько адресов разделяются запятой. Не более 50. |\n| Bcc | string | Получатель скрытой копии (Bcc). Несколько адресов разделяются запятой. Не более 50. |\n| Subject | string | Тема письма |\n| Tag | string | Тег, который позволяет категоризировать исходящие письма и получать подробную статистику. Не более 1000 символов. |\n| HtmlBody | string | обязательный Если не указан `TextBody` задает тело письма в формате HTML. |\n| TextBody | string | обязательный Если не указан `HtmlBody` задает тело письма в виде простого текста. |\n| ReplyTo | string | Адрес для ответа. Позволяет переопределить адрес, указанный по умолчанию в Подписи отправителя. Несколько адресов разделяются запятой. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание ссылок для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| TemplateModel | object | Пользовательские данные для подстановки в письмо в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | Идентификатор (ID) Канала, используемого для отправки. Если не указан, по умолчанию будет использован транзакционный канал \"outbound\". |\n\n**Ответ**\n\n| To | string | Email-адрес получателя |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка |\n| MessageID | string | Идентификатор сообщения |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Текст ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-a-single-email)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"To": "получатель@example.com",
"SubmittedAt": "2014-02-17T07:25:01.4178645-05:00",
"MessageID": "0a129aee-e1cd-480d-b08d-4f48548ff48d",
"ErrorCode": 0,
"Message": "OK"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"From": "отправитель@example.com",
"To": "получатель@example.com",
"Subject": "Haskimail тест",
"TextBody": "Привет, дорогой клиент Haskimail.",
"HtmlBody": "Привет дорогой клиент Haskimail. "
}
}
}
}
}
},
"/email/batch": {
"post": {
"operationId": "send-batch-emails",
"summary": "Пакетная отправка писем",
"tags": [
"API для отправки писем"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Должен иметь зарегистрированную и подтвержденную Подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени должны быть экранированы. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов указываются через запятую. Максимум 50. |\n| Cc | string | Адрес электронной почты получателя копии (Cc). Несколько адресов указываются через запятую. Максимум 50. |\n| Bcc | string | Адрес электронной почты получателя скрытой копии (Bcc). Несколько адресов указываются через запятую. Максимум 50. |\n| Subject | string | Тема письма. |\n| Tag | string | Тег для категоризации исходящих писем и сбора подробной статистики. Максимальная длина 1000 символов. |\n| HtmlBody | string | HTML-содержимое письма. Используется, если не указан `TextBody`. |\n| TextBody | string | Текстовое содержимое письма. Используется, если не указан `HtmlBody` |\n| ReplyTo | string | Адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание переходов по ссылкам для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | ID Канала, который используется для отправки. Если не указан, по умолчанию используется транзакционный канал «outbound». |\n\n**Ответ**\n\nОбратите внимание, что конечная точка `/batch` всегда возвращает HTTP-статус 200, даже если при валидации отдельных сообщений возникли ошибки. Пользователям этого эндпоинта следует проверять код успеха и ошибки для каждого сообщения в ответе от нашего API (ответы в массиве расположены в том же порядке, что и отправленные сообщения).\n\n| To | string | Адрес электронной почты получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-batch-emails)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": [
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "b7bc2f4a-e38e-4336-af7d-e6c392c2f817",
"SubmittedAt": "2010-11-26T12:01:05.1794748-05:00",
"To": "receiver1@example.com"
},
{
"ErrorCode": 406,
"Message": "Вы попытались отправить письмо получателю, который был помечен как неактивный. Найдены неактивные адреса: example@example.com. К неактивным относятся получатели, по которым произошел постоянный возврат (hard bounce), поступила жалоба на спам или которые были заблокированы вручную."
}
]
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": [
{
"From": "отправитель@example.com",
"To": "receiver1@example.com",
"Subject": "Haskimail тест #1",
"TextBody": "Привет, дорогой клиент Haskimail.",
"HtmlBody": "Привет дорогой клиент Haskimail. "
},
{
"From": "отправитель@example.com",
"To": "receiver2@example.com",
"Subject": "Haskimail тест #2",
"TextBody": "Привет, дорогой клиент Haskimail.",
"HtmlBody": "Привет дорогой клиент Haskimail. "
}
]
}
}
}
}
},
"/messages": {
"get": {
"operationId": "outbound-message-search",
"summary": "Поиск писем",
"tags": [
"API Сообщений"
],
"description": "Поиск сообщений позволяет вернуть до 10 000 сообщений за один запрос. Для запросов, где необходимо получить более 10 000 сообщений, используйте параметры `todate` и `fromdate` для фильтрации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Макс. 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество сообщений, которое нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю письма. |\n| fromemail | Фильтровать по email-адресу отправителя. |\n| tag | Фильтровать по тегу. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| fromdate | Фильтровать сообщения начиная с указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| messagestream | Фильтровать по ID канала. Если не указан, по умолчанию будет использоваться исходящий транзакционный канал 'outbound'. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает количество сообщений, соответствующих указанным вами критериям поиска. |\n| --- | --- | --- |\n| Messages | array | Список объектов, каждый из которых представляет одно сообщение. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-search)",
"parameters": [
{
"name": "recipient",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "john.doe@yahoo.com"
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
},
{
"name": "tag",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "welcome"
},
{
"name": "status",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "sent"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2015-01-12"
},
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2015-01-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 194,
"Messages": [
{
"Tag": "Invitation",
"MessageID": "0ac29aee-e1cd-480d-b08d-4f48548ff48d",
"MessageStream": "outbound",
"Recipient": "john.doe@yahoo.com",
"ReceivedAt": "2014-02-20T07:25:02.8782715-05:00",
"From": "\"Joe\" ",
"Subject": "staging",
"Status": "Sent"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/messages/{messageid}/details": {
"get": {
"operationId": "outbound-message-details",
"summary": "Детали письма",
"tags": [
"API Сообщений"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Tag | string | Теги, связанные с этим сообщением. |\n| --- | --- | --- |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Recipient | string | Адрес, на который отправлено сообщение. |\n| ReceivedAt | string | Временная метка отправки сообщения сервисом Haskimail. Соответствует событию «Обработано» (Processed) в интерфейсе. |\n| From | string | Email-адрес отправителя. |\n| Subject | string | Тема письма. |\n| Status | string | Статус сообщения в вашей Активности Haskimail. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-details)",
"parameters": [
{
"name": "messageid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Tag": "product-orders",
"MessageID": "07311c54-0687-4ab9-b034-b54b5bad88ba",
"MessageStream": "outbound",
"Recipient": "john.doe@yahoo.com",
"ReceivedAt": "2014-02-14T11:12:54.8054242-05:00",
"From": "\"Joe\" ",
"Subject": "Parts Order #5454",
"Status": "Sent"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/messages/opens": {
"get": {
"operationId": "message-opens",
"summary": "Открытия писем",
"tags": [
"API Сообщений"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых сообщений. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю. |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько открытий соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| ReceivedAt | string | Временная метка, когда сообщение было открыто. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-opens)",
"parameters": [
{
"name": "recipient",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "john.doe@yahoo.com"
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 1,
"Opens": [
{
"MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
"MessageStream": "outbound",
"ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
"Tag": "welcome-user",
"Recipient": "john.doe@yahoo.com"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/messages/opens/{messageid}": {
"get": {
"operationId": "opens-for-message",
"summary": "Открытия для одного письма",
"tags": [
"API Сообщений"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество открытий, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых открытий. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | API Haskimail сохраняет только первое открытие, поэтому TotalCount всегда будет равен «1». Вебхук открытий (Open Webhook) будет отправлять уведомления о каждом отдельном открытии, если это необходимо. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. Обратите внимание, что одно открытие привязано к одному получателю. Поэтому, если одно и то же письмо было отправлено двум получателям и оба его открыли, это будет представлено двумя записями в данном массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#opens-for-message)",
"parameters": [
{
"name": "messageid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "10"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 1,
"Opens": [
{
"MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
"MessageStream": "outbound",
"ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
"Tag": "welcome-user",
"Recipient": "john.doe@yahoo.com"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/messages/clicks": {
"get": {
"operationId": "message-clicks",
"summary": "Клики по ссылкам в письмах",
"tags": [
"API Сообщений"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n| recipient | Фильтровать по получателю (To, Cc, Bcc). |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-clicks)",
"parameters": [
{
"name": "recipient",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "john.doe@yahoo.com"
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 1,
"Clicks": [
{
"MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
"OriginalLink": "https://example.com",
"MessageStream": "Outbound",
"ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
"Tag": "welcome-user",
"Recipient": "john.doe@yahoo.com"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/messages/clicks/{messageid}": {
"get": {
"operationId": "clicks-for-message",
"summary": "Клики по ссылкам в одном письме",
"tags": [
"API Сообщений"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения.. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#clicks-for-message)",
"parameters": [
{
"name": "messageid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "10"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 1,
"Clicks": [
{
"OriginalLink": "https://example.com",
"MessageID": "927e56d4-dc66-4070-bbf0-1db76c2ae14b",
"MessageStream": "outbound",
"ReceivedAt": "2014-04-30T05:04:23.8768746-04:00",
"Tag": "welcome-user",
"Recipient": "john.doe@yahoo.com"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/deliverystats": {
"get": {
"operationId": "delivery-stats",
"summary": "Получение статистики по доставке",
"tags": [
"API возвратов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| InactiveMails | integer | Количество неактивных email-адресов. |\n| --- | --- | --- |\n| Bounces | array | Список типов отклоненных писем с общим количеством по каждому типу. |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#delivery-stats)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Bounces": [
{
"Name": "All",
"Count": 253
},
{
"Type": "HardBounce",
"Name": "Hard bounce",
"Count": 195
},
{
"Type": "BulkBounce",
"Name": "Bulk Bounce",
"Count": 10
},
{
"Type": "SoftBounce",
"Name": "Soft bounce",
"Count": 30
},
{
"Type": "SpamBlock",
"Name": "Spam Block",
"Count": 1
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/bounces": {
"get": {
"operationId": "bounces",
"summary": "Получение списка возвратов",
"tags": [
"API возвратов"
],
"description": "Поиск по отклоненным письмам позволяет получить до 10 000 записей за один запрос. Если вам нужно получить больше, используйте параметры, такие как `todate` и `fromdate`, для фильтрации результатов.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса (Querystring)**\n\n| count | обязательный Количество отклоненных писем для возврата в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество отклоненных писем, которые нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| type | Фильтровать по типу отклоненного письма |\n| emailFilter | Фильтровать по email-адресу |\n| tag | Фильтровать по тегу |\n| messageID | Фильтровать по ID сообщения (messageID). |\n| fromdate | Фильтровать сообщения, начиная с указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| messagestream | Фильтровать по ID канала. Если не указано, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| TotalCount | integer | Количество возвращенных записей. |\n| --- | --- | --- |\n| Bounces | array | Список отдельных возвратов. |\n| RecordType | string | Тип записи |\n| ID | integer | ID возврата. |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | TВременная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#bounces)",
"parameters": [
{
"name": "type",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "HardBounce"
},
{
"name": "inactive",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "true"
},
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 253,
"Bounces": [
{
"RecordType": "Bounce",
"ID": 692560173,
"Type": "HardBounce",
"TypeCode": 1,
"Name": "Hard bounce",
"Tag": "Invitation",
"MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
"ServerID": 23,
"MessageStream": "outbound",
"Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
"Email": "anything@blackhole.haskimail.ru",
"BouncedAt": "2014-01-15T16:09:19Z",
"Subject": "SC API5 Test"
},
{
"RecordType": "Bounce",
"ID": 676862817,
"Type": "HardBounce",
"TypeCode": 1,
"Name": "Hard bounce",
"Tag": "Invitation",
"MessageID": "623b2e90-82d0-4050-ae9e-2c3a734ba091",
"ServerID": 23,
"MessageStream": "outbound",
"Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
"Email": "vicelcown@yahoo.com",
"BouncedAt": "2013-10-18T09:49:59Z",
"Subject": "Production API Test"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/bounces/{bounceid}": {
"get": {
"operationId": "single-bounce",
"summary": "Получение информации о конкретном возврате",
"tags": [
"API возвратов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID возврата |\n| --- | --- | --- |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат. |\n| BouncedAt | string | Временная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#single-bounce)",
"parameters": [
{
"name": "bounceid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 692560173,
"Type": "HardBounce",
"TypeCode": 1,
"Name": "Hard bounce",
"Tag": "Invitation",
"MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
"ServerID": 23,
"MessageStream": "outbound",
"Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
"Email": "anything@blackhole.haskimail.ru",
"BouncedAt": "2014-01-15T16:09:19.6421112-05:00",
"Subject": "SC API5 Test"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/bounces/{bounceid}/activate": {
"put": {
"operationId": "activate-bounce",
"summary": "Активация возврата",
"tags": [
"API возвратов"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Message | string | Сообщение ответа. |\n| --- | --- | --- |\n| Bounce | object | Детали возврата |\n| ID | integer | ID возврата |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | Временная метка возврата |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#activate-bounce)",
"parameters": [
{
"name": "bounceid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Message": "OK",
"Bounce": {
"ID": 692560173,
"Type": "HardBounce",
"TypeCode": 1,
"Name": "Hard bounce",
"Tag": "Invitation",
"MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
"ServerID": 23,
"MessageStream": "outbound",
"Description": "The server was unable to deliver your message (ex: unknown user, mailbox not found).",
"Email": "anything@blackhole.haskimail.ru",
"BouncedAt": "2014-01-15T16:09:19.6421112-05:00",
"Subject": "SC API5 Test"
}
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/email/withTemplate/": {
"post": {
"operationId": "email-with-template",
"summary": "Отправка письма с шаблоном",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| TemplateId | integer | обязательный ID шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateAlias`. |\n| --- | --- | --- |\n| TemplateAlias | string | обязательный Псевдоним шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateId`. |\n| TemplateModel | object | обязательный Модель данных, которая будет применена к указанному шаблону для генерации `HtmlBody`, `TextBody`, и `Subject`. |\n| From | string | обязательный Email-адрес отправителя. Должен иметь зарегистрированную и подтвержденную подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени необходимо экранировать. |\n| To | string | обязательный Email-адрес получателя. Несколько адресов разделяются запятой. Максимум 50. |\n| Cc | string | Email-адрес получателя для копии (Cc). Несколько адресов разделяются запятой. Максимум 50. |\n| Bcc | string | Email-адрес получателя для скрытой копии (Bcc). Несколько адресов разделяются запятой. Максимум 50. |\n| Tag | string | Тег, позволяющий категоризировать исходящие письма для получения детальной статистики. Максимум 1000 символов. |\n| ReplyTo | string | Email-адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для включения. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | string | Активировать отслеживание кликов по ссылкам в HTML или текстовой версии письма. Возможные значения: `None` `HtmlAndText` `HtmlOnly` `TextOnly` |\n| Attachments | array | Список вложений. |\n| Metadata | object | Пользовательские метаданные в формате ключ/значение. |\n| MessageStream | string | ID канала, который будет использоваться для отправки. Если не указан, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| To | string | Email-адрес получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#email-with-template)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"To": "receiver@example.com",
"SubmittedAt": "2014-02-17T07:25:01.4178645-05:00",
"MessageID": "0a129aee-e1cd-480d-b08d-4f48548ff48d",
"ErrorCode": 0,
"Message": "OK"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"From": "sender@example.com",
"To": "receiver@example.com",
"TemplateId": 1234,
"TemplateModel": {
"user_name": "Иван Дурак"
}
}
}
}
}
}
},
"/templates/push": {
"put": {
"operationId": "push-templates",
"summary": "Перенос шаблонов на другой сервер",
"tags": [
"API Шаблонов"
],
"description": "Переносит все шаблоны с изменениями на другой сервер. Если шаблон уже существует на целевом сервере, он будет обновлен. Если шаблон не существует на целевом сервере, он будет создан, и ему будет присвоен псевдоним шаблона с исходного сервера.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен, доступный только владельцу аккаунта, можно найти на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n| SourceServerID | string | обязательный ID исходного сервера, содержащего шаблоны, которые будут перенесены. |\n| --- | --- | --- |\n| DestinationServerID | string | обязательный ID целевого сервера, на который будут перенесены шаблоны. |\n| PerformChanges | boolean | обязательный Указывает, следует ли переносить шаблоны на целевой сервер. Этот параметр можно установить в `false`, чтобы выполнить «тестовый запуск» операции и увидеть, какие шаблоны будут созданы или обновлены в результате. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает общее количество изменений в шаблонах. |\n| --- | --- | --- |\n| Templates | object | Список затронутых шаблонов на целевом сервере. |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#push-templates)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 1,
"Templates": [
{
"TemplateId": 7270,
"Name": "Comment notification"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"SourceServerID": 997287,
"DestinationServerID": 997285,
"PerformChanges": true
}
}
}
}
}
},
"/templates/{templateIdOrAlias}": {
"get": {
"operationId": "get-template",
"summary": "Получение шаблона",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n| Subject | string | Содержимое для поля Subject при отправке письма с этим шаблоном. |\n| HtmlBody | string | Содержимое для поля HtmlBody при отправке письма с этим шаблоном. |\n| TextBody | string | Содержимое для поля TextBody при отправке письма с этим шаблоном. |\n| AssociatedServerId | integer | ID сервера, с которым связан этот шаблон. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#get-template)",
"parameters": [
{
"name": "templateIdOrAlias",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Name": "Onboarding Email",
"TemplateId": 1234,
"Subject": "Hi there, {{Name}}",
"HtmlBody": "Hello dear Haskimail user. {{Name}}",
"TextBody": "{{Name}} is a {{Occupation}}",
"AssociatedServerId": 1
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"operationId": "edit-template",
"summary": "Редактирование шаблона",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| HtmlBody | string | обязательный Содержимое для поля HtmlBody при отправке письма с этим шаблоном. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| TextBody | string | обязательный Содержимое для поля TextBody при отправке письма с этим шаблоном. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| | | |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#edit-template)",
"parameters": [
{
"name": "templateIdOrAlias",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TemplateId": 1234,
"Name": "Onboarding Email"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Onboarding Email",
"Subject": "Hello from {{company.name}}!",
"TextBody": "Hello, {{name}}!",
"HtmlBody": "Hello, {{name}}!"
}
}
}
}
},
"delete": {
"operationId": "delete-template",
"summary": "Удаление шаблона",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Связанное сообщение об успехе или ошибке. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#delete-template)",
"parameters": [
{
"name": "templateIdOrAlias",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Template 1234 removed."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/templates": {
"post": {
"operationId": "create-template",
"summary": "Создание шаблона",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| HtmlBody | string | обязательный HTML-содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в `HtmlBody` только один раз. |\n| TextBody | string | обязательный Текстовое содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в TextBody только один раз. |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном.Поле Subject обязательно только для стандартных шаблонов. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Указывать тему для шаблонов-макетов запрещено, это приведет к ошибке API. |\n| AssociatedServerId | integer | обязательный ID сервера, к которому будет привязан шаблон. |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#create-template)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TemplateId": 1234,
"Name": "Onboarding Email"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Welcome Email",
"HtmlBody": "Hello{{name}}",
"TextBody": "Hello, {{name}}",
"Subject": "Hello, from {{company.name}}",
"AssociatedServerId": "1"
}
}
}
}
},
"get": {
"operationId": "list-templates",
"summary": "Список шаблонов",
"tags": [
"API Шаблонов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Querystring parameters**\n\n| Count | обязательный Количество возвращаемых шаблонов. |\n| --- | --- |\n| Offset | обязательный Количество шаблонов, которое нужно «пропустить» перед возвратом результатов. |\n\n**Ответ**\n\n| TotalCount | integer | Общее количество шаблонов, связанных с текущим сервером. |\n| --- | --- | --- |\n| Templates | array | Список шаблонов, связанных с этим сервером. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#list-templates)",
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "100"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
},
{
"name": "LayoutTemplate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "my-layout"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 2,
"Templates": [
{
"TemplateId": 1234,
"Name": "Password Recovery Email"
},
{
"Active": true,
"TemplateId": 5678,
"Name": "Default Layout"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/message-streams": {
"get": {
"operationId": "list-message-streams",
"summary": "Список каналов",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| MessageStreamType | Фильтрует каналы по типу. Возможные значения: `All` `Transactional` `Broadcasts`. Defaults to `All`. |\n| --- | --- |\n| IncludeArchivedStreams | Логический фильтр для включения архивных каналов в список. По умолчанию: `False`. |\n\n**Ответ**\n\n| MessageStreams | array | Список каналов на сервере. |\n| --- | --- | --- |\n| ID | string | ID канала. |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n| TotalCount | integer | Количество полученных каналов. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#list-message-streams)",
"parameters": [
{
"name": "MessageStreamType",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "all"
},
{
"name": "IncludeArchivedStreams",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "true"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"MessageStreams": [
{
"ID": "broadcasts",
"ServerID": 123457,
"Name": "Broadcast Stream",
"MessageStreamType": "Broadcasts",
"ArchivedAt": "2020-07-03T00:00:00-04:00"
},
{
"ID": "outbound",
"ServerID": 123457,
"Name": "Transactional Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": null
},
{
"ID": "Transactional",
"ServerID": 123457,
"Name": "Transactional Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": null
},
{
"ID": "transactional-dev",
"ServerID": 123457,
"Name": "My Dev Transactional Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": null
}
],
"TotalCount": 4
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"operationId": "create-a-message-stream",
"summary": "Создание канала",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| ServerID | string | обязательный Идентификатор сервера, к которому привязан канал. |\n| --- | --- | --- |\n| Name | string | обязательный Название канала. |\n| MessageStreamType | string | обязательный Тип создаваемого канала. Возможные значения: `Broadcasts` `Transasctional` |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#create-a-message-stream)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": "transactional-dev",
"ServerID": 123457,
"Name": "My Dev Transactional Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": "2020-07-02T00:00:00-04:00"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"ServerID": "transactional-dev",
"Name": "My Dev Transactional Stream",
"MessageStreamType": "Transactional"
}
}
}
}
}
},
"/message-streams/{stream_ID}": {
"get": {
"operationId": "get-a-message-stream",
"summary": "Получение информации о канале",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#get-a-message-stream)",
"parameters": [
{
"name": "stream_ID",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": "broadcasts",
"ServerID": 123456,
"Name": "Broadcast Stream",
"MessageStreamType": "Broadcasts",
"ArchivedAt": null
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"patch": {
"operationId": "edit-a-message-stream",
"summary": "Редактирование канала",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#edit-a-message-stream)",
"parameters": [
{
"name": "stream_ID",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": "transactional-dev",
"ServerID": 123457,
"Name": "Updated Dev Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": null
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Updated Dev Stream"
}
}
}
}
}
},
"/message-streams/{stream_ID}/archive": {
"post": {
"operationId": "archive-a-message-stream",
"summary": "Архивация канала",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | string | ID сервера, с которым связан канал. |\n| ExpectedPurgeDate | string | Канал будет удален через 45 дней после даты архивации. До этой даты его можно восстановить. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#archive-a-message-stream)",
"parameters": [
{
"name": "stream_ID",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": "transactional-dev",
"ServerID": 123457,
"ExpectedPurgeDate": "2020-08-30T12:30:00.00-04:00"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/message-streams/{stream_ID}/unarchive": {
"post": {
"operationId": "unarchive-a-stream",
"summary": "Разархивация канала",
"tags": [
"API Каналов"
],
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Inbound` `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#unarchive-a-stream)",
"parameters": [
{
"name": "stream_ID",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": "transactional-dev",
"ServerID": 123457,
"Name": "Updated Dev Stream",
"MessageStreamType": "Transactional",
"ArchivedAt": null
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/servers/{serverid}": {
"get": {
"operationId": "get-server",
"summary": "Получение информации о сервере",
"tags": [
"API Серверов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#get-server)",
"parameters": [
{
"name": "serverid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1,
"Name": "Staging Testing",
"ApiTokens": [
"server token"
],
"Color": "red",
"SmtpApiActivated": true,
"TrackOpens": false,
"TrackLinks": false
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"operationId": "edit-server",
"summary": "Редактировать сервер",
"tags": [
"API Серверов"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#edit-server)",
"parameters": [
{
"name": "serverid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1,
"Name": "Production Testing",
"ApiTokens": [
"Server Token"
],
"Color": "blue",
"SmtpApiActivated": false,
"TrackOpens": false,
"TrackLinks": false
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Production 2",
"Color": "Blue"
}
}
}
}
},
"delete": {
"operationId": "delete-server",
"summary": "Удаление сервера",
"tags": [
"API Серверов"
],
"description": "Примечание: Эта функция доступна не для всех аккаунтов. Пожалуйста, [свяжитесь со службой поддержки](/contact), если у вас возникнут вопросы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ на запрос |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#delete-server)",
"parameters": [
{
"name": "serverid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Сервер Production Server 2 удален."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/servers": {
"post": {
"operationId": "create-server",
"summary": "Создание сервера",
"tags": [
"API Серверов"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#create-server)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1,
"Name": "Staging Testing",
"ApiTokens": [
"server token"
],
"Color": "red",
"SmtpApiActivated": true,
"TrackOpens": false,
"TrackLinks": false
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Production",
"Color": "Purple"
}
}
}
}
},
"get": {
"operationId": "list-servers",
"summary": "Список серверов",
"tags": [
"API Серверов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | integer | обязательный Количество серверов, возвращаемых в ответе. |\n| --- | --- | --- |\n| offset | integer | обязательный Количество серверов, которые нужно пропустить. |\n| name | string | Фильтрация по имени сервера. Обратите внимание, что это строковый поиск, поэтому `MyServer` будет соответствовать `MyServer`,`MyServer Production` и `MyServer Test`. |\n\n**Ответ**\n\n| TotalCount | integer | Количество полученных серверов. |\n| --- | --- | --- |\n| Servers | array | Список серверов. |\n| ID | integer | ID сервера. |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#list-servers)",
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 2,
"Servers": [
{
"ID": 1,
"Name": "Production01",
"ApiTokens": [
"server token"
],
"Color": "red",
"SmtpApiActivated": true,
"TrackOpens": false,
"TrackLinks": false
},
{
"ID": 2,
"Name": "Production02",
"ApiTokens": [
"server token"
],
"Color": "green",
"SmtpApiActivated": true,
"TrackOpens": true,
"TrackLinks": true
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/domains": {
"get": {
"operationId": "list-domains",
"summary": "Список доменов",
"tags": [
"API Доменов"
],
"description": "Получает список доменов с общей информацией и статусом аутентификации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько доменов соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| Domains | array | Список объектов, каждый из которых представляет собой домен. |\n| Name | string | Название домена. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| ReturnPathDomainVerified | boolean | TСтатус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#list-domains)",
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 2,
"Domains": [
{
"Name": "haskimail.ru",
"SPFVerified": true,
"DKIMVerified": true,
"ReturnPathDomainVerified": false,
"ID": 36735
},
{
"Name": "example.com",
"SPFVerified": true,
"DKIMVerified": true,
"ReturnPathDomainVerified": true,
"ID": 81605
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"operationId": "create-domain",
"summary": "Создание домена",
"tags": [
"API Доменов"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#create-domain)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Name": "newdomain.com",
"SPFVerified": false,
"SPFHost": "newdomain.com",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"WeakDKIM": false,
"DKIMHost": "",
"DKIMTextValue": "",
"ReturnPathDomainVerified": false,
"ID": 36736
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "example.com"
}
}
}
}
}
},
"/domains/{domainid}": {
"get": {
"operationId": "domain",
"summary": "Получение информации о домене",
"tags": [
"API Доменов"
],
"description": "Получает всю информацию о конкретном домена./p>\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domain)",
"parameters": [
{
"name": "domainid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Name": "haskimail.ru",
"SPFVerified": true,
"SPFHost": "haskimail.ru",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"WeakDKIM": false,
"DKIMHost": "jan2013pm._domainkey.haskimail.ru",
"DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
"ReturnPathDomainVerified": false,
"ID": 36735
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"delete": {
"operationId": "delete-domain",
"summary": "Удаление домена",
"tags": [
"API Доменов"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ о результате |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#delete-domain)",
"parameters": [
{
"name": "domainid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Domain example.com removed."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/domains/{domainid}/verifyDkim": {
"put": {
"operationId": "domains-verify-dkim",
"summary": "Проверка статуса DKIM",
"tags": [
"API Доменов"
],
"description": "Проверить DKIM-ключи для указанного домена.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domains-verify-dkim)",
"parameters": [
{
"name": "domainid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Name": "haskimail.ru",
"SPFVerified": true,
"SPFHost": "haskimail.ru",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"WeakDKIM": false,
"DKIMHost": "jan2013pm._domainkey.haskimail.ru",
"DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
"ReturnPathDomainVerified": false,
"ID": 36735
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/domains/{domainid}/verifyspf": {
"post": {
"operationId": "verify-spf",
"summary": "Проверка SPF-записи",
"tags": [
"API Доменов"
],
"description": "Выполнит DNS-запрос для вашего домена и попытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе покажет, прошла ли проверка SPF успешно.\n\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| --- | --- | --- |\n| SPFVerified | boolean | Текстовая DNS-запись SPF правильно настроена у вашего регистратора домена или DNS-хостинга. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#verify-spf)",
"parameters": [
{
"name": "domainid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"SPFHost": "example.com",
"SPFVerified": true,
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all"
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/senders": {
"get": {
"operationId": "list-sender-signatures",
"summary": "Список подписей отправителей",
"tags": [
"API подписей отправителей"
],
"description": "Получает список подписей отправителей с краткой информацией, связанной с вашим аккаунтом.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько подписей отправителей соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| SenderSignatures | array | Список объектов, каждый из которых представляет собой подпись отправителя. |\n| Domain | string | Домен, связанный с подписью отправителя. |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#list-sender-signatures)",
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "50"
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"TotalCount": 2,
"SenderSignatures": [
{
"Domain": "haskimail.ru",
"EmailAddress": "jp@haskimail.ru",
"ReplyToEmailAddress": "info@haskimail.ru",
"Name": "JP Toto",
"Confirmed": true,
"ID": 36735
},
{
"Domain": "example.com",
"EmailAddress": "jp@example.com",
"ReplyToEmailAddress": "",
"Name": "JP Toto",
"Confirmed": true,
"ID": 81605
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"operationId": "create-signature",
"summary": "Создание подписи",
"tags": [
"API подписей отправителей"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| FromEmail | string | обязательный Email-адрес, который будет связан с подписью отправителя. |\n| --- | --- | --- |\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email associated with sender signature. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#create-signature)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Domain": "example.com",
"EmailAddress": "ivan.ivanov@example.com",
"ReplyToEmailAddress": "reply@example.com",
"Name": "Иван Иванов",
"Confirmed": false,
"SPFVerified": false,
"SPFHost": "example.com",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"DKIMHost": "",
"DKIMTextValue": "",
"DKIMPendingHost": "20140220130148.pm._domainkey.example.com",
"DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...",
"DKIMRevokedHost": "",
"DKIMRevokedTextValue": "",
"SafeToRemoveRevokedKeyFromDNS": false,
"DKIMUpdateStatus": "Pending",
"ReturnPathDomain": "pm-bounces.example.com",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "pm.mtasv.net",
"ID": 1,
"ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"FromEmail": "ivan.ivanov@example.com",
"Name": "Иван Иванов",
"ReplyToEmail": "reply@example.com",
"ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}
}
}
}
}
},
"/senders/{signatureid}": {
"get": {
"operationId": "sender-signature",
"summary": "Получение деталей подписи отправителя",
"tags": [
"API подписей отправителей"
],
"description": "Получает все детали для конкретной подписи отправителя.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#sender-signature)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Domain": "haskimail.ru",
"EmailAddress": "jp@haskimail.ru",
"ReplyToEmailAddress": "info@haskimail.ru",
"Name": "JP Toto",
"Confirmed": true,
"SPFVerified": true,
"SPFHost": "haskimail.ru",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"DKIMHost": "jan2013.pm._domainkey.haskimail.ru",
"DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
"DKIMPendingHost": "20131031155228.pm._domainkey.haskimail.ru",
"DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
"DKIMRevokedHost": "",
"DKIMRevokedTextValue": "",
"SafeToRemoveRevokedKeyFromDNS": false,
"DKIMUpdateStatus": "Pending",
"ReturnPathDomain": "pm-bounces.haskimail.ru",
"ReturnPathDomainVerified": false,
"ReturnPathDomainCNAMEValue": "pm.mtasv.net",
"ID": 36735,
"ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"operationId": "edit-signature",
"summary": "Редактирование подписи",
"tags": [
"API подписей отправителей"
],
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| --- | --- | --- |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#edit-signature)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Domain": "example.com",
"EmailAddress": "ivan.ivanov@example.com",
"ReplyToEmailAddress": "jane.doe@example.com",
"Name": "Jane Doe",
"Confirmed": false,
"SPFVerified": false,
"SPFHost": "crazydomain.com",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"DKIMHost": "",
"DKIMTextValue": "",
"DKIMPendingHost": "20140220130148.pm._domainkey.crazydomain.com",
"DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...",
"DKIMRevokedHost": "",
"DKIMRevokedTextValue": "",
"SafeToRemoveRevokedKeyFromDNS": false,
"DKIMUpdateStatus": "Pending",
"ReturnPathDomain": "pm-bounces.example.com",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "pm.mtasv.net",
"ID": 1,
"ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Name": "Вася Пупкин",
"ReplyToEmail": "vasya.pupkin@example.com",
"ReturnPathDomain": "pm-bounces.example.com"
}
}
}
}
},
"delete": {
"operationId": "delete-signature",
"summary": "Удаление подписи",
"tags": [
"API подписей отправителей"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#delete-signature)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Signature someone@example.com removed."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/senders/{signatureid}/resend": {
"post": {
"operationId": "resend-confirmation",
"summary": "Повторная отправка подтверждения",
"tags": [
"API подписей отправителей"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#resend-confirmation)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Confirmation email for Sender Signature ivan.ivanov@example.com was re-sent."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/senders/{signatureid}/verifyspf": {
"post": {
"operationId": "signatures-verify-spf",
"summary": "Проверка SPF-записи",
"tags": [
"API подписей отправителей"
],
"description": "Запрашивает DNS вашего домена и пытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе укажет, была ли проверка SPF успешной.\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, связанный с подписью отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, правильно ли настроена SPF DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, правильно ли настроена DKIM DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | string | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#verify-spf)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Domain": "example.com",
"EmailAddress": "ivan.ivanov@example.com",
"ReplyToEmailAddress": "",
"Name": "Иван Иванов",
"Confirmed": false,
"SPFVerified": false,
"SPFHost": "example.com",
"SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
"DKIMVerified": false,
"DKIMHost": "",
"DKIMTextValue": "",
"DKIMPendingHost": "20140220130148.pm._domainkey.example.com",
"DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0gMm3876S...",
"DKIMRevokedHost": "",
"DKIMRevokedTextValue": "",
"SafeToRemoveRevokedKeyFromDNS": false,
"DKIMUpdateStatus": "Pending",
"ReturnPathDomain": "pm-bounces.example.com",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "pm.mtasv.net",
"ID": 110396
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/senders/{signatureid}/requestnewdkim": {
"post": {
"operationId": "request-dkim",
"summary": "Запрос нового DKIM-ключа",
"tags": [
"API подписей отправителей"
],
"description": "Создает новый DKIM-ключ. До тех пор, пока DNS-записи не будут подтверждены, новые значения будут находиться в полях DKIMPendingHost и DKIMPendingTextValue. После того как новое значение DKIM будет проверено в DNS, ожидающие значения переместятся в поля DKIMHost и DKIMTextValue, и Haskimail начнет подписывать письма новым DKIM-ключом.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#request-dkim)",
"parameters": [
{
"name": "signatureid",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 505,
"Message": "This DKIM is already being renewed."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats": {
"get": {
"operationId": "overview",
"summary": "Обзор статистики по исходящим письмам",
"tags": [
"API Статистики"
],
"description": "Получает краткий обзор статистики по всем вашим исходящим письмам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\n| Sent | integer | Количество отправленных писем. |\n| --- | --- | --- |\n| Bounced | integer | Количество возвратов. |\n| BounceRate | double | Уровень возвратов в процентах, рассчитанный от общего числа отправленных. |\n| SpamComplaints | integer | Количество жалоб на спам. |\n| SpamComplaintsRate | double | Уровень жалоб на спам в процентах, рассчитанный от общего числа отправленных. |\n| Opened | integer | Количество открытий. |\n| OpenRate | double | Уровень открытий в процентах, рассчитанный от общего числа отправленных. |\n| Clicked | integer | Общее количество кликов по всем отслеживаемым ссылкам. |\n| ClickRate | double | Уровень кликов в процентах, рассчитанный от общего числа отправленных. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#overview)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Sent": 615,
"Bounced": 64,
"BounceRate": 10.4,
"SpamComplaints": 10,
"SpamComplaintsRate": 1.62,
"Opened": 166,
"Clicked": 72,
"OpenRate": 12.5,
"ClickRate": 7.82
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats/sends": {
"get": {
"operationId": "sent-counts",
"summary": "Статистика по отправленным",
"tags": [
"API Статистики"
],
"description": "Получает общее количество отправленных вами писем.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отправленных писем по дате. |\n| --- | --- | --- |\n| Sent | integer | Количество отправленных писем. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#sent-counts)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Days": [
{
"Date": "2014-01-01",
"Sent": 140
},
{
"Date": "2014-01-02",
"Sent": 160
},
{
"Date": "2014-01-04",
"Sent": 50
},
{
"Date": "2014-01-05",
"Sent": 115
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats/bounces": {
"get": {
"operationId": "bounce-counts",
"summary": "Статистика по возвратам",
"tags": [
"API Статистики"
],
"description": "Получает общее количество отправленных вами писем, которые были возвращены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество возвратов по дате. |\n| --- | --- | --- |\n| HardBounce | integer | Указывает общее количество жестких возвратов. |\n| SoftBounce | integer | Указывает общее количество мягких возвратов. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#bounce-counts)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Days": [
{
"Date": "2014-01-01",
"HardBounce": 12,
"SoftBounce": 36
},
{
"Date": "2014-01-03",
"HardBounce": 7
},
{
"Date": "2014-01-04",
"HardBounce": 4
},
{
"Date": "2014-01-05",
"HardBounce": 25,
"SoftBounce": 5
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats/spam": {
"get": {
"operationId": "spam-complaints",
"summary": "Статистика по жалобам на спам",
"tags": [
"API Статистики"
],
"description": "Получает общее количество получателей, которые отметили ваше письмо как спам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество жалоб на спам по дате. |\n| --- | --- | --- |\n| SpamComplaint | integer | Количество жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#spam-complaints)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Days": [
{
"Date": "2014-01-01",
"SpamComplaint": 2
},
{
"Date": "2014-01-02",
"SpamComplaint": 3
},
{
"Date": "2014-01-05",
"SpamComplaint": 5
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats/opens": {
"get": {
"operationId": "email-open-counts",
"summary": "Статистика по открытиям",
"tags": [
"API Статистики"
],
"description": "Получает общее количество получателей, которые открыли ваши письма. Эта информация записывается, только если для письма включено отслеживание открытий.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отслеживаемых писем по дате. |\n| --- | --- | --- |\n| Opens | integer | Указывает общее количество открытых писем. Это число включает получателей, которые открывали ваше письмо несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#email-open-counts)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Days": [
{
"Date": "2014-01-01",
"Opens": 44
},
{
"Date": "2014-01-02",
"Opens": 46
},
{
"Date": "2014-01-03",
"Opens": 25
},
{
"Date": "2014-01-04",
"Opens": 25
},
{
"Date": "2014-01-05",
"Opens": 26
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/stats/clicks": {
"get": {
"operationId": "click-counts",
"summary": "Статистика по кликам",
"tags": [
"API Статистики"
],
"description": "Получает общее количество уникальных ссылок, по которым были совершены переходы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество кликов по дате. |\n| --- | --- | --- |\n| Clicks | integer | Указывает общее количество кликов по ссылкам. Это число включает получателей, которые кликали по ссылкам в вашем письме несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#click-counts)",
"parameters": [
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-01-01"
},
{
"name": "todate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2014-02-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Days": [
{
"Date": "2014-01-01",
"Clicks": 44
},
{
"Date": "2014-01-02",
"Clicks": 46
},
{
"Date": "2014-01-03",
"Clicks": 25
},
{
"Date": "2014-01-04",
"Clicks": 25
},
{
"Date": "2014-01-05",
"Clicks": 26
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/message-streams/{stream_id}/suppressions/dump": {
"get": {
"operationId": "suppression-dump",
"summary": "Дамп стоп-списка",
"tags": [
"API Стоп-списков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| SuppressionReason | Фильтр по причине исключения. Возможные значения:`HardBounce`, `SpamComplaint`, `ManualSuppression`. |\n| --- | --- |\n| Origin | Фильтр по источнику добавления адреса в список исключений. Возможные значения: `Recipient`, `Customer`, `Admin`. |\n| todate | Фильтровать исключения по указанную дату (включительно). Например: 2020-02-01. |\n| fromdate | Фильтровать исключения, начиная с указанной даты (включительно). Например: 2020-02-01. |\n| EmailAddress | Фильтр по email-адресу. |\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#suppression-dump)",
"parameters": [
{
"name": "stream_id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "recipient"
},
{
"name": "fromdate",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "2019-12-01"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Suppressions": [
{
"EmailAddress": "address@wildbit.com",
"SuppressionReason": "ManualSuppression",
"Origin": "Recipient",
"CreatedAt": "2019-12-17T08:58:33-05:00"
},
{
"EmailAddress": "bounce.address@wildbit.com",
"SuppressionReason": "HardBounce",
"Origin": "Recipient",
"CreatedAt": "2019-12-17T08:58:33-05:00"
},
{
"EmailAddress": "spam.complaint.address@wildbit.com",
"SuppressionReason": "SpamComplaint",
"Origin": "Recipient",
"CreatedAt": "2019-12-17T08:58:33-05:00"
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/message-streams/{stream_id}/suppressions": {
"post": {
"operationId": "create-a-suppression",
"summary": "Добавить в стоп-лист",
"tags": [
"API Стоп-списков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив, содержащий email-адреса, для которых нужно создать исключения. Максимум 50 исключений могут быть созданы за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается создание исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс создания. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено создание исключения. |\n| Status | string | Статус запроса на создание исключения. Возможные значения: `Failed`, `Suppressed`. |\n| Message | string | Если адрес не может быть исключен (статус `Failed`), будет указана причина сбоя. Если исключение создано (статус `Suppressed`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#create-a-suppression)",
"parameters": [
{
"name": "stream_id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Suppressions": [
{
"EmailAddress": "good.address@wildbit.com",
"Status": "Suppressed",
"Message": null
},
{
"EmailAddress": "spammy.address@wildbit.com",
"Status": "Failed",
"Message": "You do not have the обязательный authority to change this suppression."
},
{
"EmailAddress": "invalid-email-address",
"Status": "Failed",
"Message": "An invalid email address was provided."
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Suppressions": [
{
"EmailAddress": "good.address@wildbit.com"
},
{
"EmailAddress": "spammy.address@wildbit.com"
},
{
"EmailAddress": "invalid-email-address"
}
]
}
}
}
}
}
},
"/message-streams/{stream_id}/suppressions/delete": {
"post": {
"operationId": "delete-a-suppression",
"summary": "Удаление исключений",
"tags": [
"API Стоп-списков"
],
"description": "Исключения, созданные по причине жалоб на спам (`SpamComplaint`), не могут быть удалены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив email-адресов, для которых нужно удалить исключения. Максимум 50 исключений могут быть удалены за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается удаление исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс удаления. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено удаление исключения. |\n| Status | string | Статус запроса на удаление исключения. Возможные значения: `Failed`, `Deleted`. |\n| Message | string | Если адрес не может быть удален (статус `Failed`), будет указана причина сбоя. Если удаление исключения прошло успешно (статус `Deleted`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#delete-a-suppression)",
"parameters": [
{
"name": "stream_id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Suppressions": [
{
"EmailAddress": "good.address@wildbit.com",
"Status": "Deleted",
"Message": null
},
{
"EmailAddress": "not.suppressed@wildbit.com",
"Status": "Deleted",
"Message": null
},
{
"EmailAddress": "spammy.address@wildbit.com",
"Status": "Failed",
"Message": "You do not have the обязательный authority to change this suppression."
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Suppressions": [
{
"EmailAddress": "bounced.address@wildbit.com"
},
{
"EmailAddress": "not.suppressed@wildbit.com"
},
{
"EmailAddress": "spammy.address@wildbit.com"
}
]
}
}
}
}
}
},
"/webhooks": {
"get": {
"operationId": "list-webhooks",
"summary": "Список вебхуков",
"tags": [
"API Вебхуков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#list-webhooks)",
"parameters": [
{
"name": "MessageStream",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
},
"example": "outbound"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"Webhooks": [
{
"ID": 1234567,
"Url": "http://www.example.com/webhook-test-tracking",
"MessageStream": 1,
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false
},
"SpamComplaint": {
"Enabled": false
}
}
},
{
"ID": 1234568,
"Url": "http://www.example.com/webhook-test-bounce",
"MessageStream": 2,
"Triggers": {
"Open": {
"Enabled": false
},
"Click": {
"Enabled": false
},
"Delivery": {
"Enabled": false
},
"Bounce": {
"Enabled": true
},
"SpamComplaint": {
"Enabled": false
}
}
}
]
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"operationId": "create-a-webhook",
"summary": "Создание вебхука",
"tags": [
"API Вебхуков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | обязательный URL вашего вебхука. |\n| --- | --- | --- |\n| MessageStream | string | Канал, с которым связан этот вебхук. Если MessageStream не указан, будет использован транзакционный канал по умолчанию. |\n| Triggers | object | Список различных событий вебхуков для включения. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#create-a-webhook)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1234567,
"Url": "http://www.example.com/webhook-test-tracking",
"MessageStream": "outbound",
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false
},
"SpamComplaint": {
"Enabled": false
}
}
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Url": "http://www.example.com/webhook-test-tracking",
"MessageStream": "outbound",
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false
},
"SpamComplaint": {
"Enabled": false
}
}
}
}
}
}
}
},
"webhooks/{Id}": {
"get": {
"operationId": "get-a-webhook",
"summary": "Получение вебхука",
"tags": [
"API Вебхуков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#get-a-webhook)",
"parameters": [
{
"name": "Id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1234567,
"Url": "http://www.example.com/webhook-test-tracking",
"MessageStream": 1,
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false
},
"SpamComplaint": {
"Enabled": false
}
}
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"operationId": "edit-a-webhook",
"summary": "Редактирование вебхука",
"tags": [
"API Вебхуков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | Необязательно. Ваш новый URL вебхука. |\n| --- | --- | --- |\n| Triggers | object | Необязательно. Список событий для включения/отключения вебхуков. Если вы передаете настройки только для одного триггера (например, click), остальные останутся без изменений. Если поле Triggers не передается, настройки всех триггеров также не изменятся. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#edit-a-webhook)",
"parameters": [
{
"name": "Id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ID": 1234567,
"Url": "http://www.example.com/webhooks",
"MessageStream": "outbound",
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": true
},
"SpamComplaint": {
"Enabled": true
}
}
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"Url": "http://www.example.com/webhooks",
"HttpAuth": {
"Username": "user",
"Password": "pass"
},
"HttpHeaders": [
{
"Name": "name",
"Value": "value"
}
],
"Triggers": {
"Open": {
"Enabled": true
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": true
},
"SpamComplaint": {
"Enabled": true
}
}
}
}
}
}
}
},
"/webhooks/{Id}": {
"delete": {
"operationId": "delete-a-webhook",
"summary": "Удаление вебхука",
"tags": [
"API Вебхуков"
],
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Сообщение о результате |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#delete-a-webhook)",
"parameters": [
{
"name": "Id",
"in": "path",
"required": true,
"description": "Подставьте значение.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"example": {
"ErrorCode": 0,
"Message": "Webhook 1234 removed."
}
}
}
},
"default": {
"description": "Ошибка. Код в error.code точнее HTTP-статуса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Заголовок Authorization: Bearer <ключ>. Основной способ."
},
"apiKeyQuery": {
"type": "apiKey",
"in": "query",
"name": "",
"description": "Ключ параметром строки запроса. Проще, но адрес попадает в логи прокси и веб-серверов."
}
},
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "Код ошибки DashaMail. Точнее HTTP-статуса: одному статусу соответствует несколько кодов."
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}