Каналы нотификаций

Список каналов нотификаций

GET https://app.hightouch.ai/api/notifications/channels/

Query Parameters

Name	Type	Description
shop_id	integer	ID магазина
is_active	boolean	Выводить только активные / неактивные
tags	array	Фильтр по тегам канала нотификаций
limit	integer	Кол-во записей (макс. 100)
offset	integer	Сдвиг по записям
search	string	Строка поиска по email / ID в телеграм / ID канала

200

{
  "status": "ok",
  "result": {
    "count": 6,
    "next": null,
    "previous": null,
    "results": [
      {
        "id": 120,
        "shop_id": 2,
        "is_active": true,
        "type": {
          "id": 2,
          "name": "Telegram"
        },
        "email": null,
        "tg_user_id": "1071807456",
        "tags": [],
        "tg_user_name": "Кариша"
      },
      ...
    ]
  }
}

Добавить канал нотификаций

POST https://app.hightouch.ai/api/notifications/channels/

Каналы нотификаций бывают двух типов: {"id": 1} - Отправлять на почту {"id": 2} - Отправлять в Telegram При выборе каждого типа нужно обязательно указать поле email или tg_user_id соответственно. Свой ID в Telegram можно узнать, написав этому боту.

Request Body

Name	Type	Description
shop_id	integer	ID магазина
is_active	boolean	Активный ли канал
tags	array	Список тегов, которыми нужно отметить канал
type	object	Тип. Напр: {"id": 2}
email	string	Email для нотификаций
tg_user_id	integer	ID пользователя в Telegram

200

{
  "status": "ok",
  "result": {
    "id": 67,
    "shop_id": 2,
    "is_active": false,
    "type": {
      "id": 2,
      "name": "Telegram"
    },
    "email": null,
    "tg_user_id": "105023594",
    "tags": [
      {
        "id": 224,
        "shop_id": 2,
        "name": "0.2 КВИЗ"
      },
      {
        "id": 226,
        "shop_id": 2,
        "name": "0.4 Чат-центр"
      }
    ],
    "tg_user_name": "Владимир "
  }
}

Изменить канал нотификаций

PATCH https://app.hightouch.ai/api/notifications/channels/:id/

Path Parameters

Name	Type	Description
id	integer	ID канала нотификаций

Request Body

Name	Type	Description
shop_id	integer	ID магазина
is_active	boolean	Активный?
tags	array	Список тегов
type	object	Тип канала
email	string	Email
tg_user_id	integer	ID пользователя в Telegram

200

{
  "status": "ok",
  "result": {
    "id": 67,
    "shop_id": 2,
    "is_active": false,
    "type": {
      "id": 2,
      "name": "Telegram"
    },
    "email": null,
    "tg_user_id": "105023594",
    "tags": [
      {
        "id": 224,
        "shop_id": 2,
        "name": "0.2 КВИЗ"
      },
      {
        "id": 226,
        "shop_id": 2,
        "name": "0.4 Чат-центр"
      }
    ],
    "tg_user_name": "Владимир "
  }
}

Удалить канал нотификаций

DELETE https://app.hightouch.ai/api/notifications/channels/:id/

Path Parameters

Name	Type	Description
id	integer	ID канала нотификаций

204