Запрос

Отправляет электронное письмо существующему пользователю с использованием шаблонов электронной почты из раздела Настройки - Уведомления.

Параметры

token

function

recipient_id

message

attachments

sender_id

Ответ

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

Другие возможные ответы: missing-user-id-or-message, security-error, user-email-not-found, user-or-sender-not-found.

Запрос

Отправляет электронное письмо на указанный адрес электронной почты.

Параметры

token

function

to

subject

message

sender_suffix

Ответ

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

Запрос

Запускает синхронизацию со stepChat и преобразует электронные письма в сообщения чата.

Параметры

token

function

force

Ответ

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

Запрос

Отправляет текстовое сообщение пользователю или агенту. Если аргумент template установлен в true, сообщение будет автоматически переведено.

Параметры

token

function

message

to

template

conversation_id

attachments

Ответ

{
"sid": "SM1f0e8ae6ade43cb3c0ce4525424e404f",
"date_created": "Fri, 13 Aug 2010 01:16:24 +0000",
"date_updated": "Fri, 13 Aug 2010 01:16:24 +0000",
"date_sent": null,
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"to": "+15305431221",
"from": "+15104564545",
"body": "Сообщение",
"status": "queued",
"flags":["outbound"],
"api_version": "2010-04-01",
"price": null,
"uri": "/2010-04-01/Accounts/ACXXXX/Messages/SM1f004f.json"
}

Запрос

Отправляет Push-уведомление агенту, группе агентов или всем агентам.

Параметры

title

message

icon

interest

conversation_id

Ответ

{
"publishId": "pubid-781799f5-6el4-4789-bc60-ee293543781"
}

Возвращает false, если Push-уведомления не активированы.

Запрос

Возвращает установленные версии stepChat и приложений.

Параметры

token

function

Ответ

{
"success": true,
"response": {
"sb": "3.0.4",
"dialogflow": "1.0.2",
"slack": "1.0.3"
}
}

Запрос

Запускает обновление stepChat и всех приложений. Этот метод принудительно запускает обновление и всегда перезаписывает все файлы плагинов и приложений.

Параметры

token

function

Ответ

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

Запрос

Запускает синхронизацию пользователей WordPress и импортирует новых пользователей WordPress в stepChat. Этот метод доступен только в версии WordPress.

Параметры

token

function

Ответ

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

Запрос

Возвращает лицензионный ключ для приложения stepChat, такого как Slack App или Dialogflow App.

Параметры

token

function

app_name

Ответ

{
"success": true,
"response": "9300AB16-014ZEE12-91E199EA-997CEX40"
}

Запрос

Активирует приложение, загружает его и устанавливает.

Параметры

token

function

app_name

key

Ответ

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

Запрос

Запускает cron задачи.

Параметры

token

function

Ответ

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

Запрос

Запускает событие на канале Pusher.

Параметры

token

function

channel

event

data

Ответ

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

Запрос

Возвращает CSS-стиль для цветов чата.

Параметры

token

function

Ответ

CSS-код.

Запрос

Преобразует форматирование текста в чате в соответствующие HTML-коды и возвращает сообщение.

Параметры

token

function

Ответ

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt.

Запрос

Удаляет форматирование текста из сообщений чата.

Параметры

token

function

Ответ

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt.

Запрос

Возвращает внутренние заметки диалога.

Параметры

token

function

conversation_id

Ответ

[
{
"id": 98207,
"user_id": "1538",
"name": "Lorem ipsum dolor sit amet",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt."
},
{
"id": 76986,
"user_id": "1596",
"name": "Lorem ipsum dolor",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor."
},
...
]

Запрос

Добавляет новую внутреннюю заметку.

Параметры

token

function

conversation_id

user_id

name

message

Ответ

Возвращает ID заметки.

Запрос

Удаляет внутреннюю заметку.

Параметры

token

function

conversation_id

note_id

Ответ

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

Запрос

Возвращает все автоматизации.

Параметры

token

function

Ответ

[
{
"emails": [
{
"id": "0BOaG",
"conditions": [
[
"datetime",
"is-between",
"10/04/2021 - 13/04/2021"
],
[
"include_urls",
"contains",
"https://example.com"
],
...
],
"name": "",
"message": "",
"subject": ""
},
...
],
"sms": [
{
"id": "vo2sY",
"conditions": [
[
"datetime",
"is-exactly",
"13/04/2021"
]
],
"name": "",
"message": ""
},
{
"id": "hwkmQ",
"name": "",
"message": ""
},
...
],
"messages": [],
"popups": [
{
"id": "ckN24",
"conditions": [
[
"user_type",
"is-user"
],
[
"languages",
"en"
]
],
"name": "",
"message": "",
"title": "",
"profile_image": "https://example.com/image.jpg"
},
...
],
"design": [
{
"id": "bX1qA",
"conditions": [
[
"user_type",
"is-user"
]
],
"name": "",
"message": "",
"title": "",
"color_1": "rgb(0, 235, 26)",
"color_2": "rgb(255, 0, 0)",
"color_3": "rgb(255, 0, 0)",
"background": "https://example.com/image.jpg",
"brand": "https://example.com/image.jpg",
"icon": "https://example.com/image.jpg"
},
...
]
},
{
"fr": {
"messages": [
{
"id": "y6hNE",
"name": "XXXX",
"message": "XXXX"
}
]
},
...
}
]

