REST API Bot.Az позволяет манипулировать данными в системе Bot.Az с Вашего сервера.
Единственным поддерживаемым форматом данных является JSON.
POST
и PUT
запросы должны включать в себя заглавие Content-Type: application/json
:
Content-Type: application/json
В случае ошибки Bot.Az отправит ответ с ошибкой, тело ответа будет содержать в себе (в большинстве случаев) подробную информацию об ошибке:
{
"status": "error",
"message": "You must be logged in to do this."
}
messages
Отправляйте, редактируйте или удаляйте сообщения операторов. Получайте все сообщения по их ID.
POST
Отправляйте сообщения от имени оператораhttps://app.bot.az/api/messages/
{
"userId": "MvSzqx36KksKNxHmK",
"visitorId": "BtR7qAyvZfTWoaC7a",
"text": "Good morning! Can I help you?"
}
userId
— ID оператора, генерируемый для каждого оператора и доступный на странице операторов
visitorId
— ID посетителя, генерируемый для каждого посетителя и доступной в адресной строке браузера, когда открыт чат с посетителем (https://app.bot.az/chat/:id
)
text
— текст сообщения
В качестве ответа возвращается только что созданное сообщение:
{
"_id": "qZkS5QLZSBLKzYAwm",
"userId": "MvSzqx36KksKNxHmK",
"visitorId": "BtR7qAyvZfTWoaC7a",
"text": "Good morning! Can I help you?",
"seen": false,
"sentAt": "2019-01-03T07:14:07.438Z"
}
GET
Получайте существующее сообщениеhttps://app.bot.az/api/messages/:id
:id
— ID сообщения
В качестве ответа возвращается запрошенное сообщение:
{
"_id": "qZkS5QLZSBLKzYAwm",
"userId": "MvSzqx36KksKNxHmK",
"visitorId": "BtR7qAyvZfTWoaC7a",
"text": "Good afternoon! Can I help you?",
"seen": false,
"sentAt": "2019-01-03T07:14:07.438Z"
}
PUT
Редактируйте сообщение оператораhttps://app.bot.az/api/messages/:id
:id
— ID сообщения
Только сообщения операторов могут быть отредактированы.
{
"text": "Good evening! Can I help you?"
}
В качестве ответа возвращается обновлённое сообщение:
{
"_id": "qZkS5QLZSBLKzYAwm",
"userId": "MvSzqx36KksKNxHmK",
"visitorId": "BtR7qAyvZfTWoaC7a",
"text": "Good evening. Can I help you?",
"seen": false,
"sentAt": "2019-01-03T07:14:07.438Z"
}
DELETE
Удаляйте сообщение оператораhttps://app.bot.az/api/messages/:id
:id
— ID сообщения
Только сообщения операторов могут быть удалены.
В качестве ответа возвращается удалённое сообщение:
{
"_id": "qZkS5QLZSBLKzYAwm",
"userId": "MvSzqx36KksKNxHmK",
"visitorId": "BtR7qAyvZfTWoaC7a",
"text": "Good evening. Can I help you?",
"seen": false,
"sentAt": "2019-01-03T07:14:07.438Z"
}
visitors
Получайте информацию о посетителях. Редактируйте базовые сведения о посетителе (такие, как имя, адрес электронной почты, номер телефона, заметки) так же, как это делается в панели управления Bot.Az.
GET
Получайте информацию о посетителеhttps://app.bot.az/api/visitors/:id
:id
— ID посетителя, генерируемый для каждого посетителя и доступной в адресной строке браузера, когда открыт чат с посетителем (https://app.bot.az/chat/:id
)
В качестве ответа возвращается информация о запрашиваемом посетителе:
{
"_id": "BtR7qAyvZfTWoaC7a",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"appName": "Netscape",
"appVersion": "5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"platform": "Linux x86_64",
"cookieEnabled": true,
"banned": false,
"addedAt": "2018-11-22T12:18:48.812Z",
"agents": [
"MvSzqx36KksKNxHmK"
],
"name": "Anar Hasanzade",
"email": "[email protected]",
"phone": "+994124801574",
"notes": "Asked about tariff plans",
"preformFilled": true,
"lastOnline": "2019-01-03T09:00:48.059Z",
"showBotMessages": false
}
PUT
Редактируйте базовые сведения о посетителеhttps://app.bot.az/api/visitors/:id
:id
— ID посетителя, генерируемый для каждого посетителя и доступной в адресной строке браузера, когда открыт чат с посетителем (https://app.bot.az/chat/:id
)
Задать имя посетителя, адрес электронной почты, номер телефона и заметки:
{
"email": "[email protected]",
"name": "Anar Hasanzade",
"phone": "+994124801574",
"notes": "Asked about new functionality"
}
Удалить номер телефона посетителя и изменить адрес электронной почты:
{
"email": null,
"phone": "+994124801574",
}
null
используется для удаления значения.
В качестве ответа возвращается обновлённая информация о посетителе:
{
"_id": "BtR7qAyvZfTWoaC7a",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"appName": "Netscape",
"appVersion": "5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"platform": "Linux x86_64",
"cookieEnabled": true,
"banned": false,
"addedAt": "2018-11-22T12:18:48.812Z",
"agents": [
"MvSzqx36KksKNxHmK"
],
"name": "Anar Hasanzade",
"email": null,
"phone": "+994124801574",
"notes": "Asked about new functionality",
"preformFilled": true,
"lastOnline": "2019-01-03T09:00:48.059Z",
"showBotMessages": false
}