/v2/Api/Triggers/{ID} POST
Позволяет отправить заранее созданное триггерное письмо листу подписчиков. Обязательно требуется передать ID сообщения.
Формат данных
Отправляет триггерные письма (письма по факту свершения какого-то действия). Отправка будет осуществляться методом POST.
Параметры запросы:
Параметр | Тип | Описание |
---|---|---|
ID | integer | ID триггерного сообщения. Обязательная часть адреса. |
Элементы тега Data:
Элемент/атрибут | Тип | Описание |
---|---|---|
xsi:type | - | Определяет тип действия. Для этого запроса значение должно быть «TriggerReceivers». |
Receivers | complex | Набор подписчиков, которые получат триггерное сообщение (тег Receivers). |
Элементы тега Receiver:
Элемент/атрибут | Тип | Описание |
---|---|---|
Id | integer | Идентификатор подписчика. Необязательный*. |
string | Емейл подписчика. Необязательный*. |
*Для идентификации подписчика должен быть указан либо ID, либо Email. Если указан Email, то подписчик с этим Email должен существовать в базе данных. Если оба поля указаны, то ID имеет приоритет.
Подписчики, которые не могут быть найдены, игнорируются и не получают триггерные сообщения. При этом от ES ошибка не возвращается.
Примеры
Запрос:
POST https://api.esv2.com/v2/Api/Triggers/123 HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: application/xml User-Agent: Jakarta Commons-HttpClient/3.1 Host: api.esv2.com Content-Length: 427 <ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <ApiKey>Ваш_API-ключ</ApiKey> <Data xsi:type="TriggerReceivers"> <Receivers> <Receiver> <Id>137384</Id> </Receiver> <Receiver> <Email>test@testtest.com</Email> </Receiver> </Receivers> </Data> </ApiRequest>
Ответ:
HTTP/1.1 201 Created Cache-Control: private Server: Microsoft-IIS/7.5 Set-Cookie: ASP.NET_SessionId=oxhfxmvpdfj1gz45mhxgx1jb; path=/; HttpOnly X-AspNetMvc-Version: 1.0 X-AspNet-Version: 2.0.50727 X-Powered-By: ASP.NET Date: Mon, 19 Jul 2010 17:08:43 GMT Content-Length: 0
Формат ответа с ошибкой:
HTTP/1.1 400 Bad Request Cache-Control: private Content-Type: text/xml; charset=utf-8 Server: Microsoft-IIS/7.5 Set-Cookie: ASP.NET_SessionId=2xdqfo55sk0k53450qbwzj45; path=/; HttpOnly X-AspNetMvc-Version: 1.0 X-AspNet-Version: 2.0.50727 X-Powered-By: ASP.NET Date: Wed, 21 Jul 2010 13:10:09 GMT Content-Length: 247 <ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ErrorMessage> <Code>400</Code> <Message>Trigger is inactive or was deleted.</Message> </ErrorMessage> </ApiResponse>