Запрос

Сохраняет все автоматизации.

Параметры

token

function

automations

translations

Ответ

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

Запрос

Проверяет автоматизацию.

Параметры

token

function

automation

Ответ

{
"conditions": [
[
"user_type",
"is-user"
],
...
],
"repeat_id": ""
}

Возвращает только клиентские условия и неверные условия на стороне сервера, которые могут быть проверены позднее. Если условия не возвращаются, автоматизация допустима и может быть выполнена. Возвращает false, если автоматизация недопустима.

Запрос

Проводит проверку и выполнение всех автоматизаций, возвращает автоматизации с клиентскими условиями, недопустимыми условиями на стороне сервера и автоматизациями типа popup и design.

Параметры

token

function

Ответ

[
{
"id": "0BOaG",
"conditions": [
[
"datetime",
"is-between",
"10/04/2021 - 13/04/2021"
],
[
"include_urls",
"contains",
"https://example.com"
],
...
],
"name": "",
"message": "",
"subject": "",
"type": "emails"
},
{
"id": "bX1qA",
"conditions": [
[
"user_type",
"is-user"
]
],
"name": "",
"message": "",
"title": "",
"color_1": "rgb(0, 235, 26)",
"color_2": "rgb(255, 0, 0)",
"color_3": "rgb(255, 0, 0)",
"background": "https://example.com/image.jpg",
"brand": "https://example.com/image.jpg",
"icon": "https://example.com/image.jpg",
"type": "design"
},
...
]

Запрос

Выполняет отдельную автоматизацию и проводит ее проверку перед выполнением.

Параметры

token

function

automation

validate

Ответ

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

Запрос

Проверяет, была ли автоматизация отправлена пользователю.

Параметры

token

function

user_id

automation

repeat_id

Ответ

Возвращает true, если автоматизация уже была отправлена, в противном случае возвращает false.

Запрос

Эта функция выполняет следующие задачи: Удаляет посетителей старше 24 часов, удаляет сообщения в корзине старше 30 дней, архивирует сообщения с ответом агента старше 24 часов.

Требования

Это административная функция, которая работает только в том случае, если активный пользователь является агентом или администратором.

Параметры

token

function

Ответ

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

reports

Возвращает указанные отчеты.

Параметры

token

function

name

date_start

date_end

timezone

Ответ

{
"title": "Количество диалогов",
"description": "Количество новых диалогов, начатых пользователями.",
"data": {
"03/2021": [
2
],
"04/2021": [
0
],
"05/2021": [
0
],
...
},
"table": [
"Дата",
"Количество"
],
"table-inverse": true,
"label_type": 1,
"chart_type": "line"
}

Запрос

Добавляет новую строку в таблицу базы данных sb_reports.

Параметры

token

function

name

value

external_id

extra

Ответ

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

Запрос

Проверяет, доступны ли обновления для stepChat.

Параметры

token

function

Ответ

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

Возвращает true, если хотя бы одно обновление доступно, в противном случае возвращает false.

Запрос

Добавляет подписчика в службу рассылки.

Параметры

token

function

email

first_name

last_name

Ответ

Возвращает ответ службы рассылки.

Запрос

Возвращает путь загрузок stepChat.

Параметры

token

function

url

date

Ответ

{
"success": true,
"response": "varwwwhtdocsstepchatuploads10-03-23"
}

{
"success": true,
"response": "https://www.example.com/stepchat/uploads/10-03-23"
}

Запрос

Проверяет, разрешена ли загрузка файлов с указанным расширением файла.

Параметры

token

function

extension

Ответ

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

Возвращает true, если расширение разрешено, в противном случае возвращает false.

Запрос

Проверяет, поддерживает ли хост-машинa требования системы stepChat.

Параметры

token

function

Ответ

{
"success": true,
"response": {
"php-version": true,
"zip-archive": true,
"plugin-folder": true,
"uploads-folder": true,
"apps-folder": true,
"languages-folder": true,
"ajax": true,
"curl": true,
"UTF8mb4": true
}
}

Возвращает true для каждого требования, которое поддерживается хост-машиной, в противном случае возвращает false.

Запрос

Добавляет сообщение журнала в файл журнала.

Параметры

token

function

string

user

Ответ

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

Возвращает true при успешном добавлении сообщения журнала.