Получение списка категорий уведомлений

Метод используется для получения многостраничного списка опубликованных категорий уведомлений для аккаунта, к которому есть доступ у текущего пользователя. Метод также возвращает список типов уведомлений, которыми можно управлять в рамках хотя бы одной категории уведомлений.

GET {reseller_domain}/internal_api/accounts/{account_id}/notification_categories

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается список категорий уведомлений
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

Модель ответа

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID категории уведомлений
	type		string	Тип данных
	attributes		object	Информация о категории уведомлений
		created_at	string	Дата и время создания категории уведомлений
		name	string	Название категории уведомлений
		description	string	Описание категории уведомлений
		low_balance_type	bool	Признак наличия в категории события уведомлений Недостаточно средств на балансе в статусе Активный: true — для категории используется настройка порога срабатывания уведомлений `balance_limit`. false — настройка порога срабатывания уведомлений не используется.
		balance_limit	number	Порог срабатывания события уведомлений Недостаточно средств на балансе для аккаунта
		for_sms	bool	Признак получения sms-уведомлений для категории: true — sms-уведомления включены. false — sms-уведомления выключены.
		for_email	bool	Признак получения email-уведомлений для категории: true — email-уведомления включены. false — email-уведомления выключены.
		email_disabled	bool	Признак недоступности управления получением email-уведомлений для категории: true — управление получением email-уведомлений недоступно. false — управление получением email-уведомлений доступно.
		sms_disabled	bool	Признак недоступности управления получением sms-уведомлений для категории: true — управление получением sms-уведомлений недоступно. false — управление получением sms-уведомлений доступно.
		client_panel_disabled	bool	Признак недоступности управления получением push-уведомлений для категории: true — управление получением push-уведомлений недоступно. false — управление получением push-уведомлений доступно.
links			object	Ссылки для постраничной навигации
	self		string	Текущая страница
	first		string	Первая страница
	prev		string	Предыдущая страница (при наличии)
	next		string	Следующая страница (при наличии)
	last		string	Последняя страница
meta			object	Дополнительная информация
	current_page		integer	Номер текущей страницы
	page_count		integer	Общее число страниц
	type_categories		array	Cписок типов уведомлений, которыми можно управлять в рамках хотя бы одной категории уведомлений: sms email client_panel
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1938/notification_categories' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": [
        {
            "id": "4",
            "type": "notification_categories",
            "attributes": {
                "created_at": "2016-08-25 T09:26:13.431695+0300",
                "name": "Notifications about invoices",
                "description": "",
                "low_balance_type": false,
                "balance_limit": null,
                "for_sms": false,
                "for_email": true,
                "email_disabled": false,
                "sms_disabled": true,
                "client_panel_disabled": false
            }
        },
        {
            "id": "5",
            "type": "notification_categories",
            "attributes": {
                "created_at": "2016-08-25 T09:26:13.519243+0300",
                "name": "Account balance notifications",
                "description": "",
                "low_balance_type": true,
                "balance_limit": 10,
                "for_sms": true,
                "for_email": true,
                "email_disabled": false,
                "sms_disabled": false,
                "client_panel_disabled": false
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1938/notification_categories?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1938/notification_categories?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1938/notification_categories?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "type_categories": [
            "sms",
            "email",
            "client_panel"
        ],
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}