Просмотр списка рассылок

Просмотр списка рассылок

POST /broadcast/v1/fetch_broadcast

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

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

Тело запроса

filters

Поле	Тип	Описание	Обязательное	Пример
sendTimeTo	string	Время - до какого срока отправить(ISO8601)	❌	"2024-09-13T18:04:05+03:00"
sendTimeAt	string	Время - когда отправить (ISO8601)	❌	"2024-09-13T18:04:05+03:00"
createdAt	string	Время - когда создать	❌	"2024-09-13T18:04:05+03:00"
createdTo	string	Время - до какого создать	❌	"2024-09-13T18:04:05+03:00"
isSend	bool	Флаг, отправлено ли	❌	true
orderByCreatedAt	bool	Флаг, сортировать ли по дате создания	❌	true
needToSend	bool	Флаг необходимости отправки	❌	true
roles	[]int32	Список ролей (1 до 15)	❌	[1, 3, 7]
userUUID	string	Уникальный идентификатор пользователя	❌	"8a87d1a5-5bce-4361-a2e6-8b5517c81212"
tgMembers	bool	Включать ли участников из Telegram	❌	false
cities	[]int32	Список ID городов ( > 0)	❌	[10, 20]
mentorLevels	[]string	Уровни менторов (от 1 до 4 включительно)	❌	["8a87d1a5-5bce-4361-a2e6-8b5517c81210", "8a87d1a5-5bce-4361-a2e6-8b5517c81213"]

pagination

Поле	Тип	Описание	Обязательное	Пример
limit	int32	Количество элементов на странице	❌	1
page	int32	Текущая страница	❌	1

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

    {
        "filters": {
            "cities": [
                0
            ],
            "createdAt": "2024-09-13T18:04:05+03:00",
            "createdTo": "2024-09-13T18:04:05+03:00",
            "isSend": true,
            "mentorLevels": [
                "string"
            ],
            "needToSend": true,
            "orderByCreatedAt": true,
            "roles": [
                0
            ],
            "sendTimeAt": "2024-09-13T18:04:05+03:00",
            "sendTimeTo": "2024-09-13T18:04:05+03:00",
            "tgMembers": true,
            "userUUID": "string"
        },
        "pagination": {
            "limit": -1,
            "page": 0
        }
    }

Тело ответа

data

Поле	Тип	Описание	Обязательное	Пример
cities	[]int32	Список ID городов ( > 0)	✅	[10, 20]
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://..."}

pagination

Поле	Тип	Описание	Обязательное
currentPage	int	Текущая страница	✅
itemsPerPage	int	Количество элементов на странице	✅
totalItems	int	Общее количество элементов	✅
totalPages	int	Общее количество страниц	✅

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

{
        "data": [
            {
              "cities": [
                0
              ],
              "contactType": 0,
              "createdAt": "2024-09-13T18:04:05+03:00",
              "deletedAt": "2024-09-13T18:04:05+03:00",
              "id": 0,
              "imageURL": "string",
              "inlineButton": {
                "text": "string",
                "url": "string"
              },
              "isSend": true,
              "mentorLevels": [
                "string"
              ],
              "message": "string",
              "needToSend": true,
              "roles": [
                0
              ],
              "sendTime": "02.01.2006 15:04:05",
              "target": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "tgMembers": true,
              "title": "string",
              "updatedAt": "2024-09-13T18:04:05+03:00",
              "userUUID": "string",
              "usersUUID": [
                "string"
              ]
            }
        ],
        "pagination": {
            "currentPage": 0,
            "itemsPerPage": 0,
            "totalItems": 0,
            "totalPages": 0
        }
}