Осуществляется POST запросом, все параметры передаются в формате JSON в теле запроса.
https://api.quantumtec.eu/v1/email/bulk| Параметр | Значение |
|---|---|
| Content-Type | application/json |
| Accept | application/json |
| X-ApiKey | API ключ |
Параметры отправляются в формате JSON
| Параметр | Формат | Применение | Описание |
|---|---|---|---|
| bulkId | string | Не обязательно | ID рассылки. Если не указывать, будет назначен автоматически |
| from | string | Обязательно | Адрес отправителя |
| text | string | Обязательно | текст письма (plain text или HTML) |
| subject | string | Обязательно | Тема письма |
| replyTo | string | Не обязательно | Адрес для ответа. Ответ на письмо будет отправлен на этот адрес |
| isHtml | boolean | Обязательно | Если true, то содержимое поля текст будет интерпретироваться как HTML |
| recipients | array | Обязательно | Массив номеров получателей сообщения |
| recipients(to) | string | Обязательно | Номер получателя |
| recipients(messageId) | string | Не обязательно | Указывается клиентом в случае необходимости использовать собственный ID сообщений. Если не указывать будет назначен автоматически |
| attachments | array | Не обязательно | Набор параметров для отправки вложений |
| attachments(fileName) | string | Не обязательно | Имя файла |
| attachments(contentType) | string | Не обязательно | Тип файла |
| attachments(data) | string | Не обязательно | Сам файл |
| startTime | string | Не обязательно | Время старта рассылки. Указывается в формате: "2018-01- 01T00:10:20.000Z", часовой пояс указываемого времени должен быть UTC. Если не указывается, рассылка начнется незамедлительно |
В ответ на запрос будет направлен набор данных в формате JSON.
| Параметр | Описание |
|---|---|
| bulkId | Идентификатор Email кампании |