Bot.Az REST API sizə öz serveriniz vasitəsilə Bot.Az-dakı məlumatlarla manipulyasiya etmək imkanı verir.

DİQQƏT! Hal hazırda REST API düzəltmə mərhələsindədir və bu səbəbdən yeni API-ların yaranması ilə yanaşı mövcud olan API-ların dəyişdirilməsi də baş tuta bilər. Son dəyişiklik tarixi: 5 yanvar 2019

Məlumat formatı

JSON yeganə dəstəklənən məlumat formatıdır.

POSTPUT sorğular Content-Type: application/json başlığı ilə olmalıdırlar:

Content-Type: application/json

Səhvlər

Səhv yaranan zaman Bot.Az müvafiq cavab göndərəcək, cavabın məzmunu (əksər hallarda) səhv haqqında ətraflı məlumatla olacaq:

{
	"status": "error",
	"message": "You must be logged in to do this."
}

messages

Operatorun ismarıcını göndərin, redaktə edin və ya silin. İstənilən ismarıcı onun ID-si ilə əldə edin.

POST Operatorun adından ismarıc göndər

https://app.bot.az/api/messages/

Sorğu nümunəsi
{
	"userId": "MvSzqx36KksKNxHmK",
	"visitorId": "BtR7qAyvZfTWoaC7a",
	"text": "Good morning! Can I help you?"
}

userId — operatorun ID-si. Hər operator üçün ayrıca təyin olunur və operatorlar səhifəsində göstərilib

visitorId — ziyarətçinin ID-si. Hər ziyarətçi üçün ayrıca təyin olunur və ziyarətçi ilə söhbət zamanı ünvan sətrində yerləşir (https://app.bot.az/chat/:id)

text — ismarıcın mətni

Cavab nümunəsi

Yeni yaradılmış ismarıc cavab olaraq qayıdır:

{
	"_id": "qZkS5QLZSBLKzYAwm",
	"userId": "MvSzqx36KksKNxHmK",
	"visitorId": "BtR7qAyvZfTWoaC7a",
	"text": "Good morning! Can I help you?",
	"seen": false,
	"sentAt": "2019-01-03T07:14:07.438Z"
}

GET Mövcud ismarıcı əldə edin

https://app.bot.az/api/messages/:id

:id — ismarıcın ID-si

Cavab nümunəsi

Sorğulanan ismarıc cavab olaraq qayıdır:

{
	"_id": "qZkS5QLZSBLKzYAwm",
	"userId": "MvSzqx36KksKNxHmK",
	"visitorId": "BtR7qAyvZfTWoaC7a",
	"text": "Good afternoon! Can I help you?",
	"seen": false,
	"sentAt": "2019-01-03T07:14:07.438Z"
}

PUT Operatorun ismarıcını redaktə edin

https://app.bot.az/api/messages/:id

:id — ismarıcın ID-si

Yalnız operatorun ismarıcları redaktə oluna bilər.

Sorğu nümunəsi
{
	"text": "Good evening! Can I help you?"
}
Cavab nümunəsi

Yenilənmiş ismarıc cavab olaraq qayıdır:

{
	"_id": "qZkS5QLZSBLKzYAwm",
	"userId": "MvSzqx36KksKNxHmK",
	"visitorId": "BtR7qAyvZfTWoaC7a",
	"text": "Good evening. Can I help you?",
	"seen": false,
	"sentAt": "2019-01-03T07:14:07.438Z"
}

DELETE Operatorun ismarıcını silin

https://app.bot.az/api/messages/:id

:id — ismarıcın ID-si

Yalnız operatorun ismarıcları silinə bilər.

Cavab nümunəsi

Silinmiş ismarıc cavab olaraq qayıdır:

{
	"_id": "qZkS5QLZSBLKzYAwm",
	"userId": "MvSzqx36KksKNxHmK",
	"visitorId": "BtR7qAyvZfTWoaC7a",
	"text": "Good evening. Can I help you?",
	"seen": false,
	"sentAt": "2019-01-03T07:14:07.438Z"
}

visitors

Ziyarətçilər haqqında məlumatı əldə edin. Ziyarətçinin adı, elektron poçt ünvanı, telefon nömrəsi və onun haqqında qeydlər kimi əsas məlumatları Bot.Az-ın idarəetmə panelindəki kimi redaktə edin.

GET Ziyarətçi haqqında məlumatları əldə edin

https://app.bot.az/api/visitors/:id

:id — ziyarətçinin ID-si. Hər ziyarətçi üçün ayrıca təyin olunur və ziyarətçi ilə söhbət zamanı ünvan sətrində yerləşir (https://app.bot.az/chat/:id)

Cavab nümunəsi

Sorğulanan ziyarətçi haqqında məlumat cavab olaraq qayıdır:

{
	"_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 Ziyarətçi haqqında əsas məlumatları redaktə edin

https://app.bot.az/api/visitors/:id

:id — ziyarətçinin ID-si. Hər ziyarətçi üçün ayrıca təyin olunur və ziyarətçi ilə söhbət zamanı ünvan sətrində yerləşir (https://app.bot.az/chat/:id)

Sorğu nümunələri

Ziyarətçinin adını, elektron poçt ünvanını, telefon nömrəsini və qeydləri təyin etmək üçün:

{
	"email": "[email protected]",
	"name": "Anar Hasanzade",
	"phone": "+994124801574",
	"notes": "Asked about new functionality"
}

Ziyarətçinin telefon nömrəsini silmək və elektron poçt ünvanını dəyişmək üçün:

{
	"email": null,
	"phone": "+994124801574",
}

null məlumatı silmək üçün istifadə olunur.

Cavab nümunəsi

Ziyarətçi haqqında yenilənmiş məlumat cavab olaraq qayıdır:

{
	"_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
}