В кабинете Unisender реализована версионность писем. Ранее отправленное письмо можно отредактировать, или изменить список отправки, при этом будет создана новая версия письма. Версия — это message_id, который передается при создании рассылки (метод createCampaign). Актуальная версия может быть только одна. В интерфейсе кабинета можно указать, какую версию считать актуальной. При создании рассылок с помощью API версионности нет: при редактировании письма, которое ранее не отправлялось в рассылках (метод updateEmailMessage) message_id не меняется; при редактировании письма, которое ранее отправлялось, результатом вызова метода updateEmailMessage будет письмо с новым id.
Поскольку пользователи могут пользоваться и API-интеграцией, и кабинетом Unisender, возникают ситуации, когда пользователи в кабинете создают новые версии письма. Поскольку отправка на неактуальные версии письма невозможна, то при попытке использования message_id неактуальной версии письма пользователю будет возвращена ошибка: "error": "Unable to create campaign. The letter has a new version (12345678)".
Метод getActualMessageVersion возвращает id актуальной версии заданного письма.
Принцип использования
| Синтаксис и URL для вызова метода |
| getActualMessageVersion (int message_id) |
| https://api.unisender.com/ru/api/getActualMessageVersion?api_key=KEY&message_id=ID |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| message_id * | Идентификатор сообщения, для которого необходимо получить id актуальной версии письма. |
| Возвращаемое значение |
Пример возвращаемого значения при удачном выполнении запроса:
{
"result": {
"message_id": 61312345,
"actual_version_id": 62814234
}
}
Где: actual_version_id - id актуальной версии письма. Пример возвращаемого значения при ошибке: {"error":"error message", "code":"error code"}
|
