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

Осуществляется с помощью POST-запроса. Событие для отправки письма определяется на стороне клиента. Название операции и набор принимаемых полей настраиваются в системе Mindbox. Подробней про вызов метода можно прочитать [здесь](https://developers.mindbox.ru/docs/v3).

```xml title="Универсальная операция"
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` — объект для передачи [пользовательских параметров](https://help.mindbox.ru/docs/custom-parameters-operation) при их наличии.
* `attachments` — массив для передачи [вложений](https://help.mindbox.ru/docs/email-with-attachment) при их наличии.

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

:::info
  [Подробнее о ключе идемпотентности.](https://help.mindbox.ru/docs/idempotentnost#kak-sozdat-klyuch-idempotentnosti)
:::

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

:::danger
  Отправка Email в режиме `sync` не поддерживает использование `transactionId` — сообщения уйдут клиенту дважды. Для отправки письма используйте режим `async`.

  Если все же необходимо настроить операцию в синхронном режиме с использованием ключа идемпотентности, обратитесь к менеджеру вашего проекта.
:::

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

<Tabs defaultValue="1" className="w-full">
  <ScrollArea className="w-full">
    <TabsList className="flex w-max gap-2">
      <TabsTrigger value="1">Приветственное письмо</TabsTrigger>
      <TabsTrigger value="2">Востановление пароля</TabsTrigger>
      <TabsTrigger value="3">Письмо с продуктовым блоком</TabsTrigger>
      <TabsTrigger value="4">Отправка СМС сообщения</TabsTrigger>
      <TabsTrigger value="5">Отправка сообщения в Viber</TabsTrigger>
      
    </TabsList>
    <ScrollBar orientation="horizontal" />
  </ScrollArea>
  
  <TabsContent value="1">
  ```xml 
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>
```
  </TabsContent>
  <TabsContent value="2">
  ```xml 
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=sendRestore&transactionId=1

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

<operation>
  <customer>
    <email>pivan@mindbox.ru</email>
  </customer>
  <emailMailing>
    <customParameters>
      <restore_link>
        http://mindbox.ru/lk/restore?hash=7DCEE600A554B6CD373DC4ABABFBC3BF5B79154E
      </restore_link>
      <date>2017-09-25</date>
    </customParameters>
  </emailMailing>
</operation>
```
  </TabsContent>
  <TabsContent value="3">
	```xml 
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=sendBuy&transactionId=2

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

<operation>
  <customer>
    <email>pivan@mindbox.ru</email>
  </customer>
  <emailMailing>
    <customParameters>
      <ProductsBlock>
        <![CDATA[
          <table>
   <tr>
      <td width="30%"> <img width="150px" src="http://images.directcrm.ru/campaigns/86709/170354img/mixit.png"></td>
      <td style="padding: 10px 0px 20px 0" width="70%"><strong>Клиент:</strong> онлайн-лаборатория натуральной косметики
         <br><br><strong>Результат:</strong> рост чистой прибыли в <b>3 раза</b><br><br>
         <a style="color:green" href="http://mindbox.ru/case-mixit/">Читать кейс</a>
      </td>
   </tr>
   <tr>
      <td width="30%"> <img width="150px" src="http://images.directcrm.ru/campaigns/86709/170354img/sm.png"></td>
      <td style="padding: 10px 0px 10px 0" width="70%"><strong>Клиент:</strong> магазин аутдор—снаряжения
         <br><br><strong>Результат:</strong> доход от Email-канала относительного общего дохода вырос почти в 3 раза<br><br>
         <a style="color:green" href="http://mindbox.ru/sport-marafon-case/">Читать кейс</a>
      </td>
   </tr>
   <tr>
      <td width="30%"> <img width="150px" src="http://images.directcrm.ru/campaigns/86709/170354img/zzz.png"></td>
      <td style="padding: 10px 0px 10px 0" width="70%"><strong>Клиент:</strong> сервис по доставке продуктов питания и товаров для дома
         <br><br><strong>Результат:</strong> увеличили доход Email-канала с 0% до 30%<br><br>
         <a style="color:green" href="http://mindbox.ru/case-zzz24/">Читать кейс</a>
      </td>
   </tr>
   <tr>
      <td width="30%"> <img width="150px" src="http://images.directcrm.ru/campaigns/86709/170354img/lm.png"></td>
      <td style="padding: 10px 0px 10px 0" width="70%"><strong>Клиент:</strong> магазин товаров для дома
         <br><br><strong>Результат:</strong> автоматизировали Email-маркетинг и увеличили оборот с Email-канала на 6%<br><br>
         <a style="color:green" href="http://mindbox.ru/legkomarket-case/">Читать кейс</a>
      </td>
   </tr>
   <tr>
      <td width="50%"> <img width="150px" src="http://images.directcrm.ru/campaigns/86709/170354img/logo.png"></td>
      <td width="50%"><strong>Клиент:</strong> пивоваренная компания
         <br><br><strong>Результат:</strong> увеличили конверсию промо-акции в 16 раз<br><br>
         <a style="color:green" href="http://mindbox.ru/baltika/">Читать кейс</a>
      </td>
   </tr>
</table>
          ]]>
      </ProductsBlock>
    </customParameters>
  </emailMailing>
</operation>
```
  </TabsContent>
  <TabsContent value="4">
  ```xml 
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=SendSms&transactionId=3

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

<operation>
  <customer>
    <mobilePhone>79001234567</mobilePhone>
  </customer>
  <smsMailing>
    <customParameters>
      <PromoEndDate>2017-09-25</PromoEndDate>
    </customParameters>
  </smsMailing>
</operation>
```
  </TabsContent>
  <TabsContent value="5">

```xml 
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=SendViberMessage&transactionId=4

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

<operation>
  <customer>
    <mobilePhone>79001234567</mobilePhone>
  </customer>
  <viberMailing>
    <customParameters>
      <PromoEndDate>2017-09-25</PromoEndDate>
    </customParameters>
  </viberMailing>
</operation>
```
</TabsContent>
</Tabs>





