ASSISBOT API (1.0.0)

Download OpenAPI specification:

Введение

Это официальный документ, описывающий взаимодействие с сервисом ASSISTBOT.

Общее описание обмена данными с ASSISTBOT

API для интеграции с ASSISTBOT содержит две группы методов:

  1. Методы требующие авторизацию пользователя по токену партнера
  2. Методы требующие авторизацию пользователя по токену аккаунта

Авторизация запросов API

Для обращений и к первой и ко второй группе методов требуется авторизация. Т.е. передача уникального hash-ключа.

Авторизация запросов к API производится в соответствии с RFC 6749 "Resource Owner Password Credentials Grant". При запросах к API в HTTP заголовок Authorization должен быть включен ключ доступа в следущем формате:

Authorization: Bearer <токен>

Отчёт по мастерам

Добавить задания для формирования отчета по мастерам

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer account_token

Request Body schema: application/json
required
date_start
required
string
date_end
required
string
delivery_callback_url
required
string
phone
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Работа с аккаунтами

Проверяем наличие аккаунта

path Parameters
username
required
string
token
required
string
header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Responses

Получаем информацию аккаунта

path Parameters
token
required
string

Токен пользователя

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "errors": "",
  • "account_id": 12345,
  • "title": "My Account",
  • "messenger_id": "WhatsApp"
}

Создание аккаунта Assistbot

Создаёт аккаунт Assistbot, управляющих и основной канал связи.

Ошибки валидации возвращаются с HTTP-кодом 200: status: false, в errors — текст первой ошибки. Аккаунт в этом случае не создаётся.

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required

Данные для создания аккаунта

login
required
string <= 255 characters

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

password
required
string <= 255 characters

Пароль для входа в личный кабинет

title
required
string <= 30 characters

Название аккаунта, не длиннее 30 символов. Пробелы по краям обрезаются.

top_manager_name
required
string <= 255 characters

Имя управляющего

top_manager_phone
required
string

Телефон управляющего для служебных уведомлений. Российский номер: 11 цифр, начиная с 7. Все символы, кроме цифр, отбрасываются, поэтому +7 (901) 123-45-67 тоже допустим.

phone
required
string

Основной телефон, привязанный к аккаунту. Российский номер: 11 цифр, начиная с 7. Все символы, кроме цифр, отбрасываются.

test_period
boolean
Default: false

Необязательный параметр. Если true, даётся тестовый период 3 дня.

messenger_id
required
string
Enum: "WhatsApp" "Telegram" "Max"

Основной канал связи аккаунта. При другом значении возвращается errors "Неизвестный мессенджер".

crm_id
integer
Enum: 0 1 2 3 4 5 6 7 8

CRM аккаунта. Необязательный параметр. Если не передан, ставится 6 (amoCRM), а для партнёра Битрикс24 — 7. На маршрутизацию сообщений в amoCRM / Битрикс24 не влияет: она определяется токеном партнёра.

  • 0 — CRM не используется
  • 1 — Yclients
  • 2 — ПрофСалон
  • 3 — Altegio
  • 4 — Мой склад
  • 5 — iVoice
  • 6 — amoCRM
  • 7 — Битрикс24
  • 8 — Запись онлайн

При неизвестном значении аккаунт не создаётся, возвращается status: false и errors: "Неизвестная CRM".

Responses

Request samples

Content type
application/json
{
  • "login": "MyLogin",
  • "password": "MyPassword",
  • "title": "My Account",
  • "top_manager_name": "Иванов Иван",
  • "top_manager_phone": "79011234567",
  • "phone": "79019876543",
  • "test_period": true,
  • "messenger_id": "WhatsApp",
  • "crm_id": 6
}

Response samples

Content type
application/json
Example
{
  • "status": true,
  • "errors": "",
  • "account_id": 12345,
  • "title": "My Account",
  • "messenger_id": "WhatsApp",
  • "webhook": "6721a3f0c4e2b"
}

