[DEV] New Project API (2.10.5)

Download OpenAPI specification:Download

API проекта New Project API

Авторизация, аутентификация

Осуществляет авторизацию пользователя, используя локальный провайдер, возвращает JWT-токен

Request Body schema: application/json

provider required	string Default: "local" Value: "local" Провайдер авторизации
id	string Идентификатор в авторизации провайдера
email	string <email> E-MAil
password	string пароль

Responses

Request samples

Payload

Content type

application/json

{"provider": "local",
"id": "string",
"email": "user@example.com",
"password": "string"
}

Response samples

200
400

Content type

application/json

{"success": true,
"data": {"token": "string"
}
}

Проверяет текущий JWT-токен, передаваемый в заголовках, выдает информацию о его валидности

Authorizations:

bearerAuth

Request Body schema: application/json

token

string

Token

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"token": "string"
}
}

Обновляет JWT-токен в соответствии с зашифрованными в нем данными пользователя, возвращает обновленный токен

Authorizations:

bearerAuth

Responses

Регистрирует нового пользователя, возвращает его данные

Authorizations:

bearerAuth

Request Body schema: application/json

provider required	string Default: "local" Value: "local" Провайдер авторизации
name	string
id	string Идентификатор в авторизации провайдера
username	string Имя пользователя
email	string <email> E-MAil
password	string пароль
options	object Опции пользователя

Responses

Request samples

Payload

Content type

application/json

{"provider": "local",
"name": "string",
"id": "string",
"username": "string",
"email": "user@example.com",
"password": "string",
"options": { }
}

Клиенты API

Возвращает объект клиента по его идентификатору

Authorizations:

bearerAuth

path Parameters

client_id

required

string

Идентификатор клиента

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Обновляет данные клиента по заданному идентфиикатору

Authorizations:

bearerAuth

path Parameters

client_id

required

string

Идентификатор клиента

Request Body schema: application/json

Данные для создания объекта клиента

id	string Идентификатор клиента
host	string Базовый домен клиента
owner	string Ответственный пользователь
code	string Уникальный код клиента
type	string Тип клиента (канал доставки, интеграция)
category	string Категория клиента
name	string Название клиента
enabled	boolean Признак активности
options	object Дополнительные настройки
createdAt	string <date-time> Дата создания
updatedAt	string <date-time> Дата обновления

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Удаляет клиента с заданным идентификатором

Authorizations:

bearerAuth

path Parameters

client_id

required

string

Идентификатор клиента

Responses

Response samples

204
400
404

Content type

application/json

{"success": true,
"data": {"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Возвращает объект клиента по типу клиента и идентфиикатору группы, указанной в опциях

Authorizations:

bearerAuth

path Parameters

client_type required	string Тип клиента
group_id required	string Идентификатор группы

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Возвращает список всех клиентов

Authorizations:

bearerAuth

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Создает клиента с заданными параметрами

Authorizations:

bearerAuth

Request Body schema: application/json

Данные для создания объекта клиента

id	string Идентификатор клиента
host	string Базовый домен клиента
owner	string Ответственный пользователь
code	string Уникальный код клиента
type	string Тип клиента (канал доставки, интеграция)
category	string Категория клиента
name	string Название клиента
enabled	boolean Признак активности
options	object Дополнительные настройки
createdAt	string <date-time> Дата создания
updatedAt	string <date-time> Дата обновления

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"id": "string",
"host": "string",
"owner": "string",
"code": "string",
"type": "string",
"category": "string",
"name": "string",
"enabled": true,
"options": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Пользователи

Возвращает список всех пользователей

Authorizations:

bearerAuth

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"name": "string",
"auth": { },
"options": { }
}
]
}

Возвращает объект пользователя по его идентификатору

Authorizations:

bearerAuth

path Parameters

user_id

required

string

Идентификатор пользователя

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"name": "string",
"auth": { },
"options": { }
}
}

Обновляет данные пользователя по заданному идентификатору

Authorizations:

bearerAuth

path Parameters

user_id

required

string

Идентификатор пользователя

Request Body schema: application/json

Данные для создания объекта пользователя

name	string Имя пользователя
auth	object Объект провайдеров авторизации
options	object Опции пользователя

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"auth": { },
"options": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"name": "string",
"auth": { },
"options": { }
}
}

Удаляет пользователя с заданным идентификатором

Authorizations:

