Внимание

Методы доступны только с авторизацией типа OAuth 2

Шаблоны ответов

Получить список групп фраз

GET /v1.3/templates

После успешного выполнения возвращается массив объектов групп фраз.

id integer Идентификатор группы
key string Название группы
templates массив Список фраз, относящихся к данной группе
  • id
integer Идентификатор фразы
  • template
string Фраза
  • hotkey
integer Горячая клавиша (UTF-16 код)
  • userId
integer Идентификатор менеджера
  • attachments
json Список вложений

Пример:

GET https://api.umnico.com/v1.3/templates

Response:

[
    {
        "id": 9,
        "key": "Приветствие",
        "templates": [
            {
                "id": 46,
                "template": "Добрый день! Чем могу помочь?",
                "hotkey": 53,
                "userId": 1,
                "attachments": [
                  {
                    type: "photo",
                    mime: "image/png",
                    name: "logo_min.png",
                    url:  "https://google.com",
                    size: 1042
                  },
                  {
                    type: "doc",
                    mime: "html/txt",
                    name: "account.txt",
                    url:  "https://google.com",
                    size: 10420
                  }
                ]
            }
        ]
    },
    {
        "id": 8,
        "key": "Уточнение",
        "templates": []
    },
    {
        "id": 10,
        "key": "Прощание",
        "templates": [
            {
                "id": 2,
                "template": "Спасибо, что обратились к нам. Приятного дня!",
                "hotkey": null,
                "userId": null,
                "attachments": null
            }
        ]
    }
]

Добавить группу фраз в разработке

POST /v1.3/templates

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

  • key - название группы

Изменить название группы фраз в разработке

PUT /v1.3/templates

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

  • key - старое название группы
  • newKey - новое название группы

Удалить группу фраз в разработке

DELETE /v1.3/templates/group?id=<id>

  • id - идентификатор группы

Добавить фразу (ответ) в группу в разработке

POST /v1.3/templates/<id>

  • id - идентификатор группы

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

  • template - фраза
  • hotkey - горячая клавиша (UTF-16 код)
  • userId - идентификатор менеджера в случае персональной фразы (null означает - редактировать фразу доступную всем менеджерам)

Изменить фразу (ответ) в группе в разработке

PUT /v1.3/templates/<group-id>/<template-id>

  • group-id - идентификатор группы
  • template-id - идентификатор фразы

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

  • template - фраза
  • hotkey - горячая клавиша (UTF-16 код)
  • userId - идентификатор менеджера в случае персональной фразы (null означает - редактировать фразу доступную всем менеджерам)

Удалить фразу из группы в разработке

DELETE /v1.3/templates/<group-id>/<template-id>

  • group-id - идентификатор группы
  • template-id - идентификатор фразы

Загрузить вложение для фразы в разработке

POST /v1.3/templates/<group-id>/<template-id>/attachments

  • group-id - идентификатор группы
  • template-id - идентификатор фразы

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

  • file - вложения