/v2/Api/Messages GET

Возвращает список всех отправленных сообщений. При этом несколько сообщений могут быть получены по заданным условиям. ID конкретного сообщения может быть использован для получения подробной информации об этом сообщении.

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

Список всех отправленных сообщений

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

ПараметрТипОписание
apiKeystringВаш API-key, необходимый для авторизации. Обязательный.
tagstringТег. Необязательный. Если указан, то вернет только сообщения с этим тегом.
startDatedateНеобязательный. Если указан, то отправленные раньше этой даты сообщения не будут указаны. Должен использоваться вместе с endDate для указания временного промежутка. Формат —YYYY-MM-DD.
endDatedateСмотрите startDate.
typestringВозвращает данные только по определенному типу сообщений. Необязательный. Принимает значения:
  • Newsletter
  • Autoresponder
  • Trigger
  • Transactional
  • Confirmation
  • Recurring
  • Test
  • FreeEmailPreview
  • PaidEmailPreview
  • WorkflowMessage

Примеры:

https://api.esv2.com/v2/Api/Messages?apiKey=Ваш_API-ключ
https://api.esv2.com/v2/Api/Messages?apiKey=Ваш_API-ключ&tag=sports 
https://api.esv2.com/v2/Api/Messages?apiKey=Ваш_API-ключ&tag=sports&startDate=2010-05-20&endDate=2010-05-22

Получение информации о сообщении по его ID

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

ПараметрТипОписание
apiKeystringВаш API-key, необходимый для авторизации. Обязательный.
IDintID сообщения. Обязательный. Является частью адреса, а не параметром. Смотрите примеры.

Пример:

https://api.esv2.com/v2/Api/Messages/123?apiKey=Ваш_API-ключ

Ответ

Получить список всех сообщений

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

Элемент/атрибутТипОписание
UserUnknownsarray[complex]Массив элементов message.

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

Элемент/атрибутТипОписание
IdintИдентификатор сообщения.
FromNamestringИмя из "From:" заголовка.
FromEmailstringЕмейл из "From:" заголовка.
SubjectstringТема письма.
TypestringТип письма (Newsletter, Autoresponder, Trigger...).
SentDatedatetimeНеобязательный. Дата, когда сообщение было отправлено. Для сообщений, которые отправлялись несколько раз (например, Autoresponders), вернется первая дата отправки, которая попадает во временной промежуток.
TagsstringНеобязательный. Список тегов через запятую.

Получение информации о сообщении по его ID

Параметры ответа:

Элемент/атрибутТипОписание
IdintИдентификатор сообщения.
FromNamestringИмя из "From:" заголовка.
FromEmailstringЕмейл из "From:" заголовка.
SubjectstringТема письма.
TypestringТип письма (Newsletter, Autoresponder, Trigger...).
SentDatedatetimeНеобязательный. Дата, когда сообщение было отправлено. Для сообщения, которое отправлялось несколько раз (например Autoresponders), вернется первая дата отправки, которая попадает во временной промежуток.
TagsstringНеобязательный. Список тегов через запятую.
ThrottlingMethodstringНеобязательный. Тип распределения.
ThrottlingintНеобязательный. Период распределения (в часах). Показывается если установлен "В ручную"
GoogleAnalyticsTagsarray[complex]Необязательный. Массив тегов GoogleAnalyticsTags (если UTM метки используются в письме).
YandexListIdcomplexНеобязательный. Инфомация о Yandex List ID (если используется в письме).
ChannelsstringНеобязательный. Список каналов через запятую (если было отправлено через каналы, отличные от используемых по умолчанию).
Listsarray[complex]Необязательный. Массив элементов List (листы подписчиков).
Segmentsarray[complex]Необязательный. Массив элементов Segment (сегменты подписчиков).
StatusstringНеобязательный. Статус рассылки (доступен для Стандартных писем).

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

Элемент/атрибутТипОписание
NamestringИмя тега(метки), например "utm_source"
ValuestringЗначение тега

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

Элемент/атрибутТипОписание
IdentifierstringИдентификатор Yandex List ID
CommentstringКомментарий

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

Элемент/атрибутТипОписание
IdintИдентификатор листа.
NamestringИмя листа.

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

Элемент/атрибутТипОписание
IdintИдентификатор сегмента.
NamestringИмя сегмента

Список возможных значений ThrottlingMethod:

Значение ThrottlingMethodОписание
NoneСообщение без распределения отправки по времени.
AutoАвтоматическое распределение отправки по времени.
ManualРаспределение задано вручную (смотри "Throttling" элемент)

Список возможных значений Status:

Значение Status
Scheduled
InProgress
Sent
Paused
Draft
Deleted

Примеры

Получить список всех сообщений

Запрос:

GET 
https://api.esv2.com/v2/Api/Messages?startDate=2010-05-19&apiKey=Ваш_API-ключ HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Ответ:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:56:22 GMT 
Content-Length: 365 
 
 
 <ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Data>
     <Messages>
       <Message>
         <Id>892</Id>
         <Subject>Тестовое стандартное сообщение</Subject>
         <Type>Newsletter</Type>
         <SentDate>2010-05-19T19:35:08</SentDate>
       </Message>
       <Message>
         <Id>893</Id>
         <Subject>Тестовое стандартное сообщение</Subject>
         <Type>Newsletter</Type>
          <SentDate>2010-05-21T14:09:15</SentDate>
         <Tags>test 1</Tags>
       </Message>
     </Messages>
   </Data>
 </ApiResponse>

Получить информацию о сообщении по id

Запрос:

GET 
https://api.esv2.com/v2/Api/Messages/893?apiKey=Ваш_API-ключ HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Ответ:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:59:37 GMT 
Content-Length: 369 
 
 
 <ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Data>
     <Id>893</Id>
     <FromName>Your Favorite Shop</FromName>
     <FromEmail>contact@yfs.com</FromEmail>
     <Subject>test newsletter 2</Subject>
     <Type>Newsletter</Type>
     <SentDate>2010-05-21T14:09:15</SentDate>
     <Tags>test 1</Tags>
     <Channels>192.168.10.2, 192.168.10.3</Channels>
     <Status>Sent</Status>
     <Lists>
       <List>
         <Id>2</Id>
         <Name>test list</Name>
       </List>
     </Lists>
    </Data>
 </ApiResponse>

Пример ответа c Google Analytics и Yandex List ID

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:59:37 GMT 
Content-Length: 455 

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Id>123951</Id>
    <FromName>myFromName</FromName>
    <FromEmail>myfromEmail@domain.com</FromEmail>
    <Subject>Google Analytics tags test</Subject>
    <Type>Newsletter</Type>
    <ThrottlingMethod>Auto</ThrottlingMethod>
    <GoogleAnalyticsTags>
      <GoogleAnalyticsTag>
        <Name>utm_source</Name>
        <Value>testsource</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_medium</Name>
        <Value>Email</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_content</Name>
        <Value>testcontent</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_campaign</Name>
        <Value>testcampaign</Value>
      </GoogleAnalyticsTag>
    </GoogleAnalyticsTags>
    <YandexListId>
      <Identifier>testid</Identifier>
      <Comment>testcomment</Comment>
    </YandexListId>
    <Status>Draft</Status>
  </Data>
</ApiResponse>