Работа c чатами

Отправка сообщения в чат. Обязателен один из параметров `phone` или `chat_id`.

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Request Body schema: application/json
required
account_id
required
integer

ID аккаунта ASSISTBOT

chat_id
required
string

Идентификатор чата Провайдера

phone
required
string

Номер телефона для отправки сообщения

body
required
string

Тело сообщения, если тип сообщения media содержит ссылку на файл

type
required
string
Enum: "text" "media"

Тип сообщения

caption
string

Подпись под картинкой или файлом, только при type = media

Responses

Request samples

Content type
application/json
{
  • "account_id": 17,
  • "chat_id": "79019876543@c.us",
  • "phone": "79019876543",
  • "body": "Тело сообщения",
  • "type": "text",
  • "caption": "Подпись под картинкой"
}

Response samples

Content type
application/json
{
  • "chat_id": "77054521514@c.us",
  • "phone": "77054521514",
  • "body": "5555",
  • "user_id": 17,
  • "message_id": "BAE5E3103D05346E",
  • "type": "chat",
  • "time": 1734490159,
  • "from_me": true,
  • "group": false,
  • "status": null,
  • "author": "Сервисный бот",
  • "chat_name": "+77054521514",
  • "sender_name": "Сервисный бот",
  • "error_text": null,
  • "quoted_msg_id": null,
  • "caption": null,
  • "sender_name_user": null,
  • "quoted_message_type": null,
  • "quoted_message_body": "",
  • "user_name": null,
  • "category_message": 6
}

Получение статуса отправленного сообщения

Возвращает текущий статус сообщения по его идентификатору message_id, полученному при отправке через метод POST /api/web/index.php/send-message/.

path Parameters
message_id
required
string
Example: 3EB0XXXX

Уникальный идентификатор сообщения

query Parameters
account_id
required
integer
Example: account_id=123

ID аккаунта ASSISTBOT

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Черный список

Получение черного списка по account_id

Возвращает номера черного списка указанного аккаунта.

Авторизация — токен партнёра (Bearer partner_token). Доступ к account_id ограничивается разрешёнными группами каналов партнёра.

Список отдаётся только для переданного account_id. Добавление и удаление синхронизируются по всей группе каналов этого аккаунта.

query Parameters
account_id
required
integer
Example: account_id=17

ID аккаунта ASSISTBOT

search
string
Example: search=7901

Поиск по номеру телефона

page
integer
Default: 1
Example: page=1

Номер страницы

pageSize
integer
Default: 20
Example: pageSize=20

Размер страницы (максимум 100)

sort
string
Default: "id"
Enum: "id" "phone" "time" "created_at"

Поле сортировки

order
string
Default: "asc"
Enum: "asc" "desc"

Направление сортировки

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Добавление телефона в черный список

Добавляет телефон в черный список аккаунта.

Если аккаунт входит в группу каналов, номер добавляется во все аккаунты этой группы. Если группы нет — только в указанный account_id.

Авторизация — токен партнёра (Bearer partner_token).

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer

ID аккаунта ASSISTBOT

phone
required
string

Номер телефона. Допускается с + или без; будет нормализован в международный формат.

Responses

Request samples

