/v2/Api/TransactionalsUpdate/{ID} PUT

Позволяет редактировать любые активные или приостановленные сообщения. Данные, которые не будут переданы в этом запросе, не изменятся.


Формат запроса

Параметры ссылки запроса:

ПараметрТипОписание
IDintegerID транзакционного письма. Обязательно указывается в адресе (не внутри запроса).

Элементы тега Data:

Элемент/атрибутТипОписание
ContentcomplexСодержание письма. Обязательный.
SuppressionListsarray[integer]Содержит ID стоп-листов, которые будут проверены перед отправкой. Необязательный.
Channelsarray[complex]Содержит каналы для отправки. Необязательный. Если не указан, то используются стандартные каналы.
StatusstringСтатус транзакционного письма. Может принимать значения: Active, Inactive. Необязательный. По умолчанию, для новых сообщений используются значение Active.

*Добавление любых стоп-листов в этот элемент заменит предыдущие стоп-листы для этого сообщения. Если элемент оставить пустым, то все стоп-листы для этого сообщения будут удалены.

**Добавление любых каналов в этот элемент заменит предыдущие каналы для отправки этого сообщения. Если элемент оставить пустым, то все каналы отправки для этого сообщения будут удалены.

Элементы тега Content:

Элемент/атрибутТипОписание
FromNamestringИмя отправителя. Отображается в поле From. Обязательный.
FromEmailstringЕмейл отправителя. Отображается в поле From. Обязательный.
ReplyToNamestringИмя, которое отображается в поле Reply-To. Необязательный.
ReplyToEmailstringЕмейл, который отображается в поле Reply-To. Необязательный.
SubjectstringТема письма. Обязательный.
HtmlstringHtml-контент. Должен быть заключен в секцию CDATA для передачи в XML. Смотрите примеры. Необязательный.*
PlainstringТекстовое содержание сообщения. Необязательный.*
HeaderintegerID шаблона заголовка. Необязательный.
FooterintegerID шаблона футера. Необязательный.
ContentFromUrlcomplexИспользуется, если содержание сообщения не передается в XML, а находится на внешнем источнике. Необязательный.*
GoogleAnalyticsTagscomplexТеги Google Analytics. Используются для вставки в ссылки в сообщении. Необязательный. Если не указан, то не используются в ссылках.
Tagsarray[string]Список тегов для сообщения. Необязательный.
AttachmentscomplexНабор элементов Attachments, содержащие, например, кодированные PDF файлы и др. Необязательный.**
UrlIntegrationscomplexСписок ID URL-параметров, которые были созданы в настройках субаккаунта. Необязательный.
EnableClickTrackbooleanПри значении false статистика по кликам собираться не будет. По умолчанию используется значение true. Необязательный.
EnableOpenTrackbooleanПри значении false статистика по открытиям собираться не будет. По умолчанию используется значение true. Необязательный.

*Вы можете передать содержание сообщения, используя параметры HTML или Plain, или загрузить из внешнего источника (например, веб-страница или ftp-сервер с zip-архивом, который содержит HTML и картинки), используя параметр ContentFromUrl. Если содержание сообщения не найдено ни в одном месте, то вернется ошибка.

**Вы можете использовать либо ContentFromUrl, либо Attachments.

Если вы хотите отправить картинки вместе с сообщением, то использование ContentFromUrl - единственный способ сделать это.

Элементы тега ContentFromUrl:

Элемент/атрибутТипОписание
UrlstringURL-адрес загружаемого файла. Поддерживаются протоколы HTTP, HTTPS, FTP, SFTP и FTPS. Например, ftp://www.domain.com/mycreative.zip.
UsernamestringUsername, используемый для аутентификации. Необязательный.
PasswordstringPassword, используемый для аутентификации. Необязательный.
FtpAuthstringМетод аутентификации для защищенных FTP серверов. Необязательный. Может принимать значения:
  • None - FTP сервер без аутентификации (по умолчанию)
  • ExplicitTls - сервер с явной TLS/SSL аутентификацией
  • ExplicitSsl - сервер с явной SSL аутентификацией
  • ImplicitSsl - сервер с неявной SSL аутентификацией
FtpUseActiveModebooleanПри значении true для соединения с FTP будет использован active mode. По умолчанию используется значение false.

Элементы тега GoogleAnalyticsTags:

Элемент/атрибутТипОписание
CampaignstringТег Google Analytics "utm_campaign". Необязательный.
SourcestringТег Google Analytics "utm_source". Необязательный.
ContentstringТег Google Analytics "utm_content". Необязательный.

Пропущенный тег "utm_medium" по умолчанию передается как "Email".

Элементы тега Attachment:

Элемент/атрибутТипОписание
FileNamestringИмя файла вложения, например "infosheet.pdf". Должно быть уникальным ( 2 файла не должны иметь одинаковые имена). Обязательный.
MimeTypestringТип файла по стандарту MIME, например "application/pdf". Если не указан, то будет использован тип "application/octet-stream". Необязательный. Тип MIME влияет на то, как различные почтовые клиенты будут обрабатывать вложения, поэтому лучше всего всегда указывать правильный тип.*
ContentstringСодержимое файла вложения. Должно быть кодировано в Base64.** Смотрите пример запроса. Обязательный.

* Типы MIME для различных типов файлов смотрите здесь: http://ru.wikipedia.org/wiki/Список_MIME-типов

** Кодирование в Base64 доступно для большинства языков программирования. Для дополнительной информации смотрите http://ru.wikipedia.org/wiki/Base64

Элементы тега UrlIntegrations:

Элемент/атрибутТипОписание
IdintID номер существующего, не удаленного параметра. Обязательный.

Элемент тега Channel:

Элемент/атрибутТипОписание
IpstringIP адрес канала доставки.
PercentageintegerПроцент емейл адресов, который будет использован для этого канала.

*Сумма процентов для всех выбранных каналов должна быть 100%, иначе вернется сообщение об ошибке. Например, два канала 30 и 70 или 3 канала 25, 25, 50. Список доступных каналов можно найти в настройках в панели ExpertSender.


Ответ

По умолчанию, возвращается пустой ответ и HTTP код "204 No Content".


Примеры


Изменение транзакционного сообщения

Запрос:

PUT https://api.esv2.com/v2/Api/TransactionalsUpdate HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: text/xml;charset=UTF-8 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 1727 
 
 
 <ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>Ваш_API_ключ</ApiKey>
   <Data>
     <Content>
       <FromName>test</FromName>
       <FromEmail>test@test.com</FromEmail>
       <Subject>Hello!</Subject>
       <Html><![CDATA[HelloWorld!<br/>${Snippet('name')}<br/>${Snippet('age')}<br/>]]></Html>
     </Content>
     <Status>Active</Status>
   </Data>
 </ApiRequest>

Ответ:

HTTP/1.1 204 No Content 
Content-Type: text/xml; charset=utf-8 
Date: Tue, 27 Mar 2012 13:28:01 GMT 
Content-Length: 0

Отправка транзакционного сообщения с контентом, загруженным с внешнего источника и полными функциями

Запрос:

PUT https://api.esv2.com/v2/Api/TransactionalsUpdate HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: text/xml;charset=UTF-8 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 1727 

 
   Ваш_API_ключ
   
     
       77
     
     
       test
       test@test.com
       test2
       test2@test.pl
       Hello!
       
         ftp://ftp.domain.com.creative.zip
         username
         password
     	ExplicitTls
       
       
         testcampaign
         testsource
         testcontent
       
       
         
   		 30
   	  
   	  
   		  32
   	  
       
       
         tag1
         tag2
       
       true
       true
     
     
       
         192.168.10.22
         30
       
       
         192.168.10.3
         70
       
     
     Active
   
 


Добавление вложения в транзакционное сообщение

PUT https://api.esv2.com/v2/Api/TransactionalsUpdate HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: text/xml;charset=UTF-8 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 32566


   Ваш_API_ключ
   
     
       
        
        test.pdf
        application/pdf  JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFu
ZyhwbC1QTCkgL1N0cnVjdFRyZWVSb290IDggMCBSL01hcmtJbmZvPDwvTWFya2VkIHRydWU+Pj4+
DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4N
CmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9G
...
ODlFOENBQTNGMTY5NzFBRTU+XSAvUHJldiA4MjU0MS9YUmVmU3RtIDgyMjcwPj4NCnN0YXJ0eHJl
Zg0KODMwNTcNCiUlRU9G
      
    
     
   
 

Часть содержания большого вложения была заменена на "...".