Получить информацию о рассылке

Описание

Получить информацию о рассылке.

URL-адрес

Метод: POST

https://example.com/api/v1.1/campaigns/get

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
id	int	1	Да	Идентификатор рассылки

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 1    
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>1</id>    
</xml>

Пример ответа

JSON

{
    "data": {
        "id": 118,
        "name": "Daily weather notification",
        "description": "",
        "type": "regular",
        "update_time": "2024-05-20T09:17:53.362Z",
        "is_active": false,
        "is_completed": false,
        "data_id": 1,
        "data_type": "list",
        "content": [
            {
                "subject": "",
                "from_email": "",
                "from_name": "",
                "replyto_email": "",
                "replyto_name": "",
                "message_id": 21
            }
        ],
        "status": "Inactive",
        "subid": "",
        "virtual_sender_id": 2,
        "providers": [
            "google",
            "mozilla",
            "safari",
            "safari-native",
            "firefox-firebase",
            "chrome-firebase",
            "opera-firebase",
            "yandex-firebase",
            "samsung-firebase",
            "android-firebase",
            "ios-firebase",
            "ios-apns",
            "yandex-Appmetrica-device-id-ios",
            "yandex-Appmetrica-device-id-android",
            "yandex-Appmetrica-ios-ifa",
            "yandex-Appmetrica-google-aid",
            "yandex-Appmetrica-android-token",
            "yandex-Appmetrica-ios-token",
            "android-huawei",
            "ios-huawei",
            "android-rustore"
        ],
        "push_sending_mode": "fanout",
        "resource_id": 26,
        "channel": "push",
        "attributes": {
            "season": "spring_2024",
            "branch": "marketing"
        },
        "for_confirm": false
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <id>118</id>
        <name>Daily weather notification</name>
        <description></description>
        <type>regular</type>
        <update_time>2024-05-20T09:17:53.362Z</update_time>
        <is_active>false</is_active>
        <is_completed>false</is_completed>
        <data_id>1</data_id>
        <data_type>list</data_type>
        <content>
            <subject></subject>
            <from_email></from_email>
            <from_name></from_name>
            <replyto_email></replyto_email>
            <replyto_name></replyto_name>
            <message_id>21</message_id>
        </content>
        <status>Inactive</status>
        <subid></subid>
        <virtual_sender_id>2</virtual_sender_id>
        <providers>google</providers>
        <providers>mozilla</providers>
        <providers>safari</providers>
        <providers>safari-native</providers>
        <providers>firefox-firebase</providers>
        <providers>chrome-firebase</providers>
        <providers>opera-firebase</providers>
        <providers>yandex-firebase</providers>
        <providers>samsung-firebase</providers>
        <providers>android-firebase</providers>
        <providers>ios-firebase</providers>
        <providers>ios-apns</providers>
        <providers>yandex-Appmetrica-device-id-ios</providers>
        <providers>yandex-Appmetrica-device-id-android</providers>
        <providers>yandex-Appmetrica-ios-ifa</providers>
        <providers>yandex-Appmetrica-google-aid</providers>
        <providers>yandex-Appmetrica-android-token</providers>
        <providers>yandex-Appmetrica-ios-token</providers>
        <providers>android-huawei</providers>
        <providers>ios-huawei</providers>
        <providers>android-rustore</providers>
        <push_sending_mode>fanout</push_sending_mode>
        <resource_id>26</resource_id>
        <channel>push</channel>
        <for_confirm>false</for_confirm>
        <attributes>
            <season>spring_2024</season>
            <branch>marketing</branch>
        </attributes>
    </data>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
content	JSON array	Шаблоны, прикрепленные к рассылке
data_id	int	Идентификатор источника подписчиков
data_type	string	Тип источника подписчиков
id	int	Идентификатор рассылки
update_time	string	Дата последнего редактирования рассылки
updated_user	string	Имя пользователя, отредактировавшего рассылку
is_active	bool	Статус рассылки
is_completed	bool	Завершена ли рассылка
name	string	Название рассылки
resource_id	int	Идентификатор ресурса
send_email_content	bool	Включены ли email-сообщения
send_push_content	bool	Включены ли PUSH-сообщения
send_sms_content	bool	Включены ли SMS-сообщения
push_sending_mode	string	Режим отправки push-сообщений (только для push-каналов)
for_confirm	bool	Имеет ли рассылка сообщения со ссылкой подтверждения
status	string	Состояние рассылки
subid	string	SubID рассылки
type	string	Тип рассылки
virtual_sender_id	int	Идентификатор виртуального сендера
descr	string	Описание рассылки
attributes	object	Атрибуты, назначенные рассылке, и их значения
scampaign_id	int	Идентификатор кампании, в которой задействована рассылка (Параметр возвращается, если рассылка задействована в кампании)