Content type
application/json
{
  • "account_id": 17,
  • "phone": "+79011234567"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Удаление телефона из черного списка

Удаляет запись черного списка по id в рамках указанного account_id.

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

Авторизация — токен партнёра (Bearer partner_token).

path Parameters
id
required
integer
Example: 125

ID записи черного списка

query Parameters
account_id
required
integer
Example: account_id=17

ID аккаунта ASSISTBOT

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Групповая рассылка

Список шаблонов групповой рассылки

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

Авторизация — токен партнёра (Bearer partner_token). Доступ к account_id ограничивается разрешёнными группами каналов партнёра.

В режимах cascade / cascade_binding шаблоны синхронизируются между каналами группы.

query Parameters
account_id
required
integer
Example: account_id=17

ID аккаунта ASSISTBOT

search
string
page
integer
Default: 1
pageSize
integer
Default: 20
sort
string
Default: "id"
Enum: "id" "title" "status"
order
string
Default: "asc"
Enum: "asc" "desc"
header Parameters
Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Создание шаблона групповой рассылки

Создаёт шаблон. В cascade / cascade_binding автоматически создаются копии на других каналах группы.

header Parameters
Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer
title
required
string
text
required
string
days
Array of integers
time_start
required
string
time_end
required
string
send_frequency
integer
count_message
integer
check_blacklist
integer
mode
integer

0 — произвольный текст, 1 — утверждённый WA-шаблон

template_message_field
string

Имя утверждённого WA-шаблона (для mode=1)

status
integer

По умолчанию 0 (выключен)

link
string

Responses

Request samples

Content type
application/json
{
  • "account_id": 17,
  • "title": "Акция марта",
  • "text": "Здравствуйте, {name}! ...",
  • "days": [
    ],
  • "time_start": "09:00",
  • "time_end": "21:00",
  • "send_frequency": 1,
  • "count_message": 100,
  • "check_blacklist": 1,
  • "mode": 0,
  • "template_message_field": "string",
  • "status": 0,
  • "link": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}

Получение шаблона

path Parameters
id
required
integer
query Parameters
account_id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Responses

Редактирование шаблона

Изменения синхронизируются на связанные каналы группы в cascade / cascade_binding.

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer
title
string
text
string
days
Array of integers
time_start
string
time_end
string
send_frequency
integer
count_message
integer
check_blacklist
integer
mode
integer
template_message_field
string
status
integer
link
string

Responses

Request samples

Content type
application/json
{
  • "account_id": 0,
  • "title": "string",
  • "text": "string",
  • "days": [
    ],
  • "time_start": "string",
  • "time_end": "string",
  • "send_frequency": 0,
  • "count_message": 0,
  • "check_blacklist": 0,
  • "mode": 0,
  • "template_message_field": "string",
  • "status": 0,
  • "link": "string"
}

Удаление шаблона

Удаляет шаблон и связанные копии в других каналах группы.

path Parameters
id
required
integer
query Parameters
account_id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Responses

Включение / выключение шаблона

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "account_id": 17,
  • "enabled": true
}

Загрузка получателей в очередь

Добавляет получателей в очередь шаблона.

Формат recipients: массив объектов {phone, name?, text?}. Поле text опционально: если задано, используется вместо текста шаблона при отправке (плейсхолдер {name} поддерживается).

В cascade / cascade_binding записи дублируются на связанные шаблоны группы. Лимит за один запрос — 10000 получателей.

path Parameters
id
required
integer

ID шаблона

header Parameters
Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "account_id": 17,
  • "recipients": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Отмена очереди рассылки

Отменяет неотправленные сообщения шаблона (статусы 0, 14, 17). Для связанных шаблонов группы cascade / cascade_binding отмена выполняется по всей связке.

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
account_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "account_id": 17
}

Статистика по статусам сообщений шаблона

path Parameters
id
required
integer
query Parameters
account_id
required
integer
header Parameters
Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Работа с заявками на подключение интеграции

Добавление заявки на подключение интеграции

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Request Body schema: application/json
required
login
required
string

Логин для создания аккаунта

name
required
string

Имя для обращения

phone_connect
required
string

Телефон для подключения WhatsApp

phone
required
string

Телефон управляющего

email
string

email

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "name": "string",
  • "phone_connect": "string",
  • "phone": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Работа с настройками аккаунта

Установка настроек аккаунта.

path Parameters
TOKEN
required
string

TOKEN аккаунта

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
url_redirect_message
string

URL перенаправления

trigger_redirect_message
integer

[object Object]

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url_redirect_message": "https://webhook.site/",
  • "trigger_redirect_message": "0 = Выключен\n1 = Все сообщения с полным телом хука\n5 = Все сообщения\n10 - Сообщения подпадающие под фильтр\n"
}