bearerAuth

path Parameters

user_id

required

string

Идентификатор пользователя

Responses

Response samples

204
400
404

Content type

application/json

{"success": true,
"data": {"name": "string",
"auth": { },
"options": { }
}
}

Возвращает объект пользователя по его e-mail

Authorizations:

bearerAuth

path Parameters

user_email

required

string

E-mail пользователя

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"name": "string",
"auth": { },
"options": { }
}
}

Возвращает объект пользователя по его ID и провайдеру аутентификации

Authorizations:

bearerAuth

path Parameters

provider_id required	string Идентификатор провайдера аутентификации
provider_user_id required	string ID пользователя у провайдера аутентификации

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"name": "string",
"auth": { },
"options": { }
}
}

Возвращает объект(-ы) пользователей по строковому поисковому запросу.

Authorizations:

bearerAuth

path Parameters

text

required

string

Текст для поиска в данных имени и e-mail

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"name": "string",
"auth": { },
"options": { }
}
]
}

Посты

Возвращает объект поста по его идентификатору

Authorizations:

bearerAuth

path Parameters

post_id

required

string

Идентификатор поста

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"enabled": true,
"source": { },
"options": { }
}
}

Обновляет данные поста по заданному идентификатору

Authorizations:

bearerAuth

path Parameters

post_id

required

string

Идентификатор поста

Request Body schema: application/json

Данные для создания объекта поста

owner	string Автор
enabled	boolean Активен
source	object Объект исходных параметров
options	object Опции

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"enabled": true,
"source": { },
"options": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"enabled": true,
"source": { },
"options": { }
}
}

Удаляет пост с заданным идентификатором

Authorizations:

bearerAuth

path Parameters

post_id

required

string

Идентификатор поста

Responses

Response samples

204
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"enabled": true,
"source": { },
"options": { }
}
}

Возвращает список всех постов

Authorizations:

bearerAuth

query Parameters

status	string Статус публикации
category	string ID категории публикации
count_on_page	number Default: 10 Количество сообщений на странице (НЕ БОЛЕЕ 100)
page	number Default: 1 Номер страницы

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"owner": "string",
"enabled": true,
"source": { },
"options": { }
}
]
}

Создает пост с заданными параметрами.

Authorizations:

bearerAuth

Request Body schema: application/json

Данные для создания объекта поста

owner	string Автор
enabled	boolean Активен
source	object Объект исходных параметров
options	object Опции

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"enabled": true,
"source": { },
"options": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"enabled": true,
"source": { },
"options": { }
}
}

Возвращает превью по заданному telegram_file_id

path Parameters

file_id

required

string

Telegram file_id

Responses

Response samples

400
404

Content type

application/json

{"success": true,
"error": {"status": 0,
"message": "string"
}
}

Возвращает объединённое превью по списку telegram_file_id

query Parameters

size	number Default: 100 Требуемые размер превью
files[] required	Array of strings Массив Telegram file_id (thumb или photo[0])

Responses

Response samples

400

Content type

application/json

{"success": true,
"error": {"status": 0,
"message": "string"
}
}

Возвращает видео по telegram file_id

path Parameters

file_id

required

string

Telegram file_id видеоролика

Responses

Response samples

404

Content type

application/json

{"success": true,
"error": {"status": 0,
"message": "string"
}
}

Быстрая проверка доступности видео по telegram file_id (без стриминга)

path Parameters

file_id

required

string

Telegram file_id видеоролика

Responses

Response samples

404

Content type

application/json

{"success": true,
"error": {"status": 0,
"message": "string"
}
}

Проверяет доступность видео по telegram file_id и причину недоступности

path Parameters

file_id

required

string

Telegram file_id видеоролика

Responses

Response samples

200
400

Content type

application/json

{"success": true,
"exists": false,
"reason": "too_big",
"description": "Bad Request - file is too big"
}

Категории

Возвращает объект категории по его идентификатору

Authorizations:

bearerAuth

path Parameters

category_id

required

string

Идентификатор категории

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"name": "string",
"options": { }
}
}

Обновляет данные категории по заданному идентификатору

Authorizations:

bearerAuth

path Parameters

category_id

required

string

Идентификатор категории

Request Body schema: application/json

Данные для создания объекта категории

owner	string Автор
name	string Объект исходных параметров
options	object Опции

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"name": "string",
"options": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"name": "string",
"options": { }
}
}

