Метод getMessage

Метод для получения информации об SMS или email сообщении.

Принцип использования

Синтаксис и URL для вызова метода
getMessage (int id)
https://api.unisender.com/ru/api/getMessage?id=ID&api_key=KEY

 

Аргументы
id * id - 31-битное положительное целое, идентификатор сообщения. Такие идентификаторы возвращаются методами createEmailMessage и createSmsMessage. id можно передавать как одно число или как массив для получения нескольких писем (см. пример ниже).
api_key * Ключ доступа к API

 

Возвращаемое значение
JSON-массив, каждый элемент массива – объект письма со следующими полями:

  • id - 31-битное положительное целое, идентификатор сообщения.
  • sub_user_login - либо логин субпользователя, который создал письмо, либо NULL, если письмо создал мастер-пользователь.
  • sender_email (только если сообщение - email) - email отправителя.
  • sender_name (только если сообщение - email) - имя отправителя.
  • sender (только если сообщение - sms) - имя отправителя.
  • subject (только если сообщение - email) - тема письма.
  • body - тело письма.
  • text_body (только если сообщение - email) - текстовая версия тела письма.
  • list_id - ID списка рассылки.
  • created - дата и время создания письма в формате ГГГГ-ММ-ДД ЧЧ:ММ:CC.
  • last_update - дата и время последнего изменения в письме в формате ГГГГ-ММ-ДД ЧЧ:ММ:CC. Например: 2013-09-15 05:38:11.
  • service_type - тип письма (email или sms).
  • lang_code (только если сообщение - email) - двухбуквенный код языка для автоматического добавления к письму формы отписки (например, 'ru', 'en').
  • active_version_id - ID версии письма.
  • message_format - возвращает способ создания сообщения: block - блочный редактор, raw_html - html редактор, text - текстовая версия письма.
  • images_behavior - (только, если сообщение - email) - как передаются картинки в письме. Возможные варианты:
    1. only_links - картинки не передаются, вместо них добавляются ссылки.
    2. attachments - картинки передаются как вложения в письмо.
    3. smart_mode - в данный момент не используется.

Пример:

{"result":[
    {
        "id":"3771225",
        "sub_user_login":null,
        "list_id":"910533",
        "created": "2020-02-23 13:29:51",
        "last_update":"2020-09-02 07:35:17",
        "service_type":"email",
        "lang_code":"ru",
        "active_version_id":null,
        "message_format":"raw_html",
        "wrap_type":"left",
        "images_behavior":"only_links",
        "sender_email":"test@unisender.com",
        "sender_name":"UniSender",
        "subject":"Message Subject",
        "body":"<p>Message body</p>",
        "text_body":"Message body"
    }
    ]
}

Вы нашли ответ?

0
1