Получение настроек аккаунта.

path Parameters
TOKEN
required
string

TOKEN аккаунта

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer partner_token'

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "url_redirect_message": "https://webhook.site/",
  • "trigger_redirect_message": "0 = Выключен\n1 = Все сообщения с полным телом хука\n5 = Все сообщения\n10 - Сообщения подпадающие под фильтр\n"
}

Отправка смс через наш бот

Отправка сообщений через наш бот.

Сообщение может содержать файлы и специальные символы:

  • #sms# — отправка через СМС-шлюз без попытки отправки в мессенджер.
  • %%Текст смс%% — экранирование сообщения для отправки через СМС-шлюз.
  • ##Название шаблона рассылки## — экранирование названия шаблона рассылки.
  • [[Кнопка1;Кнопка2]] - добавляет кнопки (опрос) к сообщению.
header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer account_token

Request Body schema: application/json
required
required
Array of objects
text
string
link
string
filename
string
salon
string
type
string
delivery_callback_url
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "0 = Не отправлено"
}

Получение статуса отправленного сообщения

Получение статуса отправленного сообщения

path Parameters
sms_id
required
string
header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Bearer account_token

Responses

Отправка шаблонных сообщений WABA

Отправка шаблонных сообщений WABA

Отправляет предварительно одобренный шаблон WhatsApp Business API (WABA) на указанный номер телефона.

Авторизация выполняется по токену аккаунта (Bearer account_token), который хранится в поле webhook настроек аккаунта.

Логика работы:

  1. По переданному name ищется шаблон среди шаблонов, доступных аккаунту.
  2. Если sms_only = false (по умолчанию) — отправляется WABA-шаблон. При наличии sms_text текст дополнительно ставится в очередь каскадной SMS-отправки.
  3. Если sms_only = true — WABA-шаблон не отправляется, в очередь SMS-шлюза добавляется только sms_text.

Параметры params подставляются в тело шаблона в том порядке, в котором переменные указаны в шаблоне WABA.

header Parameters
Content-Type
required
string

application/json

Authorization
required
string

Вписываем 'Bearer account_token', где account_token — токен аккаунта (webhook)

Request Body schema: application/json
required
name
required
string

Название шаблона в WABA (должно совпадать с именем одобренного шаблона аккаунта)

phone
required
string

Номер телефона получателя в международном формате

params
Array of strings

Переменные шаблона в последовательности, как указано в теле шаблона WABA

sms_text
string

Текст для каскадной отправки SMS через подключённый SMS-агрегатор. Обязателен при sms_only = true. При обычной отправке WABA используется как резервный канал.

sms_only
boolean
Default: false

Если true — отправляется только SMS через SMS-шлюз, WABA-шаблон не отправляется. Если false или не передан — отправляется WABA-шаблон.

Responses

Request samples

Content type
application/json
{
  • "name": "rewiev_request",
  • "phone": "+77054521514",
  • "params": [
    ],
  • "sms_text": "Текст смс",
  • "sms_only": false
}

Response samples

Content type
application/json
Example
{
  • "phone": "77054521514",
  • "body": "1111",
  • "user_id": 17,
  • "message_id": "wamid.HBgLNzcwNTQ1MjE1MTQVAgARGBI5QjY3RjY4RjY4RjY4RjY4",
  • "type": "chat",
  • "time": 1734490159,
  • "from_me": true,
  • "group": false,
  • "status": null,
  • "author": "Сервисный бот",
  • "chat_name": "+77054521514",
  • "sender_name": "Сервисный бот",
  • "error_text": null
}

Отправка шаблонного сообщения

Отправка шаблонного сообщения

Отправка шаблонного сообщения, созданного в личном кабинете https://lk.assistbot.ru/message-templates/personal-area. Доступны следующие типы шаблонов:

Новая запись,

Новая запись для услуг,

