Создать рассылку

Создание рассылки#

Ручка#

POST /broadcast/v1/create_broadcast

Полный адрес в сети#

Среда	URL
🧪 Dev	`http://gateway.devterra.ru/admin/broadcast/v1/create_broadcast`
🚀 Prod	`http://mobile-api.terraprod.ru/admin/broadcast/v1/create_broadcast`

Тело запроса#

Поле	Тип	Описание	Обязательное	Пример
title	string	Заголовок рассылки	✅	`"Рассылка новостей"`
message	string	Текст рассылки	✅	`"Уважаемые пользователи, у нас новости!"`
contactType	int32	Тип контакта (целое число > 0)	✅	`1`
sendTime	string	Время отправки (ISO8601)	✅	`"2024-09-13T18:04:05+03:00"`
needToSend	bool	Нужно ли отправлять рассылку	✅	`true`
roles	[]int32	Список ролей (от 1 до 15)	❌	`[1, 3, 5]`
usersUUID	[]string	Список UUID пользователей для рассылки	❌	`["8a87d1a5-5bce-4361-a2e6-8b5517c81212", "8a87d1a5-5bce-4361-a2e6-8b5517c81211"]`
imageURL	string	URL картинки-видео (mp4)	❌	`"https://example.com/image.png"`
tgMembers	bool	Включать ли участников из Telegram	❌	`false`
target	object (map)	Дополнительные параметры фильтрации	❌	`{"city": "1", "utm_source": "ads"}`
cities	[]int32	Список ID городов ( > 0)	❌	`[10, 20]`
mentorLevels	[]string	Список уровней менторов (от 1 до 4 включительно)	❌	`["8a87d1a5-5bce-4361-a2e6-8b5517c81210", "8a87d1a5-5bce-4361-a2e6-8b5517c81213"]`
inlineButton	object	Кнопка под сообщением	❌	{"text": "Перейти", "url": "https://..."}

cities=[-1] отправит рассылку всем пользователям у которых отсутствует город

target={"city": "-1"} отправит рассылку всем подписчикам у которых отсутствует город

поле target используется только для телеграмм подписчиков или планирование пуш уведомлений

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

    {
        "cities": [
            0
        ],
        "contactType": 0,
        "imageURL": "string",
        "inlineButton": {
            "URL": "string",
            "text": "string"
        },
        "mentorLevels": [
            "string"
        ],
        "message": "string",
        "needToSend": true,
        "roles": [
            0
        ],
        "sendTime": "2024-09-13T18:04:05+03:00",
        "target": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "tgMembers": true,
        "title": "string",
        "usersUUID": [
            "string"
        ]
    }

Тело ответа#

Поле	Тип	Описание	Обязательное	Пример
title	string	Заголовок рассылки	✅	`"Рассылка новостей"`
message	string	Текст рассылки	✅	`"Уважаемые пользователи, у нас новости!"`
contactType	int32	Тип контакта (целое число > 0)	✅	`1`
createdAt	string	Дата создания	✅	`"2024-09-13T18:04:05+03:00"`
deletedAt	string	Дата удаления	❌	`"2024-09-13T18:04:05+03:00"`
updatedAt	string	Дата обновления	✅	`"2024-09-13T18:04:05+03:00"`
id	int32	Уникальный идентификатор	✅	`1`
sendTime	string	Время отправки (ISO8601)	✅	`"2024-09-13T18:04:05+03:00"`
needToSend	bool	Нужно ли отправлять рассылку	✅	`true`
roles	[]int32	Список ролей (от 1 до 15)	❌	`[1, 3, 5]`
usersUUID	[]string	Список UUID пользователей для рассылки	❌	`["8a87d1a5-5bce-4361-a2e6-8b5517c81212", "8a87d1a5-5bce-4361-a2e6-8b5517c81211"]`
userUUID	string	Уникальный идентификатор пользователя	✅	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
imageURL	string	URL картинки-видео (mp4)	❌	`"https://example.com/image.png"`
isSend	bool	Флаг, отправлено ли	✅	`true`
tgMembers	bool	Включать ли участников из Telegram	✅	`false`
target	object (map)	Дополнительные параметры фильтрации	❌	`{"city": "1", "utm_source": "ads"}`
mentorLevels	[]string	Список уровней менторов (от 1 до 4 включительно)	❌	`["8a87d1a5-5bce-4361-a2e6-8b5517c81210", "8a87d1a5-5bce-4361-a2e6-8b5517c81213"]`
inlineButton	object	Кнопка под сообщением	❌	{"text": "Перейти", "url": "https://..."}

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

    {
        "cities": [
            0
        ],
        "contactType": 0,
        "createdAt": "string",
        "deletedAt": "string",
        "id": 0,
        "imageURL": "string",
        "inlineButton": {
            "URL": "string",
            "text": "string"
        },
        "isSend": true,
        "mentorLevels": [
            "string"
        ],
        "message": "string",
        "needToSend": true,
        "roles": [
            0
        ],
        "sendTime": "string",
        "target": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "tgMembers": true,
        "title": "string",
        "updatedAt": "string",
        "userUUID": "string",
        "usersUUID": [
            "string"
        ]
    }