/v2/Api/Messages GET
Возвращает список всех отправленных сообщений. При этом несколько сообщений могут быть получены по заданным условиям. ID конкретного сообщения может быть использован для получения подробной информации об этом сообщении.
Формат запроса
Список всех отправленных сообщений
Параметры запроса:
Параметр | Тип | Описание |
---|---|---|
apiKey | string | Ваш API-key, необходимый для авторизации. Обязательный. |
tag | string | Тег. Необязательный. Если указан, то вернет только сообщения с этим тегом. |
startDate | date | Необязательный. Если указан, то отправленные раньше этой даты сообщения не будут указаны. Должен использоваться вместе с endDate для указания временного промежутка. Формат —YYYY-MM-DD. |
endDate | date | Смотрите startDate. |
type | string | Возвращает данные только по определенному типу сообщений. Необязательный. Принимает значения:
|
Примеры:
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
Параметры запроса:
Параметр | Тип | Описание |
---|---|---|
apiKey | string | Ваш API-key, необходимый для авторизации. Обязательный. |
ID | int | ID сообщения. Обязательный. Является частью адреса, а не параметром. Смотрите примеры. |
Пример:
https://api.esv2.com/v2/Api/Messages/123?apiKey=Ваш_API-ключ
Ответ
Получить список всех сообщений
Элементы тега Data в ответе:
Элемент/атрибут | Тип | Описание |
---|---|---|
UserUnknowns | array[complex] | Массив элементов message. |
Элементы тега Message:
Элемент/атрибут | Тип | Описание |
---|---|---|
Id | int | Идентификатор сообщения. |
FromName | string | Имя из "From:" заголовка. |
FromEmail | string | Емейл из "From:" заголовка. |
Subject | string | Тема письма. |
Type | string | Тип письма (Newsletter, Autoresponder, Trigger...). |
SentDate | datetime | Необязательный. Дата, когда сообщение было отправлено. Для сообщений, которые отправлялись несколько раз (например, Autoresponders), вернется первая дата отправки, которая попадает во временной промежуток. |
Tags | string | Необязательный. Список тегов через запятую. |
Получение информации о сообщении по его ID
Параметры ответа:
Элемент/атрибут | Тип | Описание |
---|---|---|
Id | int | Идентификатор сообщения. |
FromName | string | Имя из "From:" заголовка. |
FromEmail | string | Емейл из "From:" заголовка. |
Subject | string | Тема письма. |
Type | string | Тип письма (Newsletter, Autoresponder, Trigger...). |
SentDate | datetime | Необязательный. Дата, когда сообщение было отправлено. Для сообщения, которое отправлялось несколько раз (например Autoresponders), вернется первая дата отправки, которая попадает во временной промежуток. |
Tags | string | Необязательный. Список тегов через запятую. |
ThrottlingMethod | string | Необязательный. Тип распределения. |
Throttling | int | Необязательный. Период распределения (в часах). Показывается если установлен "В ручную" |
GoogleAnalyticsTags | array[complex] | Необязательный. Массив тегов GoogleAnalyticsTags (если UTM метки используются в письме). |
YandexListId | complex | Необязательный. Инфомация о Yandex List ID (если используется в письме). |
Channels | string | Необязательный. Список каналов через запятую (если было отправлено через каналы, отличные от используемых по умолчанию). |
Lists | array[complex] | Необязательный. Массив элементов List (листы подписчиков). |
Segments | array[complex] | Необязательный. Массив элементов Segment (сегменты подписчиков). |
Status | string | Необязательный. Статус рассылки (доступен для Стандартных писем). |
Элементы тега GoogleAnalyticsTag:
Элемент/атрибут | Тип | Описание |
---|---|---|
Name | string | Имя тега(метки), например "utm_source" |
Value | string | Значение тега |
Элементы тега YandexListId:
Элемент/атрибут | Тип | Описание |
---|---|---|
Identifier | string | Идентификатор Yandex List ID |
Comment | string | Комментарий |
Элементы тега List:
Элемент/атрибут | Тип | Описание |
---|---|---|
Id | int | Идентификатор листа. |
Name | string | Имя листа. |
Элементы тега Segment:
Элемент/атрибут | Тип | Описание |
---|---|---|
Id | int | Идентификатор сегмента. |
Name | string | Имя сегмента |
Список возможных значений 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>