Предложение дополнительной услуги,

Предложение новой услуги,

Напоминание за час,

Напоминание за сутки,

Напоминание за сутки с подтверждением,

Запрос оценки (отзыв на внешнем ресурсе),

Запрос оценки (отзыв в Yclients),

Перенос записи,

Удаление записи,

Продвинутый

header Parameters
Content-Type
required
string

application/json

Authorization
required
any

Bearer partner_token

Request Body schema: application/json
required
account_token
required
string

Токен аккаунта

client_name
required
string

Имя клиента

client_phone
required
string

Содержит номер телефона в международном формате на который отправляются сообщения

template_id
required
integer

Идентификатор шаблона, можно увидеть в адресной строке, при открытии/создании шаблона

client_id
required
integer

ID клиента в системе партнера

record_id
required
integer

ID записи в системе партнера, должно быть уникальным для запроса

staff_id
required
integer

ID сотрудника в системе партнера

staff_name
string

Имя сотрудника в системе партнера

visit_time
required
integer

Время посещения в секундах

services
Array of arrays

Список услуг

visits_count
integer

Количество посещений

Responses

Request samples

Content type
application/json
{
  • "account_token": "5f47badseecxz2a3z",
  • "client_name": "Иван Иванов",
  • "client_phone": "+79999999999",
  • "template_id": 1,
  • "client_id": 1,
  • "record_id": 1,
  • "staff_id": 1,
  • "staff_name": "Мария",
  • "visit_time": 1717571189,
  • "services": [
    ],
  • "visits_count": 1
}

Response samples

Content type
application/json
true

Исходящие хуки

Исходящие хуки для стороннего сервиса

Этот хук отправляется на сторонний сервис после выполнения определённых действий. Он содержит информацию о сообщении и метаданные.

Request Body schema: application/json
required
id
string

Уникальный идентификатор сообщения.

body
string

Текст сообщения (type = chat) или ссылка на файл (type = image или type = document).

time
integer <int64>

Временная метка отправки сообщения (Unix timestamp).

type
string
Enum: "chat" "image" "document"

Тип сообщения.

author
string

Имя автора сообщения.

chatId
string

Идентификатор чата.

fromMe
boolean

Флаг, указывающий, отправлено ли сообщение самим пользователем.

caption
string

Подпись к отправленному файлу или медиа-сообщению (type = image или type = document).

chatName
string

Имя чата.

senderName
string

Имя отправителя.

quotedMsgId
string

Идентификатор цитируемого сообщения.

object

Данные цитируемого сообщения.

account_id
integer

Идентификатор аккаунта.

category
integer
Enum: 0 1 2 3 4 5 6 7 8 9

Категория сообщения. Возможные значения:

  • 0: Сообщение отправленное из окна бота, мобильного приложения мессенджера или веб версии приложения
  • 1: Шаблонные сообщения по записям
  • 2: Шаблонные сообщения по клиентской базе
  • 3: Сообщения групповой рассылки
  • 4: Сообщения переданные через sms endpoint
  • 5: Сообщения фильтров (авто ответ бота)
  • 6: Сообщение из чата сторонней CRM
  • 7: Сообщение-триггер для фильтров (авто ответ бота)
  • 8: Сообщение мастерам
  • 9: Сообщение и ответ дерева фильтров

Responses

Request samples

Content type
application/json
{
  • "id": "BAE590092CBA2E00",
  • "body": "Этот бот работает только на уведомления.\r\nПо вопросам, если они возникли, обратитесь на WhatsApp +79261790339",
  • "time": 1734583678,
  • "type": "chat",
  • "author": "Сервисный бот",
  • "chatId": "79011111514@c.us",
  • "fromMe": true,
  • "caption": "",
  • "chatName": "Иванов Иван",
  • "senderName": "Иванов Иван",
  • "quotedMsgId": "",
  • "quotedMessage": {
    },
  • "account_id": 17,
  • "category": 0
}