xml

Описание метода

Осуществляется с помощью POST-запроса. Событие для отправки письма определяется на стороне клиента. Название операции и набор принимаемых полей настраиваются в системе Mindbox. Подробней про вызов метода можно прочитать здесь.

Универсальная операция
POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}&{transactionId}={Id транзакции в вашей системе}

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey {Секретный ключ, обязательность уточнить у менеджера}


<operation>
  <customer>
    <email>{Email}</email>
  </customer>
  <emailMailing>
    <customParameters>
      <{Имя параметра}>{Значение параметра}</{Имя параметра}>
    </customParameters>
    <attachments>
      <attachment>
        <fileName>{Имя прикрепляемого файла}</fileName>
        <body>
          <fileId>{Идентификатор прикрепляемого файла}</fileId>
        </body>
      </attachment>
    </attachments>
  </emailMailing>
  <executionDateTimeUtc>{Дата и время выполнения (можно использовать для выполнения запроса задним числом)}</executionDateTimeUtc>
</operation>

Параметры запроса

• customer/email — может быть любой другой идентификатор клиента, зависит от настроек операции.
• emailMailing — объект для передачи дополнительных параметров при их наличии. Может меняться на smsMailing/viberMailing/mobilePushMailing/webPushMailing в зависимости от канала рассылок.
• customParameters — объект для передачи пользовательских параметров при их наличии.
• attachments — массив для передачи вложений при их наличии.

transactionId — это ключ идемпотентности, который используется как уникальный идентификатор транзакции отправки письма в вашей системе (необязательный параметр).

По этому идентификатору можно узнать статус рассылки: была ли доставлена, открыта и т.п. Если в Mindbox уже зарегистрирована транзакция с таким transactionId, то повторно рассылка не будет отправлена и в логе запроса будет сообщение Transaction already processed. Если в случае ошибки вы вызываете операцию повторно, то transactionId передавать обязательно. Иначе рассылка может отправиться одному и тому же человеку несколько раз.

Примеры операций

Code
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=sendWelcome

Accept: application/xml
Content-Type: application/xml

<operation>
<customer>
  <email>pivan@mindbox.ru</email>
</customer>
</operation>