Удаляет категорию с заданным идентификатором

Authorizations:

bearerAuth

path Parameters

category_id

required

string

Идентификатор категории

Responses

Response samples

204
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"name": "string",
"options": { }
}
}

Создает категорию с заданными параметрами.

Authorizations:

bearerAuth

Request Body schema: application/json

Данные для создания объекта категории

owner	string Автор
name	string Объект исходных параметров
options	object Опции

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"name": "string",
"options": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"owner": "string",
"name": "string",
"options": { }
}
}

Подписки клиентов

Возвращает объект подписки пользователя по его идентификатору

Authorizations:

bearerAuth

path Parameters

subscribe_id

required

string

Идентификатор подписки пользователя

query Parameters

user	string Id пользователя
bot	string Id бота
provider	string Enum: "vk" "telegram" "isaak" Провайдер получения оповещения, 'vk', 'telegram'
interval	any Интервал работы мессенджера

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
}

Обновляет данные подписки пользователя по заданному идентфиикатору

Authorizations:

bearerAuth

path Parameters

subscribe_id

required

string

Идентификатор подписки пользователя

Request Body schema: application/json

Данные для создания объекта пользователя

	object (SubscribeRecipient)
type	string Тип подписки
	object (SubscribePeriodicity)
enabled	boolean Флаг активности подписки
options	object Опции подписки
last_fire	object Объект последних сработавших рассылок

Responses

Request samples

Payload

Content type

application/json

{"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
}

Удаляет подписку пользователя с заданным идентификатором

Authorizations:

bearerAuth

path Parameters

subscribe_id

required

string

Идентификатор подписки пользователя

Responses

Response samples

204
400
404

Content type

application/json

{"success": true,
"data": {"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
}

Возвращает список всех подписок пользователей

Authorizations:

bearerAuth

query Parameters

count_on_page	number Default: 10 Количество сообщений на странице (НЕ БОЛЕЕ 100)
page	number Default: 1 Номер страницы

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
]
}

Возвращает объект актуальных по времени подписок

Authorizations:

bearerAuth

query Parameters

bot	string ID бота
interval	any Интервал работы мессенджера
send_now	boolean Флаг поиска подписок, имеющих контент для немедленной рассылки

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"options": { }
}
}

Создает подписку пользователя с заданными параметрами

Authorizations:

bearerAuth

Request Body schema: application/json

Данные для создания объекта пользователя

	object (SubscribeRecipient)
type	string Тип подписки
	object (SubscribePeriodicity)
enabled	boolean Флаг активности подписки
options	object Опции подписки
last_fire	object Объект последних сработавших рассылок

Responses

Request samples

Payload

Content type

application/json

{"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": {"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
}

Возвращает объект(-ы) подписок пользователя по поисковому запросу.

Authorizations:

bearerAuth

query Parameters

peer_type	string Идентификатор типа получателя подписки ("vk_chat", "vk_user", "tg_user", ...)
peer_id	string Идентификатор получателя, к которому относится подписка (vk_user_id, vk_chat_id, telegram_user_id, ...)

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"data": [{"peer": {"id": 0,
"type": "string"
},
"type": "string",
"periodicity": {"trigger": false,
"datetime_start": "string",
"datetime_end": "string",
"measure": "minute",
"amount": 1,
"time": "14:15:22Z",
"weekdays": [ ]
},
"enabled": true,
"options": { },
"last_fire": { }
}
]
}

Контент-сеты

Возвращает список предустановленных контент-сетов

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"name": "string",
"description": "string",
"lanes": [{"title": "string",
"categoriesInclude": ["string"
],
"categoriesExclude": ["string"
],
"schedule": {"cron": "string",
"window": {"daysOfWeek": [0
],
"start": "string",
"end": "string",
"everyMinutes": 0
}
},
"countPerTick": 0
}
]
}
]
}

Применяет выбранный сет к указанному чату (создаёт подписки)

Authorizations:

bearerAuth

path Parameters

setName

required

string

Имя сета (как возвращает /content-sets)

Request Body schema: application/json

chatId

required

string

Идентификатор чата/группы, к которой применяем сет

Responses

Request samples

Payload

Content type

application/json

{"chatId": "string"
}

Response samples

201

Content type

application/json

{"success": true,
"created": 0,
"subscribeIds": ["string"
]
}