ASSISBOT API (1.0.0)

Download OpenAPI specification:Download

Введение

Это официальный документ, описывающий взаимодействие с сервисом 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

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

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

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# - отправка через смс шлюз без попытки отправки в мессенджер, %%Текст смс%% - экранирование сообщения адаптированного для отправки через смс шлюз, ##Название шаблона рассылки## - экранирование названия шаблона рассылки

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
required
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