База знаний
Настройки

Функции, связанные с настройками, статьями и многим другим.


Запрос


get-setting

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


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-setting.
name
Обязательно*
Идентификатор настройки. Вы можете получить идентификаторы всех настроек из файла resources\json\settings.json.

Ответ

{
"success": true,
"response": {
"option": "value",
"option": "value",
...
}
}

Запрос


get-multi-setting

Возвращает список поднастроек.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-multi-setting.
id
Обязательно*
ID основной настройки.
sub_id
Обязательно*
ID поднастройки.
default
Значение, которое будет возвращено, если настройка не найдена. По умолчанию: false.

Ответ

Возвращает значение поднастройки, если оно доступно, в противном случае возвращает значение по умолчанию.

Запрос


get-external-setting

Возвращает внешние настройки. Внешние настройки сохраняются в отдельной строке базы данных.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-external-setting.
name
Обязательно*
Имя настройки.
default
Значение, которое будет возвращено, если настройка не найдена. По умолчанию: false.

Ответ

Возвращает значение настройки, если оно доступно, в противном случае возвращает значение по умолчанию.

Запрос


get-settings

Возвращает массив со всеми настройками.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-settings.

Ответ

{
"success": true,
"response": {
"chat_manual_init": [
false,
"checkbox"
],
"chat_login_init": [
false,
"checkbox"
],
"init_dashboard": [
true,
"checkbox"
],
"chat_timetable_disable": [
false,
"checkbox"
],
"rtl": [
false,
"checkbox"
],
"front_auto_translations": [
true,
"checkbox"
],
...
}
}

Запрос


save-settings

Возвращает массив со всеми настройками.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите save-settings.
settings
Обязательно*
Массив настроек. Получите его с помощью get-settings.
external_settings
Настройки, сохраненные в отдельной строке таблицы sb_settings базы данных.
external_settings_translation
Переводы внешних настроек.

Ответ

{
"success": true,
"response": true
}

Запрос


save-external-setting

Сохраняет внешнюю настройку. Внешние настройки сохраняются в отдельной строке базы данных.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите save-external-setting.
name
Обязательно*
Имя настройки.
value
Обязательно*
Значение настройки.

Ответ

{
"success": true,
"response": true
}

Запрос


export-settings

Экспортирует все настройки в JSON-файл и возвращает его URL.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите export-settings.

Ответ

{
"success": true,
"response": "http://example.com/stepchat/uploads/settings_855776223.json"
}

Возвращает URL JSON-файла, содержащего настройки.

Запрос


import-settings

Импортирует настройки из JSON-файла, который сгенерирован с помощью функции export-settings.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите import-settings.
file_url
Обязательно*
URL JSON-файла с настрйоками.

Ответ

{
"success": true,
"response": true
}

Запрос


get-departments

Возвращает список отделов.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-departments.

Ответ

{
"1": {
"name": "Иван",
"color": "yellow",
"image": "https://example.com/image.png"
},
"2": {
"name": "Петр",
"color": "red",
"image": "https://example.com/image.png"
},
...
}

Запрос


saved-replies

Возвращает массив со всеми сохраненными ответами.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите saved-replies.

Ответ

{
"success": true,
"response": [
{
"reply-name": "привет",
"reply-text": "Привет! Чем могу помочь?
},
{
"reply-name": "email",
"reply-text": "Наш email: support@example.com."
},
...
]
}

Запрос


get-translation

Возвращает переводы на указанном языке.


Параметры

token
Обязательно*
Токен администратора.
function
Обязательно*
Укажите get-translation.
language_code
Обязательно*
Двухбуквенный код языка.

Ответ

{
"name": "Arabic",
"front": {
"Activities": "أنشطة",
"All": "الكل",
"All articles": "جميع المقالات",
"All fields are required.": "جميع الحقول مطلوبة",
...
},
"admin": {
"A conversation was started by": "",
"Activate": "",
"Activation complete! Page reload in progress...": "",
"Add a saved reply": "",
...
}
}