Download OpenAPI specification:Download
API для интеграции с ASSISTBOT содержит две группы методов:
Для обращений и к первой и ко второй группе методов требуется авторизация. Т.е. передача уникального hash-ключа.
Авторизация запросов к API производится в соответствии с RFC 6749 "Resource Owner Password Credentials Grant". При запросах к API в HTTP заголовок Authorization должен быть включен ключ доступа в следущем формате:
Authorization: Bearer <токен>
Content-Type required | string application/json |
Authorization required | string Bearer account_token |
date_start required | string |
date_end required | string |
delivery_callback_url required | string |
phone | string |
{- "date_start": "2024-10-01",
- "date_end": "2024-10-31",
- "phone": "+77054521514"
}
{- "success": true,
- "data": {
- "report_id": 436,
- "branches": [ ],
- "date_start": "2024-10-01",
- "date_end": "2024-10-31",
- "phone": "+77054521514",
}, - "meta": { }
}
Content-Type required | string application/json |
Authorization required | string Вписываем 'Bearer partner_token' |
login required | string Логин для создания аккаунта |
name required | string Имя для обращения |
phone_connect required | string Телефон для подключения WhatsApp |
phone required | string Телефон управляющего |
string |
{- "login": "string",
- "name": "string",
- "phone_connect": "string",
- "phone": "string",
- "email": "string"
}
{- "success": true,
- "data": {
- "order_id": 12345
}, - "meta": {
- "message": "Order accepted"
}
}
TOKEN required | string TOKEN аккаунта |
Content-Type required | string application/json |
Authorization required | string Bearer partner_token |
url_redirect_message | string URL перенаправления |
trigger_redirect_message | integer [object Object] |
{- "trigger_redirect_message": 0
}
{- "id": 1,
- "trigger_redirect_message": "0 = Выключен\n1 = Все сообщения с полным телом хука\n5 = Все сообщения\n10 - Сообщения подпадающие под фильтр\n"
}
TOKEN required | string TOKEN аккаунта |
Content-Type required | string application/json |
Authorization required | string Вписываем 'Bearer partner_token' |
{- "id": 1,
- "trigger_redirect_message": "0 = Выключен\n1 = Все сообщения с полным телом хука\n5 = Все сообщения\n10 - Сообщения подпадающие под фильтр\n"
}
Content-Type required | string application/json |
Authorization required | string Bearer account_token |
required | Array of objects |
text | string |
link | string |
filename | string |
salon required | string |
type | string |
delivery_callback_url required | string |
{- "destination_params": [
- {
- "id": "11111",
- "phone": "+77054521514"
}
], - "text": "Test API",
- "filename": "Test_API.png",
- "salon": "214607",
- "type": "sms",
- "delivery_callback_url": "Test API"
}
{- "status": 0
}